3.6.3 Generated table of contents

A generated table of contents is a node that contains a table of contents for the whole web of the FrameMaker document. A generated table of contents contains entries for each tag that you have mapped to headings level 1 through 4. WebMaker generates the table of contents from the paragraph tags in the document files, and does not use the table of contents in your FrameMaker document (if any). Thus, you can create a generated table of contents even if your FrameMaker document does not have a table of contents.

The nodesTI.wml and nodesBTI.wml library files contain a rule that creates a generated table of contents.

Both local and generated WebMaker tables of contents use paragraph tags mapped to Headings rules for the tables. Paragraphs whose tags are mapped to Headings rules become entries in the web's tables of contents. These tables of contents may differ from the FrameMaker table of contents since the tags used in FrameMaker may be different.

To have WebMaker create a generated table of contents:

• Include a library file such as nodesTI.wml and nodesBTI.wml in your WML file. These library files define node rules that create a generated table of contents and index.
• Include the headings.wml library file in your WML file. This file defines a paragraph rule that uses a generated table of contents node rule.
• Create a paragraph tagged with a special tag, such as WWW-TOC, exactly once in the FrameMaker document. This paragraph can be the table of contents title, but it must be a unique tag rather than something used elsewhere in the document, such as Chapter or 1Heading.
• Map the table of contents tag to the ExtTOCHeading-TocNode rule.
• Map the paragraph tags from the FrameMaker table of contents (if any) to the Ignore rule. For example, map tags named ChapterTOC and 1HeadingTOC to the Ignore rule.

You can write customized WML to create tables of contents that use a depth of other than 1 level for local table of contents and 4 levels for a generated table of contents. See the WML node function toc(depth, scope).

The navigation panels provided in the nodesTI.wml and nodesBTI.wml library files include a link that takes a user to the generated or mapped table of contents from other nodes.

Note: If you include nodesTI.wml or nodesBTI.wml in your WML file and you do not map a paragraph tag from your FrameMaker document to one of the TOC or Index WML rules, you could end up with HTML files that have greyed-out Contents and Index buttons. You can remove the Contents and Index buttons by using the nodes.wml or nodesB.wml files instead. See Section 3.10, "Troubleshooting RapidRules output" for more information.