s.index-see-also

1 min read

Table of Contents

Syntax #

s.index-see-also

Purpose #

The s.index-see-also annotation is used to tag a span element as being a phrase in an index referring a user to another entry for additional information. In an index, See also is used to refer the reader to a related entry to give greater context or more complete information. This is generally done for terms that are not interchangeable but are connected in some manner (e.g. dolphins, See also: whales).

Example #

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

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

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

<p>E</p>

<p><indexterm>electronic components</indexterm>, <i>12</i></p>

<p>            <indexterm>accelerometer</indexterm>, <i>13</i></p>

<p>            <indexterm>flow meter</indexterm>, <i>13</i></p>

<p>            <indexterm>programmable logic controller</indexterm>, <i>13</i>&#x2028;                           <indexterm><index-see-also>See also: setting up</index-see-also></indexterm></p>