Add an Index
To follow this guide, you must first install the Scroll Exporter Extensions app
You must install the Scroll Exporter Extensions app to use the macros required to follow this guide.
You can add an index to your PDF exports. To do so, you must first generate index terms on your Confluence pages, which you can do by:
- using page labels or
- using the Scroll Indexterm macro
Secondly, you must add an Index placeholder to a page in the Document Sections in your export template. Following this, the defined index terms from your Confluence pages will be included in the export as an index.
Generate index terms using page labels
Firstly, navigate to the page you want to insert a index term for, and add a label.
In the label, add your desired index term, and click Add. By default, a label is converted into a primary index term. To generate a secondary or tertiary index term, insert a forward slash character between the index terms.
Example:
The label fruits/apple/haralson will be converted into a primary index term 'Fruits', a secondary index term 'Apple', and a tertiary index term 'Haralson'.
Generate index terms using the Scroll Indexterm macro
Firstly, insert the Scroll Indexterm macro in front of a term you want to index on your Confluence page. Then, edit the macro, and define the specific index parameters (see below).
| Macro Parameters | Description |
|---|---|
| Primary | The first word or phrase under which this index term should be sorted |
| Secondary | The second word or phrase for sorting this index term |
| Tertiary | The third word or phase for sorting this index term |
Title (SCROLL V3 EXPORTERS ONLY) | The title as displayed in the index for the topic that is created by this macro. You can enter a keyword in the Title field and this will be displayed in a list when multiple link targets for a keyword are available (for context-sensitive help). |
| Significance | The significance of this index term can be set to either normal or preferred. Terms defined as preferred will be emboldened |
Add an index to your export template
Once you have generated your index terms, you can add an index to your export template.
To do so, navigate to the template editor, and add the Index placeholder where you want to insert the index. If you also used page labels to generate index terms, navigate to the Settings tab and Use page labels as index terms export option.