Sunday, December 6, 2009

Separate manual pages

It is useful to have separate pages on the wiki for each tool so that the menu on the tool can have a link to a wiki page, as well as a link to the local documentation. The model is chamber, which has been moved from the contents page to its own page at:

It is called Skeinforge_Chamber rather than just Chamber to avoid possible future name collisions with the rest of the wiki. It has a Previous, Next & Contents group on the top and bottom of the page to aid navigation through the skeinforge manual. The previous link points to the previous tool in the manual, which for chamber is currently carve, the next link points to the next tool, clip. The contents link point to the skeinforge contents page.

On the contents page, there is a link to chamber. To display the link as 'Chamber' while going to 'Skeinforge_Chamber', the wiki link is:
==== [[Skeinforge_Chamber|Chamber]] ====

Otherwise, the chamber page follows the format of the contents page, with a heading for each setting.

When adding new tool pages, please add it as a separate page using the chamber page as a model. For people who want to help develop the manual, please move existing pages to their own separate page, using the chamber model. Before each release, I will update the tools which have a separate manual page to add a manual page link to their help menus.