marko10_000
/
openclonk
forked from Mirrors/openclonk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
openclonk/docs
History
Tobias Zwick 52feb9a67f update docs for control dialog changes 2012-10-13 14:36:28 +02:00
..
images new clonk-head graphics 2011-08-05 14:54:54 +02:00
sdk update docs for control dialog changes 2012-10-13 14:36:28 +02:00
Makefile docs/Makefile: clean removes generated sdk/content.xml 2012-05-05 22:48:27 +02:00
README.cygwin.txt new header for the documentation (+de.po was re-generated by make) 2010-09-09 17:54:20 +02: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 docs: split build_chm_files into build_contents, build_hhp and hhk.xsl 2011-09-19 14:50:27 +02: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: index page with "get started" links and search 2011-08-02 16:25:00 +02:00
clonk.py docs: Generate the table-of-contents <img> in the xslt 2011-06-30 19:25:02 +02:00
clonk.xsl fix docs header 2012-02-01 20:10:17 +01:00
de.po update docs for control dialog changes 2012-10-13 14:36:28 +02:00
doku.css doku.css with Endeavour font for titles 2012-05-13 10:32:12 +02: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 fix openclonk header css for docs (nobody noticed :-( ) 2012-08-20 21:47:21 +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 implemented documentation changes requested in forum 2012-01-10 16:14:15 +01: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 ned 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)
Also you might have to rename find.exe, so that the cygwin provided one is used - first in Windows\System32\dllback then in Windows\System32 to make sure it isn't used.

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