Next Previous Up Top Contents Index

WebMaker User Guide

3.7 Index

WebMaker can create an index to the web document; this is a generated index (much like a generated table of contents), not a mapped index. WebMaker creates the index based on the index markers in the FrameMaker document. The index entries are links in the web document and do not show page numbers.

To have WebMaker create an index:

Include a library file such as nodesTI.wml and nodesBTI.wml in your WML file. These library files define node rules that create an index.

WebMaker offers three styles of index:

Simple index

Creates a single node. Index entries are sorted alphabetically and displayed without headers dividing the entries into sections. The IndexHeadingS-IndexNodeS rule in headings.wml produces this.

Letter index

Creates a single node. Index entries are sorted alphabetically and displayed with headers dividing the entries into sections for each letter. The IndexHeadingL-IndexNodeL rule in headings.wml produces this.

Multiple nodes index

Creates multiple nodes. Index entries are sorted alphabetically and displayed with a separate node for each letter section. The IndexHeadingN-IndexNodeN rule in headings.wml produces this.

The rules in the nodeTI.wml and nodesBTI.wml library files create the index entries from the FrameMaker Index markers. You can write WML index rules that use any of the FrameMaker markers (except markers of Type 25, which are used specially by WebMaker; see Section 3.8, "Including external links"). Index rules use the WML node function index(markertype, indexoption).

The navigation panels provided in the nodesTI.wml and nodesBTI.wml library files include links that take a user to the index from other nodes.