Index Markup¶

• Inhaltsverzeichnis
• Index Markup
  • Word
    • (1) Word-Index
    • (2) Encode index entries via character style
    • (3) List of index search terms
    • (4) Static index
    • Index-Headings and Placement of Indices
  • Hub XML
  • TeX
    • Markup of multiple Indices
      • Declaration of indices of different types
      • Invocation of the index script
    • Index rendering
      • Index rendering with TeX
      • Static index files

Word¶

Transpect-tex provides four methods to encode an index. They can be combined with each other.

(1) Word-Index¶

Obviously, the native Word Index feature is supported. With the \f switch, you can specify the index type.

The index listing is generated based upon the marked index entries in the main text. The Word feature Insert index in the ribbon entitled References shall be used only for your own control. It is removed during the process.

If you create an index listing with Word, it does not initially contain index entries that have a certain index type with "\ f".
But here are instructions on how to create an index listing for index entries with type.

(2) Encode index entries via character style¶

You can markup phrases with a specific character style to encode them as index entry. During the conversion, an index entry is created from a phrase which has the character style ([a-z]{1,3}_index_mark). Index entries that are already encoded with the Word index feature are ignored and not encoded twice.

(3) List of index search terms¶

You can create a list of index search terms at the end of the document. During the conversion the converter searches for matches in the content and creates an index entry for each match. There are specific requirements on the list of index search terms. Each entry must have the paragraph style [a-z]{1,3}_index_list and needs to be placed in a separate paragraph. Index entries that are already encoded via Word index feature (1) or character style (2) are ignored and not encoded twice. You can also use the character style [a-z]{1,3}_index_name to mark only a part of the index search term, e.g. for John Doe, Doe can be marked so that an index entry is also created for the phrase Mr Doe.

(4) Static index¶

If you do not want to automatically search for entries in the text in the index, you can also insert a static index. You need to insert a list of index entries that yield the index_static style. Page numbers in the form of entry 144, 156, 192 are linked to the page, i.e. you have to make sure that the page reference is correct!

Index-Headings and Placement of Indices¶

You can mark individual index headings with a paragraph format (Regex: [a-z]{1,3}_index_heading). The index is rendered where the heading is in the document. Do not forget to add the index type suffix to the style name if you have multiple indices in your document.

With concordance lists and static registers, the heading must placed above the index and have the paragraph style [a-z]{1,3}_index_heading. Otherwise it won't be possible to assign the index heading to the list of index entries. For indexes with a specific type (e.g. person, location, subject etc), the type must be added to the paragraph style, e.g. [a-z] {1,3} _index_heading_person. If there is no index heading, a standard text is inserted (e.g. Index) and the index is inserted at the end of the document.

Hub XML¶

All four variants can be combined to create an index. In the hub format, index entries are given a remap attribute in the text, which they assign to a specific index:

<indexterm remap="e" type="person">
  <primary>John Doe</primary>
  <secondary>Great writers of Anytown</secondary>
</indexterm>

For each index, an <index> element is generated. The <index> is either placed at the position of the index heading or – if not present – at the end of the document.

<index type="person" remap="e">
  <title role="tsindexheadingperson">John Doe</title>
</index>

In the case of static indexes, it is assumed that the heading is always above the list of index entries. The type of index can also be specified here via an index type suffix in the paragraph style. Page numbers will be linked to the page later.

A .x_ind file is generated for static indexes during the XML conversion. In the case of dynamic indexes in the text, this must first be generated via index.sh. See below Index .

<index remap="c" type="location">
  <title role="tsindexheadinglocation">Ortsregister</title>
  <indexdiv>
    <title>B</title>
    <indexentry>
      <primaryie>Bertelé, <xref xlink:href="page-93"/>, <xref xlink:href="page-94"/></primaryie>
    </indexentry>
    <!-- (…) -->
  </indexdiv>
</index>

TeX¶

Markup of multiple Indices¶

We use the LaTeX package index for the creation of indices and Xindy to render the index.

Declaration of indices of different types¶

The index package allows to declare multiple indices. They are declared with \(re)newindex commands:

\newindex{<typ>}{<endung rohindex>}{<endung fertiger index>}{<Überschrift>}

To ensure the invocation of the index.sh script is working properly, the file extension of the non-default index types must be entitled <typ>_idx (raw index) and <typ>_ind (finished index).

The default index has the label default assigned. Its heading can be overwritten:

\renewindex{default}{idx}{ind}{Personenregister}

Index entries were marked in this way:

\index{<Lemma>}

The index listing will be rendered in place of the \printindex instruction.

\printindex

Concerning multiple indices, each index has an individual letter as identifier.

\newindex{l}{l_idx}{l_ind}{Locations}

In these sample we define a location index that is identified by the letter "l".

\index[l]{<Term>}

With \printindex[l], the location index is rendered.

\printindex[l]

Invocation of the index script¶

You can pass the index identifier (e.g. letter) to specify which index should be generated. If you omit the optional argument, the main index will be generated.

./index.sh <tex-Dateiname ohne Endung>

Passing the letter l to the index script collects all index terms of this type and creates the location index.

./index.sh <tex-filename without extension (basename)> l

The script needs to run for each index to be created.

Index rendering¶

Index rendering with TeX¶

Index terms are encoded with \index[<typ>]{<Lemma>} in TeX.

lualatex <tex-Dateiname>.tex      %% initial tex run, collect headings
lualatex <tex-Dateiname>.tex      %% create toc
lualatex <tex-Dateiname>.tex      %% for safety reasons
./index.sh <tex-Dateiname>        %% run index script for main index
./index.sh <tex-Dateiname> <type> %% run index script for index with type of <index>
lualatex  <tex-Dateiname>.tex     %% render index
lualatex  <tex-Dateiname>.tex     %% include index in ToC
lualatex  <tex-Dateiname>.tex     %% for safety reasons

Static index files¶

Are named <basename>.<type>_ind and are generated in case of static indices.

With static indexes the index.sh must not be invoked, otherwise the *_ind files would be overwritten! All other steps are the same; \(re)newindex{}{}{}{} must also be used here.