I didn't like how the old manual (not hakore's one) was (1 config per page).
We could make all the configs on one page but separate them according to what they do using headers. Then users can easily surf at the page using the table of contest. Like:
===Attack Configs or just Attack===
attackAuto ....
..................
attackAuto_x
..............
===Teleport===
teleportAuto..
.....
..
..
.
Or... make like above but instanted of using headers to separate create different pages.
The idea is to add pages for all config variables making them members of the following categories:
- Config.txt
- other relevant categories (ex. Connection)
The other relevant categories will be members of the Config.txt category, thus making them sub categories of the Config.txt category.
The benefits are:
- config vars are automatically summarized alphabetically on both the Config.txt category page (all) AND on the respective Config.txt sub-category pages (relevant only).
- config.txt sub categories are automatically summarized on the Config.txt category page as sub categories
So now the blueprint is drawn but the biggest task is still ahead of us, gooooo documentation writing team!
One ST0 to rule them all? One PE viewer to find them!
One ST_kRO to bring them all and in the darkness bind them...
Great. So we keep it.
Other Question is, How we make connection Wiki->Wx/Doc's ?
I suggest Exporting documentation on Configuring OpenKore to some XML file, and load it inside OpenKore WX interface.
Mushroom wrote:Should the pages that have a lot of config keys (console commands, chat commands, timeouts) be like the config.txt page (one page for each config)?
From my point of view:
in main (Example: Console Commands) list commands that are mostly used by people.
then, all in their own pages.
If we are going to make one page for each command, then how are we going to separate commands like: deal, deal add, deal add z, deal no? Each one in it's own page or everything on the same page?
Ok, it's been decided that some/all? config blocks are going to be documented on the wiki, as an example for users.
However...
How are they going to be?
Where should it be?
About console commands pages, making a one page for each cmd using the cmd name as page name didn't work very well.
So... it's been suggested to make pages names with Console Commands appended, like Console Commands/move or Console Commands:move... should we start editting or leave it as it is now? (one page for all commands?)
Also, should tables files be documented as well? (skills.txt, spells.txt, etc etc)