Power Feature: Index Page Generation

Doco will automatically place an index page..

 index.html

..in each directory it processes for Doco documents. Files of this name that already exist in this directory will be overwritten.

Index File Name

The name of the index file can be altered with an override in your project file.

 doco.index=whatever.html

Ignored Directories

Indexes will not be generated for

• Directories called style or CVS
• Directories containing a file called .docoignore

Directories containing a .docoignore file will also not appear as subdirectories of parent indexes.

Descriptive Text

If you place a file with the name

 description

..in any given directory, then this is written to the Doco index by way of explanatory text.

The names of your files are automatically and ordered tidied for viewing.

Here is an example index.