Explanation of the process of indexing a technical manual with Adobe FrameMaker. Key words: documentation, writer, editing, graphical designer, expert, user manual, communication, Ron Kurtus, School for Champions. Copyright © Restrictions
Indexing with FrameMaker
by Ron Kurtus (14 July 2000)
Indexing a document is an art in itself. Since Adobe FrameMaker is the program of choice for most companies producing technical documentation, it is worth while to find out how to create an index in FrameMaker.
Questions you may have include:
- What are some indexing basics?
- How do I add words as new index items?
- How do I edit existing index items?
This lesson will answer those questions.
FrameMaker Indexing Basics
The index is an alphabetically arranged list of key words and reference pages. FrameMaker keeps track of each entry, its associated words and the page with a marker. Entries with the same text are merged into a single entry with several page references.
In some cases, a number of entries may all start with the same word. In such a case, sub-entries can be entered, as seen below:
You can also have a cross-reference to another entry, as well as a range of pages.
The method to add words is fairly straightforward.
- First, show text symbols: View > Text Symbols. This allows you to see the markers.
- With your mouse, highlight the word or words to index.
- Open the Marker window: Special > Marker. Make sure the Marker Type is Index. The highlighted words will be automatically entered in the Marker Text field.
- Edit or add text. (See next two sections).
- Click New Marker button.
Using multiple entries per marker
You can add several entries in one Marker window be separating entries with a semi-colon (;). For example, if your entry was economic advantage, you may also want to include an index entry of advantage, economic.
Thus, you would include in the Marker Text field: economic advantage; advantage, economic. You could have any number of entries, as deemed appropriate.
If you realize the first word in an entry is used in numerous other entries, you could place the next words as a subentry. You do this by separating the words with a colon (:).
For example, if your entry was open book and you know there are several other entries starting with open, you could make book a subentry: open: book.
Of course, care must be taken to make sure your entries make sense.
Editing existing index entries
You can easily find and edit existing index entries.
- Show text symbols: View > Text Symbols.
- Open the Marker window: Special > Marker.
- Open the Find/Change window: Edit > Find/Change.
- Select Marker of Type: in the Find drop-down list box.
- Type index in the Find text box.
- Choose the Find button. The next index entry will display in the Marker window.
- Edit entry and click Edit Marker. To delete, enter Space + Backspace.
Printing out chapter index
You can view or print the index for individual chapters in your FrameMaker book. This facilitates editing, as opposed to using the book's whole index.
- In the file or chapter you are editing, File > Generate/Book to open the Generate/Book window.
- Mark the Index radio button and choose the Generate... button.
- The index for the chapter is generated and displayed. Print the chapter index to examine and edit.
The process for creating and editing an index in a FrameMaker document is relatively simple. The greater task is deciding on what to index for effective use by the readers.
Skill in using tools increases your value
Resources and references
American Society of Indexers - Organization for writers specializing in indexing issues
The Art of Indexing by Larry Bonura, John Wiley & Sons, 1994 ($31.99) - Short lessons on each step of the indexing process, including how to estimate indexing time and indexing for on-line documents.
Questions and comments
Do you have any questions, comments, or opinions on this subject? If so, send an email with your feedback. I will try to get back to you as soon as possible.
Click on a button to bookmark or share this page through Twitter, Facebook, email, or other services:
Students and researchers
The Web address of this page is:
Please include it as a link on your website or as a reference in your report, document, or thesis.
Where are you now?
Indexing with FrameMaker