Topic Documentation overhaul
This board is threaded (i.e. has a tree structure). Please use the Reply button of the specific post you are referring to, not just any random button. If you want to reply to the topic in general, use the Post button near the top and bottom of the page.
In Response to Newton
Size: Small
Difficulty: Medium (involves coding in xml, probably python)
The navigation bar is not displayed correctly (always in German) and is by the way only a replica of what is in the contents index anyway. What would make much more sense from the usage point of view is to have a breadcrumb which reflects the same structure as seen in the contents index. The search link in the navigation bar is obsolete since we have the search field in the header. However, an additional search link could be integrated into the contents index.
Size: Tiny
Difficulty: Easy
The language switcher always shows the british flag, regardless of which language is currently selected. With additional translations of the documentation in the future in mind, the language switcher should appear in the upper right corner as a series of flags, the currently selected one highlighted.
Size: Big
Difficulty: Easy
The documentation of the game content (object definitions, scenarios,...) is currently and was always not very comprehensible. An overhaul of these pages should:
+ include examples of the basic definition of an object/scenario. For example show a directory listing of an example scenario with a Music.ocg, System.ocg, local object definitions etc.
+ separate between the normal/basic/required files in an object/scenario and advanced stuff that may be included (Info.txt, Material.ocg, Sound.ocg...); give a guideline how a scenario/object pack etc. should be structured (in examples). F.e. stuff sound effects in their object definition or into Sound.ocg if they are scenario global sounds etc.
+ especially for object definitions with their graphics.pngs, meshes and skeletons, a grouping of the contents and their relations to each other is necessary, with examples
Size: Medium
Difficulty: Easy
Reset the version numbers of all functions to OC 1.0. Reason: Clonk Rage has it's own documentation, we don't need to document for CR and earlier. Also, the signature of all functions have been changed anyway (namingly, the for_object parameter has been removed).
Powered by mwForum 2.29.7 © 1999-2015 Markus Wichitill