Overview index file format
==========================

The main HTML overview file is a little clumbersome to search. Consequently,
some users will wish to write their own front ends to launch the correct
section of the manuals without as much work. To allow this, the
'overview.idx' file is provided. This is a relatively simple file format
which should be parsable in any language with very little work.

The file consists of three blocks :
  * the files block
  * the sections block
  * the SWI/service/command block

It is not expected that all the information be useful to everyone, but it may
remove the need to manually index the manuals.


Files
-----
The files block starts each line with a > character. The format is :

  >filename.HTML description

This block is provided so that you can give a quick index of all of the
sections.


Sections
--------
The sections block is consists of a heading of the same format as the
file block lines, but starting with a :

  :filename.HTML description

Each subsequent line describes a heading in that file. This has the form :

  num anchor description

where num is the heading number. 1 being biggest, 6 being smallest.
      anchor is the anchor name used in the file to find that heading. You
             can't really rely on it being called anything; anchor names
             have been generated automatically.
      description is the heading description.


SWI/Service/Commands
--------------------
This block contains a list of file/anchor pairs and descriptions. It is an
extracted version of the h5 tag which refers to purely the "right-aligned"
sections (generally SWIs/Services/* Commands). This is likely to be useful
if you provide hotkey lookups. The lines start with an = sign :

  =filename.HTML#anchor description

which describes each of the locations.


Disclaimer
----------
No warranty is given for the correctness of these indices.
