10 WebMaker Language (WML)

10.9 WML index

The technique for creating and index is much like the technique for creating an external tables of contents. The function that generates an index is:

index(markertype, indexoption)

where:

markertype

is the type of source FrameMaker marker. The possible values are:

2 or Index
3 or Comment
4 or Subject
5 or Author
6 or Glossary
11, 12, ..., 24

indexoption

May take one of three values: simple, letter, or node.

The value simple creates a single node index with letter groups separated only by a space.

The value letter creates a single node index with letter groups separated by letter headings.

The value node creates one node per letter group, in which case a letter button is generated in the top index node for each letter group for which there is at least one index entry. Node rules may only be specified for the top index node which is also the only node that may be accessed using filename(node).

An index is triggered by the single use of a FrameMaker paragraph tag, such as WWW-IX. A node type dedicated for this use should be specified because:

The navigation panel of the index node is usually desired to be different than the rest of the web nodes.
This allows for the specification of a FILENAMEKEY for the index node, which in turn provides a mechanism to be able to point to this node from anywhere else in the generated web, such as in the navigation panel of other nodes. This is best explained in the following example.

10.9.1 - Example of creating an index

WebMaker User Guide - 27 SEP 1995

Generated with Harlequin WebMaker