docbook:indexterm

Element Information

Model

Attributes

QName Type Fixed Default Use Inheritable Annotation
annotations optional
arch optional
audience optional
class restriction of xs:token optional
condition optional
conformance optional
dir restriction of xs:token optional
linkend xs:IDREF optional
os optional
pagenum optional
remap optional
revision optional
revisionflag restriction of xs:token optional
role optional
scope restriction of xs:token optional
security optional
significance restriction of xs:token optional
startref xs:IDREF optional
type optional
userlevel optional
vendor optional
version optional
wordsize optional
xlink:actuate xlink:actuateType optional
xlink:arcrole xlink:arcroleType optional
xlink:href xlink:hrefType optional
xlink:role xlink:roleType optional
xlink:show xlink:showType optional
xlink:title xlink:titleAttrType optional
xlink:type xlink:typeType optional
xml:base xs:anyURI optional
See http://www.w3.org/TR/xmlbase/ for
information about this attribute.
xml:id xs:ID optional
See http://www.w3.org/TR/xml-id/ for
information about this attribute.
xml:lang union of(xs:language, restriction of xs:string) optional
Attempting to install the relevant ISO 2- and 3-letter
         codes as the enumerated possible values is probably never
         going to be a realistic possibility.  See
         RFC 3066 at http://www.ietf.org/rfc/rfc3066.txt and the IANA registry
         at http://www.iana.org/assignments/lang-tag-apps.htm for
         further information.

         The union allows for the 'un-declaration' of xml:lang with
         the empty string.
xreflabel optional
zone xs:IDREFS optional

Used By

Elements docbook:abbrev, docbook:accel, docbook:acknowledgements, docbook:acronym, docbook:address, docbook:annotation, docbook:answer, docbook:appendix, docbook:application, docbook:arg, docbook:article, docbook:artpagenums, docbook:attribution, docbook:authorinitials, docbook:bibliocoverage, docbook:bibliodiv, docbook:bibliography, docbook:biblioid, docbook:bibliolist, docbook:bibliomisc, docbook:bibliomset, docbook:bibliorelation, docbook:bibliosource, docbook:blockquote, docbook:bridgehead, docbook:callout, docbook:calloutlist, docbook:caption, docbook:caution, docbook:chapter, docbook:citation, docbook:citebiblioid, docbook:citetitle, docbook:city, docbook:classname, docbook:classsynopsisinfo, docbook:code, docbook:colophon, docbook:command, docbook:computeroutput, docbook:confdates, docbook:confnum, docbook:confsponsor, docbook:conftitle, docbook:constant, docbook:constraintdef, docbook:contractnum, docbook:contractsponsor, docbook:contrib, docbook:country, docbook:database, docbook:dedication, docbook:edition, docbook:email, docbook:emphasis, docbook:entry, docbook:envar, docbook:errorcode, docbook:errorname, docbook:errortext, docbook:errortype, docbook:example, docbook:exceptionname, docbook:fax, docbook:figure, docbook:filename, docbook:firstname, docbook:firstterm, docbook:footnote, docbook:foreignphrase, docbook:formalpara, docbook:funcdef, docbook:funcparams, docbook:funcsynopsisinfo, docbook:function, docbook:glossary, docbook:glossdef, docbook:glossdiv, docbook:glossentry, docbook:glosslist, docbook:glosssee, docbook:glossseealso, docbook:glossterm, docbook:guibutton, docbook:guiicon, docbook:guilabel, docbook:guimenu, docbook:guimenuitem, docbook:guisubmenu, docbook:hardware, docbook:holder, docbook:honorific, docbook:important, docbook:index, docbook:indexdiv, docbook:informalexample, docbook:informalfigure, docbook:initializer, docbook:interfacename, docbook:issuenum, docbook:itemizedlist, docbook:itermset, docbook:jobtitle, docbook:keycap, docbook:keycode, docbook:keysym, docbook:label, docbook:legalnotice, docbook:lineage, docbook:lineannotation, docbook:link, docbook:listitem, docbook:literal, docbook:literallayout, docbook:manvolnum, docbook:markup, docbook:mathphrase, docbook:member, docbook:methodname, docbook:modifier, docbook:mousebutton, docbook:msgaud, docbook:msgexplan, docbook:msglevel, docbook:msgorig, docbook:msgtext, docbook:note, docbook:olink, docbook:option, docbook:optional, docbook:orderedlist, docbook:orgdiv, docbook:orgname, docbook:otheraddr, docbook:othername, docbook:package, docbook:pagenums, docbook:para, docbook:paramdef, docbook:parameter, docbook:partintro, docbook:personname, docbook:phone, docbook:phrase, docbook:pob, docbook:postcode, docbook:preface, docbook:primary, docbook:primaryie, docbook:procedure, docbook:productname, docbook:productnumber, docbook:programlisting, docbook:prompt, docbook:property, docbook:publishername, docbook:qandadiv, docbook:qandaset, docbook:question, docbook:quote, docbook:refdescriptor, docbook:refentry, docbook:refentrytitle, docbook:refmeta, docbook:refmiscinfo, docbook:refname, docbook:refpurpose, docbook:refsect1, docbook:refsect2, docbook:refsect3, docbook:refsection, docbook:refsynopsisdiv, docbook:releaseinfo, docbook:remark, docbook:replaceable, docbook:returnvalue, docbook:revdescription, docbook:revnumber, docbook:revremark, docbook:screen, docbook:secondary, docbook:secondaryie, docbook:sect1, docbook:sect2, docbook:sect3, docbook:sect4, docbook:sect5, docbook:section, docbook:see, docbook:seealso, docbook:seealsoie, docbook:seeie, docbook:seg, docbook:segtitle, docbook:seriesvolnums, docbook:setindex, docbook:shortaffil, docbook:sidebar, docbook:simpara, docbook:simplesect, docbook:state, docbook:step, docbook:street, docbook:subscript, docbook:subtitle, docbook:superscript, docbook:surname, docbook:symbol, docbook:synopsis, docbook:systemitem, docbook:table, docbook:tag, docbook:taskprerequisites, docbook:taskrelated, docbook:tasksummary, docbook:td, docbook:term, docbook:termdef, docbook:tertiary, docbook:tertiaryie, docbook:textobject, docbook:th, docbook:tip, docbook:title, docbook:titleabbrev, docbook:toc, docbook:tocdiv, docbook:tocentry, docbook:token, docbook:trademark, docbook:type, docbook:uri, docbook:userinput, docbook:variablelist, docbook:varname, docbook:volumenum, docbook:warning, docbook:wordasword, docbook:year

