Not logged inOpenClonk Forum
Up Topic General / Help and Questions / Documentation
- - By Maddino [de] Date 2012-04-19 13:18
Is there anywhere a tutorial how i documented something? JCaesar had told how i do it, but i have forgotten it.
Reply
Parent - - By Luchs [de] Date 2012-04-19 15:18
Download the repository via Mercurial, install everything as documented in docs/README.cygwin.txt, edit the files you want to change (in docs/sdk) and then create a patch using Mercurial again if you want your documentation to be included. Also, there's the German translation, but there doesn't seem to be any information how that works.
Parent - By Newton [de] Date 2012-04-19 19:24
The german translation is in openclonk\docs\de.po
Parent - By Günther [de] Date 2012-04-19 19:31
The documentation you linked to is actually mostly relevant for someone wanting to do translations :-)

For just writing, edit one of the .xml files in docs/, and open them with a web browser to check. There isn't any documentation on the xml vocabulary, but it's  a straightforward mix of tags copied from HTML and mostly self-explanatory custom tags. Firefox unfortunately won't render the bare xml files correctly when read directly from the file system, so one needs to use a local web server. But on windows, Internet Explorer uses local file system permission checks that allow the xml files to correctly render directly in the browser.
Reply
Up Topic General / Help and Questions / Documentation

Powered by mwForum 2.29.7 © 1999-2015 Markus Wichitill