Categories

Categories can be defined for wiki articles with the cat element. Each article can belong to any number of categories you want.

For example:

  <article desc="an article">
  This is a very simple article.
     <cat id="syntax" />
     <cat id="structure" />
  </article>

The generation will generate an html file for each category and present all the articles which belong to each category. Also the list of categories is linked in each article.

Adding descriptions to categories

It is possible to add descriptions to categories. This can be specified in XML files with the "categories" root. Each "category" element allows to specify its description, which will be presented in the categories list.
For example:

   <categories>
      <category id="syntax" desc="Articles about syntax"/>
      <category id="structure" desc="Articles about structure"/>
   </categories>

Setting detailed descriptions

It is possible to have more than just a sentence for the description of a category. For example:

   <categories>
      <category id="syntax" desc="Articles about syntax">
   This category deals about the articles syntax.
      </category>
      <category id="structure" desc="Articles about structure"/>
   </categories>

Note that the description attribute is however always required and will be used when presenting the link to the category in the list of categories page.

Prevent an article alternate title to be in the categories

It is possible to prevent an article altTitle to be put in the dictionary and categories by setting its "dictionary" attribute to false.

For example:

   <article desc="article name">
     <altTitle desc="the other name" dictionary="false" />
   </article>

Getting rid of the categories

The "hasCategories" property in the configuration file or the command-line specifies if the wiki must have categories (by default the categories list is generated).

If the propety is set to false, then categories will not be generated, even if the menu item for the categories is explictely specified in a custom left menu.