Table of Contents

Syntax #


Purpose #

The s.index-see annotation is used to tag a span element as being a redirection phrase in an index. In an index, See is used to refer the reader to another entry. This is generally done for common colloquial terms that are not used in the document (e.g. users saying “text” while the document uses “script”) or when terms are nested under a category (e.g. “fridge” being nested under “appliances”).

Example #

The following is an example of a time where you might want to use the s.index-see annotation:

The following is an example of a rule that will apply s.index-see:

The following is the DITA XML output for the previous rule:


<p><indexterm>accelerometer</indexterm>. <indexterm><index-see>See electronic components</index-see></indexterm></p>

<p><indexterm>assembling</indexterm>, 14</p>

<p>            <indexterm>connecting coolant lines</indexterm>, <i>14</i></p>

<p>            <indexterm>connecting fuel lines</indexterm>, <i>15</i></p>

<p><indexterm>assembly</indexterm>. <indexterm><index-see>See assembling</index-see></indexterm></p>