1.3. Using the indexterm editor

This dialog box, displayed by menu item DocBookInsert or Edit indexterm, allows to edit the selected indexterm element if any, or to create a new indexterm element and then insert it at caret position otherwise.

We'll explain with examples how to use the indexterm editor.

  • If you want to get this kind of entry in your back of the book index:

    P
    Pet 12

    specify Term=Pet.

  • Back of the book index:

    P
    Pet
        Cat 26

    specify Term=Pet, Term #2=Cat.

  • Back of the book index:

    P
    "+" 54

    specify Term="+", Sort as=plus. Without this Sort as specification, the index entry corresponding to "+" would have been found in the Symbols category:

    Symbols
    "*" 53, 78
    "+" 54
    "-" 55, 91-95
    ...
  • Back of the book index:

    D
    Domesticated animals 34 See also Pet

    specify Term=Domesticated animals, See also=Pet.

    Note that the content of the See also field must refer to an existing index entry. That's why instead of typing "Pet", you can select this index entry by using the dialog box displayed by the Pick from list button found at the right of the See also row.

    The above dialog box supports autocompletion. Note that if, for example, you want specify compound term "Pet Cat Siamese", you must type a space character between each simple term.

  • Back of the book index:

    I
    IT See Information Technology

    specify Term=IT, select "Redirect to the following term" then specify Redirect=Information Technology. (In the above example, notice that IT has no associated page number.)

    Like See Also, the content of the Redirect field must refer to an existing index entry. Unlike See Also, a Redirect entry is merely a redirection to an actual index entry.

  • Back of the book index:

    O
    Operation
        Additive
            "+" 87-90
    1. Insert a first indexterm element at the beginning the range (this will give us page number 87).

      In order to do that, use DocBookInsert or Edit indexterm and specify Term=Operation, Term #2=Additive, Term #3="+", Sort as #3=plus.

      Then check "Start range having the following name" and give your indexterm element an ID by specifying "plus_reference" in the Start range field.

    2. Insert another indexterm element at the end the range (this will give us page number 90).

      In order to do that, use DocBookInsert or Edit indexterm, check "End range having the following name" and specify the same ID, "plus_reference", in the End range field. All the other fields must be left blank.

      Note that instead of typing "plus_reference" in the End range field, you can select this ID by using the dialog box displayed by the Pick from list button found at the right of the End range field.

  • Normally, that is, when "Mark current location" is selected, an indexterm element contributes to the back of the book index with its own page number. However, in some cases, it may be convenient to insert an indexterm at some place (typically in chapterinfo, sectioninfo, etc, elements) and specify that this indexterm corresponds to the page numbers of one or more other elements.

    Example: let's suppose that the indexterm element is contained in a sectioninfo element and that the chapter about dogs has "ch.dogs" its ID. Back of the book index:

    P
    Pet
        Dog 22

    specify Term=Pet, Term #2=Dog, select "Mark the elements having the following IDs" then specify Element IDs=ch.dogs.

    Note that instead of typing "ch.dogs" in the Element IDs field, you can select one or more IDs by using the dialog box displayed by the Pick from list button found at the right of the Element IDs field.