Documentation Center

Index

XML structure used for the generated back-of-the-book index of a publication or map. The structure is based mainly on the DocBook DTD.

XML Structure

<!ELEMENT index (indexentry+)>
<!ELEMENT indexentry (primaryie | secondaryie | seeie | tertiaryie | seealsoie)+>
<!ELEMENT primaryie (#PCDATA | xref)*>
<!ATTLIST primaryie
	ishref CDATA #IMPLIED
	ishtype (ISHIndexSynonym | ISHIndexTerm) #IMPLIED
>
<!ELEMENT secondaryie (#PCDATA | xref)*>
<!ATTLIST secondaryie
	ishref CDATA #IMPLIED
	ishtype (ISHIndexSynonym | ISHIndexTerm) #IMPLIED
>
<!ELEMENT seealsoie (primaryie, secondaryie?, tertiaryie?)>
<!ATTLIST seealsoie
	ishref CDATA #REQUIRED
>
<!ELEMENT seeie (primaryie, secondaryie?, tertiaryie?)>
<!ATTLIST seeie
	ishref CDATA #REQUIRED
>
<!ELEMENT tertiaryie (#PCDATA | xref)*>
<!ATTLIST tertiaryie
	ishref CDATA #REQUIRED
	ishtype CDATA #REQUIRED
>
<!ELEMENT xref EMPTY>
<!ATTLIST xref
	linkend CDATA #REQUIRED
	ancestor CDATA #REQUIRED
	ishcondition CDATA #REQUIRED
>

Example

<index>
  <!-- some more index terms skipped  -->
  <indexentry>
    <primaryie>Trademarks</primaryie>
    <secondaryie>abbreviations</secondaryie>
    <tertiaryie 
      ishref="GUID-BD403DBB-7355-4E76-A3C4-4DBF099764EF" 
      ishtype="ISHIndexTerm">description 
      <xref linkend="V300371" 
        ancestor="OB00002#M011187" 
        ishcondition=" ((FVEHICLESERIES in (CF65)))"/>
      <xref linkend="V300371" 
        ancestor="OB00002#M001289" 
        ishcondition=" ((FVEHICLESERIES in (CF65)))"/>
      <xref linkend="V300371" 
        ancestor="OB00002#M001279" 
        ishcondition=" ((FVEHICLESERIES in (CF65)))"/>
    </tertiaryie>
    <secondaryie>product names</secondaryie>
    <tertiaryie 
      ishref="GUID-498A7F3C-5C2C-43D5-8CC0-F25E9940CA8C" 
      ishtype="ISHIndexTerm">cross-referencing
      <xref linkend="V300371" 
        ancestor="OB00002#M011187" 
        ishcondition=" ((FVEHICLESERIES in (CF65)))"/>
      <xref linkend="V300371" 
        ancestor="OB00002#M001289" 
        ishcondition=" ((FVEHICLESERIES in (CF65)))"/>
      <xref linkend="V300371" 
        ancestor="OB00002#M001279" 
        ishcondition=" ((FVEHICLESERIES in (CF65)))"/>
    </tertiaryie>
    <seealsoie ishref="GUID-3ACD9C93-4B24-40F6-957C-523DF82362A4">
    <primaryie>cross-referencing</primaryie>
    <secondaryie 
      ishref="GUID-3ACD9C93-4B24-40F6-957C-523DF82362A4" 
      ishtype="ISHIndexTerm">productnames</secondaryie>
    </seealsoie>
  </indexentry>
  <!-- some more index terms skipped  -->
</index>

Remarks

  • See references from the synonym to the preferred term also contain links to the topics that contain the preferred index term.
  • Seealso references do not contain the occurrences of the related index term, as both terms are not equivalent.