Syntax #
indexterms((term separator)(subordinate term separator)index terms)
prolog.indexterms((term separator)(subordinate term separator)index terms)
term separator (optional)
separator for identifying individual index terms
subordinate term separator (optional)
separator for identifying nested index terms
index terms
the index term string
Purpose #
The indexterms and prolog.indexterms annotations are used to identify index terms in the source document. These are often not part of the regular text flow of the content, but rather stored in a proprietary fashion. For example, FrameMaker uses markers to capture index terms. This information is available from Migrate. The markers are available as simple properties in the rules editor so that you can test for them and act appropriately. The approach to handling index terms is similar for other authoring formats.
The indexterms puts the indexterm entries at the start of the paragraph in which the indexterm appears, while the prolog.indexterms annotation stores the indexterms in the prolog of the topic in which the indexterm appears.
Example: Index Terms
Consider a content element which has a FrameMaker index marker with the following value:
QuickTrace: how to install
This value would be captured by an Index property in Migrate. The rule below will pick up the marker information and set the indexterms annotation.
The first specifed separator in the annotation, ; in this example, identifies the individual index terms. The second separator, :, identifies hierarchichal index entries. The “for each: Index” tells Migrate to place each index term it finds with the property Index into an indexterm tag. Using the indexterms annotation, this will give us the following DITA output:
The prolog.indexterms annotation will give us this DITA output instead:
