Documentation

[Omega]

Wow, that took a long time, but finally finished full documentation of all features on individual pages on the wiki.

https://docs.megaglest.org/GAE/Features

The Normal maps and shaders page needs a bit more info though. I searched all over the board, trac, and wiki, but couldn't find anything more than what I have on that page (I could have sworn someone went into depth about them a bit more on a side topic). Other than that, all the major features have an individual page, and I'll probably continue to add just a list of the other features which don't need a full page (eg: auto-return).

The old GAE reference and guide pages were used to make these individual pages and are now obsolete, so they're redirects to this new features page.

I'm not sure if effects/emanations can use particles, light, or sound yet... The old pages said they couldn't, but someone may have mentioned on the forum... My searches turned up nill, so I excluded that for now, but there's a nagging feeling, so if someone can confirm if effects and emanations support them yet, feel free to add it to their pages yourself or at least confirm in here.

Since this method should make it vastly easier to add documentation about new features, let's be sure to do so, lest features end up lost in time. Even I learned a fair bit looking stuff up to make these pages. For example, I knew there was multibuild now thanks to Tom mentioning it in the todo list, but couldn't find a single entry of how to do it. I ended up finding it out from a sample of John's Project Green.

[silnarm]

Thanks Omega, pages per feature are nice, a little concerned by duplication though, you've described what in the code is an EnhancementType on four pages... Upgrades, Effects, Emanations & Levels are all derived from EnhancementType, so I'd prefer to document that XML seperately (and only once!) and link to it on the pages for Upgrades etc, The pages that will loose most of their content from this can be fleshed out with lots of examples.

This is good for us, as if EnhancementType has things added to it, we only have to update the docomentation in one place; and I think it is good for the modder reading it too, as they will be made aware that upgrades, levels and effects are very similar, and xml snippets can be interchanged between them.

With a beta finally out, and not too many more problems to look at, I'll get to work on the wiki at once...

[Omega]

That's all yours then. You know the layout of the code and how it all works better than anyone, so...