Previous Page TOC Index Next Page See Page

Tables of Contents, Indexes, and Cross-references

Use your word processor’s cross-referencing and indexing tools to mark and generate tables of contents, indexes, and cross-references.

Creating a Master Document

To create a main table of contents and index, you’ll need to create a master document containing all the manual’s modules. Use your word processor to build a master document that references the module files—you don’t have to include the actual modules.

Tables of Contents

Before generating the table of contents, define it as a 2 or 3-level table of contents where you want it to appear. If you’re using WordPerfect, you’ll need to tag each heading you’re including in the table of contents. (The easiest way to do this is to include the Mark Text/Table of Contents marker as part of your heading style.) Generate the table of contents once all headings and page breaks have been finalized.

Indexes

Include an index in manuals of 50 pages or more. Add your index entries to the module files as you write them, or go back later and add them.

When you’re ready, create a master document and generate the index. In most word processing programs there is a way to combine the module number with each page reference. See your word processor manual.

Edit the index for duplications, omissions, and errors, going back into the module files to make your changes. Regenerate the index and check the page references. If you find errors in the page references, correct them by hand in the generated index.

Cross-references

Cross-references in modular manuals often reference module numbers and names rather than actual page numbers. If you want to reference a specific page, use your word processor’s cross-referencing tool to automate the reference, or keep a log of cross-references (for more information on cross-referencing, see Chapter 2).

Previous Page Page Top TOC Index Next Page See Page