marko10_000
/
openclonk
forked from Mirrors/openclonk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
openclonk/docs
History
Lukas Werling 03d05ff98f Add EvaluateOnAbort scenario flag for Tower of Despair 
In Tower of Despair, the scenario saves per-room progress in the
player files. Players win individual rooms, but never the whole
scenario. Consequently, they currently have to give up to make sure
they don't lose their progress. This is not intuitive at all. With the
new flag enabled, players will be saved even if the scenario is aborted.
 		2018-03-05 17:37:07 +01:00
..
images Add missing image in script gui docs. 2015-09-06 17:06:14 -04:00
sdk Add EvaluateOnAbort scenario flag for Tower of Despair 2018-03-05 17:37:07 +01:00
Makefile Specifically run python2 instead of python from the docs Makefile. 2016-02-14 22:32:29 +01:00
README.cygwin.txt docs: Update Makefile documentation and cygwin instructions 2013-02-21 22:41:01 +01:00
Template.de.hhp docs: Improvements to chm generation and in-browser xslt preview 2011-09-09 21:36:03 +02:00
Template.hhp docs: Improvements to chm generation and in-browser xslt preview 2011-09-09 21:36:03 +02:00
bitmasks.js revert bitmasks.js removal 2011-06-29 15:03:53 +02:00
build_contents.py Specifically run python2 instead of python from the docs Makefile. 2016-02-14 22:32:29 +01:00
build_hhp.py docs: split build_chm_files into build_contents, build_hhp and hhk.xsl 2011-09-19 14:50:27 +02:00
clonk.dtd docs: Fix some typos found by make check 2013-02-24 14:50:12 +01:00
clonk.py docs: Generate the table-of-contents <img> in the xslt 2011-06-30 19:25:02 +02:00
clonk.xsl docs: Highlight the keyword "new" 2017-11-12 22:02:34 +01:00
de.po remove unused AttractLightning defcore entry 2017-07-15 14:00:19 +02:00
doku.css docs: Fix contents position in really wide browser windows 2016-01-03 00:21:39 +01:00
experimental.py docs: split build_chm_files into build_contents, build_hhp and hhk.xsl 2011-09-19 14:50:27 +02:00
extra-strings.xml docs: Generate the table-of-contents <img> in the xslt 2011-06-30 19:25:02 +02:00
header.xml in the documentation, always have "docs" preselected in the search shown in the header 2016-06-19 17:00:18 +02:00
hhc.xsl docs: split build_chm_files into build_contents, build_hhp and hhk.xsl 2011-09-19 14:50:27 +02:00
hhk.xsl docs: split build_chm_files into build_contents, build_hhp and hhk.xsl 2011-09-19 14:50:27 +02:00
search.php website header changes 2013-10-31 00:58:55 +07:00
xml2po.py docs: xml2po doesn't ignore malformed xml files 2011-09-05 23:31:10 +02:00

README.cygwin.txt 

How to build the documentation
==============================
This section explains how to build the German and English HTML-documentation from the English XML-source files and the translation file.

In Linux, it should be as easy as: Open the console and run make in this directory.

In Windows, you need Python and Cygwin. During the Cygwin installation, select these additional libraries to install:
+ make
+ xsltproc (libxml2 + libxslt + python-libxml2)
+ findutils
+ sed
+ gettext
+ gettext-devel
+ libgcrypt + libgpg-error (for whatever reason)

After the installation, run cygwin, cd to this directory (/cygdrive/c/.../openclonk/docs/) and run make. The process takes a few minutes to complete.
The online version of the documentation has been generated into the online/ directory.

To build the .chm files, install the html help compiler from http://www.microsoft.com/en-us/download/details.aspx?id=21138 or http://go.microsoft.com/fwlink/?LinkId=14188 and run make chm HHC=/path/to/hhc.exe