Index article

The index is the article which is the entry-point to the wiki.

Overview

An index has the top-level element "index" and has no name. Appart from that, it can contain exactly the same elements as a regular article.

For example:

  <index>
  This is the index.
     <cat id="general" />
  </index>

Refering to another article

It is possible to specify your index to refer to another article in the wiki. For example:

   <index referTo="the article">
   </index>

Note that in that case the index.html file will be created, but will redirect to the article specified in the referTo attribute. The content of the index will not be used even it is exists.

Index with several roots

When there are several root directories, you will need to specify explicitly the index file. You can do this by using the command-line starting command-line option or the associated configuration file option.

The index file can be anywhere, it is not necessary for it to be in one of the root directories. Note that in this case, index files which are in a root will not be taken into account.

Mediawiki and Markdown indexes

A Mediawiki file with the following first line is an index:

      {{index}}

A Markdown file with the README.md name is also an index.

Wiki source without index

If your wiki does not have any index file, you will have the following error:No index file found. The tool will create in that case an empty index file.