Loading...
 
Skip to main content

Features / Usability


You are viewing a reply to How to use TikiWiki for documenation?

Re: How to use TikiWiki for documenation?

I use the wiki pages extensively for documentation at my site. I do as siridhar mentions; I use the structures 'module' (it isn't really a module, more of an integrated feature of TikiWiki) . All of the documents exist as Wiki Pages, not articles.

For example, we have a document that is currently in Microsoft Word. It is composed of 5 chapters (which are designated in word as sections using the 'Heading 1' style). The chapters are broken up into several sections each (using the 'Heading 2' style). We decided to 'wiki-ize' this document.

We decided on several standards:

  1. The page names all start with a standard prefix. The document is called 'Performance Management User's Guide', so we used 'PMUG' as the prefix.
  2. All chapters ('Heading 1') equate to new pages. Therefore, after the base 'PMUG' page is created (via structures), pages such as 'PMUGForeward', 'PMUGNavigation', and so on are added.
  3. All chapter sections ('Heading 2') equate to new pages that are 'beneath' the chapter pages in the hierarchy. For example, the 'Foreward' chapter is broken up into several sections: Overview, Who Should Use This Guide, Conventions, etc.; which results in the pages 'PMUGForewardOverview', 'PMUGForewardWhoUse', etc.
  4. If a chapter section is further broken up, the '!' and '!!' combined with the 'maketoc' command are used inside of a page.


This gives us the following benefits:

  • All pages are searchable.
  • A page can easily be linked to another page simply by using either WikiWords or by using the parenthesis pairs.


We have even got most of our data dictionary online, which means if a developer in the forum refers to a table in WikiWord format (which we already used to name/describe our tables) then the forum entry automatically generates a link to the table reference.

Send me a message if you want any more hints/tips.