Create an index entry

indexmark

Indexmarks are used for marking a word within the manuscript so that it can be assembled into the back-matter's index.

Types of index entries

Each entry is associated with other entries through the use of a metatopic, which is an arbitrary name, created by the author or professional indexer explicitly for that purpose.

BLUE-PHRASE can be used to specify four types of index entries:

  • Defining entries, which consist of a word or phrase, and which are assembled into the final index in alphabetical order. Unlike the other three types of entries, defining entries can stand alone. There may be only one defining entry per metatopic.
  • Unmarked entries, which appear in the final index visually subordinate to a defining entry. Each metatopic may have many unmarked entries.
  • Secondary entries, which are also subordinate to a defining entry, but which use their own word or phrase to refine the meaning of the defining entry. Each metatopic may have many secondary entries.
  • Cross-reference entries, which appear in the final index as a "see also" entry, pointing to a related defining entry. Each metatopic may have many cross-reference entries.

Syntax

Defining

The syntax for a defining entry consists of:

  1. The indexmark delimiters — two left square-brackets [[ and two right square-brackets ]]
  2. The metatopic, which is an arbitrary name preceded by a fullstop .
  3. The defining entry itself, which is delimited by apostrophes ' ', and which is emitted to the document, and to the final index.
 [[.metatopic 'defining entry']]
The components of a defining entry

Unmarked

The syntax for an unmarked entry consists of:

  1. The indexmark delimiters — two left square-brackets [[ and two right square-brackets ]]
  2. The metatopic, for associating it with a defining entry, preceded by a fullstop .
 [[.metatopic]]
The components of an unmarked entry

Secondary

The syntax for a secondary entry consists of:

  1. The indexmark delimiters — two left square-brackets [[ and two right square-brackets ]]
  2. The metatopic, for associating it with a defining entry, preceded by a fullstop .
  3. The refining text, which is delimited by a matched pair of parentheses ( ), and which is emitted to the document, and to the final index.
 [[.metatopic (refining text)]]
The components of a secondary entry

Cross Referecne

The syntax for an cross reference entry consists of:

  1. The indexmark delimiters — two left square-brackets [[ and two right square-brackets ]]
  2. Two metatopics, referencing two distinct defining entries, each one being preceded by a fullstop .
 [[.metatopic1 .metatopic2]]
The components of an cross reference entry

Definitions

The indexmark delimiters mark the start and end of the expression.

The metatopic is used by the index builder to assemble the final index.

Examples

Here is what indexmarks look like within the body of a manuscript.

1st entry[[.bees 'Bees']]
2nd entry[[.bees]]
3rd entry[[.bees (army)]]
4th entry[[.bees .honey]]

Honey[[.honey 'Honey']]

section {
h1 Index
!build-index *junctors=yes
}
Sample using indexmark syntax

syntax > doppelmarks > indexmarkCreate an index entry

🔎