Introduction

An index lists the terms and topics discussed in a document and the pages on which they appear:

Before generating the index, you should insert index entries to the document. Index entries are special non-printable objects that are used by Atlantis to generate an index. Each index entry tells Atlantis to include a corresponding term or topic in the document's index along with the page number on which that index entry resides.

When the "View | Special Symbols" mode of Atlantis is on, index entries display in the document window in this way:

The best way to manage index entries in a document is through the Index panel of the Control Board:

The "Index" panel can be used to modify existing index entries, delete them, use a concordance file to add more entries, etc.

Creating index entries

In order to create a new index entry, click the word or select the fragment in the document that you want to include in the index. Then press AltShiftX or click the New index entry button of the Insert toolbar . This would display the "Mark Index Entry" dialog:

For detailed information on the "Mark Index Entry" dialog, please click here.

Index entries can also be created with a concordance file.

Generating index

After creating index entries, you can insert an index itself. To do so, click a location in your document where you want to insert a new index (usually at the end of the document), then click the Index button of the Insert toolbar . This would display the "Index" dialog:

Then specify required options for your index, and click OK.

For detailed information on the "Index" dialog, please click here.

If you click or select a generated index in a document, the "Index" context toolbar would display:

You can use it to update the selected index, modify its properties, delete it, etc.

Creating multiple indexes

Most documents do not contain more than one index. But in some cases, multiple indexes need to be created in the same document. You might need to create separate indexes for individual sections of the document. You might also wish to have multiple indexes each covering specific entries scattered throughout the document text (for example, an index with authors and an index with subjects).

Here are the steps to create an index for a section (portion) of the document:

1. Create index entries for that document section.
2. Select the document section.
3. Press AltShiftB, type a meaningful name, and click the "OK" button to create a new bookmark.
4. Click a document location where you want to create a new index (normally after the corresponding document section).
5. Click the Index button of the Insert toolbar .
6. In the "Index" dialog, choose the bookmark created in step 3, and click "OK":
   

To create an index covering only specific index entries (author names, places, subjects, etc) from the entire document, do the following:

1. Create index entries for the new index. If the index is supposed to contain author names, select each author name in the document, then press AltShiftX or click the New index entry button of the Insert toolbar . Within the "Identifier" box of the "Mark Index Entry" dialog, specify the identifier of your index (for example, "authors"):
   
2. Click a document location where you want to create a new index.
3. Click the Index button of the Insert toolbar .
4. Within the "Identifier" box of the "Index" dialog, specify the required identifier (in our case, "authors"), and click "OK":
   

See also...