Creating an index in FrameMaker? Read on…

An index is an alphabetical list of terms or concepts placed towards the end of a book or a document, along with page numbers on which they appear in the book or document. An index is created in a standard format to make scanning easier. An index is an integral part of any book or document of considerable volume, printed or online, as it helps in finding information about key terms.

If you want to create the right index for your book in FrameMaker and are wondering about options, this post is for you. FrameMaker lets you create an index for a book or a document with the help of index markers. Using index markers, you can insert a key entry for the index, include a sub-entry, specify a page number or a page range, and define See or See also links for index entries.

Read on as we unfold some common workflows around indexes in FrameMaker:

Create an index marker in an unstructured document in FrameMaker

Select the term in the document that you want to include in the index. Go to Special > Marker and in the Marker dialog box, select the marker type as Index. If required, edit the marker text, and then click New Marker. The term is added as a new index marker.

Index in FrameMaker

You can also create index markers for structured documents. See Create an index marker in a structured document in FrameMaker for more information.

Include multiple index entries in one index marker

You can include multiple entries in a marker by separating the entries using a semicolon (;) in the marker text. The index terms that you combine are arranged in alphabetical order.

For example:

index in FrameMaker

Note: If you combine two terms that start with different letters, they appear as two separate index terms. For example, if the combination is Bibliography; Utilities, then Bibliography will be an index term under B and Utilities a separate index term under U.

Create an index sub-entry for an index marker

For an index key entry, an index sub-entry is created to group subsequent information together. You can create sub-entries for a key entry using a colon (:) in the marker text.

For example:

Index in FrameMaker

Create See or See also links in an index entry

Adding related index entries as See or See also links helps align similar pieces of information together, thus avoiding duplication.

To add a See or See also link to an existing index term, use See or See also in the marker text.

For example:

Index in FrameMaker

Here, both the index terms take you to their respective locations.

Tip: Use <$nopage> if you do not wish to show the page number with an index term.

For example:

Index in FrameMaker

Generate the index from index markers

After creating index markers, you can generate a standard index in FrameMaker. Go to Add > Standard Index or Special > Standard Index and include the marker type Index in the Setup Standard Index dialog box. Click Update in the Update Book dialog box and click OK to generate an index for your book.

Index in FrameMaker

To know more about how to generate an index for a book or a document, see Generate indexes.

Create an index marker in a structured document in FrameMaker

Yes, you can create indexes for structured documents or books. Click where you want to insert the marker. Go to Element > Element Catalog, select and double-click the index element indexterm to insert the index marker.

In the Insert Marker dialog box, choose the marker type as Index and update the marker text. Click New Marker to add the term as an index marker.

Index in FrameMaker

Customization in index

You can perform the following customization while creating index markers for your index.

Define page ranges in index entries

To specify page ranges for index terms, where information spans several pages, use <$startrange> to specify the beginning of the page range and <$endrange> to specify the end of the page range.

Note: You can also create page ranges automatically using <$autorange>. For more information, see Using page ranges in index.

For example: Information about Bibliography and its basics spans from page 9-11.

Index in FrameMaker

Format text in an index entry

You can control the formatting of text in an index entry by adding character format in the marker text. You can format the text in an entry by typing the character tag between angle brackets (< and >) before the text and typing <Default Para Font> after it.

For example:

Index in FrameMaker

You can also use the bold character tag to show the entries or page numbers in bold. For more information, see Format text in an index entry.

Grouping index titles in an index

You can group index titles in a FrameMaker index so that entries for more than one letter appear together.

Index in FrameMaker

For more information, see Working with group titles in FrameMaker index.

Sorting index titles in an index

You can modify and update the usual sorting order of index titles for an index, which is special symbols first, followed by numbers and alphabetic characters.

For more information, see Working with sort order in index.

Import index along with the Word document in FrameMaker

When you import a Word document in FrameMaker, the document’s index is also imported. The new index entries are added to the already existing index in FrameMaker.

Further reading: Creating indexes in FrameMaker