Home
Categories
Dictionary
Download
Project Details
Changes Log
What Links Here
How To
Syntax
FAQ
License

Specifying the index

    1 Usage example
    2 Another usage example
    3 Notes
    4 See also

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

By default the tool will look for the index in one of the root directories, but it is possible to specify the index explicitly in the configuration. 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 articles which are in a root will not be taken into account , which means that you will not have an error if there is more than one index article in the wiki source.

Usage example

Suppose that we have the following articles structure (with only one root):

      wiki
      --> input
      ----> article.xml
      myIndex.xml

We don't have any index in the root but we can specify the index on the command-line:

      java -jar docGenerator.jar -input=wiki/input -output=wiki/output -index=myIndex.xml

Another usage example

In this case we have two roots, and two index articles (one for each root):

      wiki
      --> input1
      ----> article1.xml
      ----> index.xml
      --> input2
      ----> article2.xml
      ----> index.xml

We have two index articles, in the root but we can specify the one one we want to use on the command-line:

      java -jar docGenerator.jar -input=wiki/input1;wiki/input2 -output=wiki/output -index=wiki/input1/index.xml

Notes

^ Except if the index found in the root is the specified global index of course