Source

<xs:element name="indexterm">
  <xs:complexType>
    <xs:sequence>
      <xs:element minOccurs="0" ref="docbook:primary"/>
      <xs:choice minOccurs="0">
        <xs:sequence>
          <xs:element ref="docbook:secondary"/>
          <xs:choice minOccurs="0">
            <xs:sequence>
              <xs:element ref="docbook:tertiary"/>
              <xs:choice minOccurs="0">
                <xs:element ref="docbook:see"/>
                <xs:element maxOccurs="unbounded" ref="docbook:seealso"/>
              </xs:choice>
            </xs:sequence>
            <xs:element ref="docbook:see"/>
            <xs:element maxOccurs="unbounded" ref="docbook:seealso"/>
          </xs:choice>
        </xs:sequence>
        <xs:element ref="docbook:see"/>
        <xs:element maxOccurs="unbounded" ref="docbook:seealso"/>
      </xs:choice>
    </xs:sequence>
    <xs:attribute name="role"/>
    <xs:attributeGroup ref="docbook:db.common.attributes"/>
    <xs:attributeGroup ref="docbook:db.common.linking.attributes"/>
    <xs:attribute name="significance">
      <xs:simpleType>
        <xs:restriction base="xs:token">
          <xs:enumeration value="normal"/>
          <xs:enumeration value="preferred"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="startref" type="xs:IDREF"/>
    <xs:attribute name="zone" type="xs:IDREFS"/>
    <xs:attribute name="pagenum"/>
    <xs:attribute name="scope">
      <xs:simpleType>
        <xs:restriction base="xs:token">
          <xs:enumeration value="all"/>
          <xs:enumeration value="global"/>
          <xs:enumeration value="local"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="type"/>
    <xs:attribute name="class">
      <xs:simpleType>
        <xs:restriction base="xs:token">
          <xs:enumeration value="singular"/>
          <xs:enumeration value="startofrange"/>
          <xs:enumeration value="endofrange"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
</xs:element>

Sample