- Revision of the parts of the reference that explain the language, the game data etc. (everything that is not the function reference)
- Revise examples and descriptions of functions: Many examples are not correct anymore as well as the descriptions of functions. The most common reason is the change from
obj->GetX()as well as the replacement of
FindObjectwith a new function (formerly known as
FindObject2) and the introduction of nil.
- Translation of German into English: In openclonk/docs/, there is a file called en.po where for every German string, there should be an English translation. Search for
msgstr ""to find the untranslated strings.
None of the three different tasks is anything that can be done in a few minutes, all three are major tasks. That's why I suggest that if you want to help to update the docs by say having a look at the descriptions and examples of the function reference, you just note down here what parts of that task you want to do. E.g. for the function reference: all functions starting with the letter A-D.
To edit the documentation, you need to get the source. The docs are in openclonk/docs/. See the mercurial guide on how to checkout the source.
> Translation of German into English: In openclonk/docs/, there is a file called en.po where for every German string, there should be an English translation. Search for msgstr "" to find the untranslated strings.
Also look for "fuzzy" messages (search for "fuzzy" in en.po). These normally occur when there are two similar German strings in which case gettext takes the translation for the first also for the second. This might or might not be correct which is why it marks them as fuzzy. So if you encounter these check the English translation carefully and remove the line marking them as fuzzy if it is correct. If it is not fix it and remove the fuzzy line as well.
Powered by mwForum 2.29.7 © 1999-2015 Markus Wichitill