Index term list
XML structure used to describe one or more index terms or synonyms. The structure is mainly based on the DocBook DTD.
XML Structure
<!ELEMENT indexterm (ishfields?, primary,secondary?, tertiary?, synonym?, seealso?, see?)>
<!ATTLIST indexterm
ishref CDATA #REQUIRED
ishtype (ISHIndexSynonym | ISHIndexTerm) #REQUIRED
>
<!ELEMENT indexterms (indexterm+)>
<!ELEMENT ishfield (#PCDATA)>
<!ATTLIST ishfield
name CDATA #REQUIRED
>
<!ELEMENT ishfields (ishfield)>
<!ELEMENT primary (#PCDATA)>
<!ATTLIST primary
sortvalue CDATA #IMPLIED
>
<!ELEMENT secondary (#PCDATA)>
<!ATTLIST secondary
sortvalue CDATA #REQUIRED
>
<!ELEMENT see (indexterm)>
<!ELEMENT seealso (indexterm)>
<!ELEMENT synonym (indexterm)>
<!ELEMENT tertiary (#PCDATA)>
<!ATTLIST tertiary
sortvalue CDATA #REQUIRED
>
Example
<indexterms>
<indexterm
ishref="GUID-A8ACE295-204E-40CE-AF0C-19C73E8CA638"
ishtype="ISHIndexTerm">
<ishfields>
<ishfield name="FISHINDEXCLASSIFICATION">global</ishfield>
</ishfields>
<primary>articles</primary>
<synonym>
<indexterm
ishref="GUID-722A5207-CAB4-419E-9CED-E510FE5475F9"
ishtype="ISHIndexSynonym">
<primary>indefinite articles</primary>
</indexterm>
</synonym>
<seealso>
<indexterm
ishref="GUID-3ACD9C93-4B24-40F6-957C-523DF82362A4"
ishtype="ISHIndexTerm">
<primary>prepositions</primary>
</indexterm>
</seealso>
</indexterm>
<indexterm
ishref="GUID-6B99DB51-A183-4C20-AE4C-08FF16AABE5A"
ishtype="ISHIndexTerm">
<ishfields>
<ishfield name="FISHINDEXCLASSIFICATION">local</ishfield>
</ishfields>
<primary>articles</primary>
<secondary sortvalue='avoiding'>Avoiding</secondary>
<tertiary sortvalue='inindexes'>in indexes</tertiary>
</indexterm>
<indexterm
ishref="GUID-722A5207-CAB4-419E-9CED-E510FE5475F9"
ishtype="ISHIndexSynonym">
<primary sortvalue='indefinite articles'>Indefinite articles</primary>
<see>
<indexterm
ishref="GUID-A8ACE295-204E-40CE-AF0C-19C73E8CA638"
ishtype="ISHIndexTerm">
<primary>articles</primary>
</indexterm>
</see>
</indexterm>
<indexterm
ishref="GUID-3ACD9C93-4B24-40F6-957C-523DF82362A4"
ishtype="ISHIndexTerm">
<ishfields>
<ishfield name="FISHINDEXCLASSIFICATION">local</ishfield>
</ishfields>
<primary>prepositions</primary>
<seealso>
<indexterm
ishref="GUID-A8ACE295-204E-40CE-AF0C-19C73E8CA638"
ishtype="ISHIndexTerm">
<primary>articles</primary>
</indexterm>
</seealso>
</indexterm>
</indexterms>
Remarks
- Index term synonyms do not have metadata.
- The
sortvalueattribute is only set when the sortvalue of a term is different from the (display-)value - Multiple synonyms and seealso references are added in separate elements