Skip to content
Metanorma

Index terms

Before you define an index term, your document needs a section where the index terms can appear. To create an index, define a level 1 section (==) marked with the style index at the end of your document.

[index]
== Index

Index entries can consist of up to three levels using a comma to separate the terms. Metanorma provides two options to create an index entry:

  • Visible index terms are words within the text that are annotated with an index entry using double parentheses. \((Level 1 index term))
  • Hidden index terms are index entries that are not visible in the final output and are generated using triple parentheses. (\((Level 1 index term, Level 2 index term, Level 3 index term))). These allow the index to include optional subterms and sub-subterms; they also allow the index term to differ from what actually appears in the text.

Let’s have a look at an example:

The Lady of the Lake, her arm clad in the purest shimmering samite,
held aloft Excalibur from the bosom of the water,
signifying by divine providence that I, ((Arthur)), <1>
was to carry Excalibur (((Sword, Broadsword, Excalibur))). <2>

Practice time

:exercise-file: exercise-2-4-2 include::exercises.adoc[tags=intro;exercise-2-4-2]

In the next lesson, we will cover references and links.

+++ <div class="cta tutorial"><a class="button" href="/learn/lessons/lesson-2-4-3/">Start next lesson »</a></div> ++++

Edit this page on GitHub →