Whole document tree


www.fifi.org
    Documentation
        Manpages
        GNU Info
        Debian document tree
        Whole document tree
    Trigance web page
    Public services
    User info
    Mailing lists
    Secure server
    Multilingual usage
 

Copyright (C) 2000-2012
Philippe Troin
<webmaster@fifi.org>.

Validate HTML
Validate CSS

    

Whole document tree

IndexTerm
Guide to the DocBook DTD
PrevNext

IndexTerm

Name

IndexTerm -- Character string to be indexed, occurring in the text flow but not in the text itself

Content Model

  (Primary, ((Secondary, ((Tertiary, (See | SeeAlso+)?)
  | See | SeeAlso+)?) | See
  | SeeAlso+)?)
  -(IndexTerm | BeginPage)

Exclusions

IndexTerm excludes these elements at every level:

  IndexTerm | BeginPage

Attributes

This element has common and Role attributes.

NameValue(s)TypeDefault Value
Class(Singular |StartOfRange |EndOfRange)#IMPLIED 
PagenumCDATA#IMPLIED 
Scope(All |Global |Local)#IMPLIED 
Significance(Preferred |Normal) Normal
StartRefIDREF#CONREF 
ZoneIDREFS#IMPLIED 

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Description

Character string to be indexed, occurring in the text flow but not in the text itself. (And remember, IndexTerm appears in the text, not in the Index!) An IndexTerm must begin with a Primary, which may be followed by a Secondary, a See, or any number of SeeAlsos. A Secondary, in turn, may be followed by a Tertiary, a See, or any number of SeeAlsos; and a Tertiary may also be followed by a See or any number of SeeAlsos IndexTerm has common, PageNum, Scope, Significance, Class, StartRef, and Zone attributes.

Class and StartRef can interact: of the values of Class, which are Singular, StartOfRange, and EndOfRange, Singular is the default unless a value for StartRef is supplied, in which case the default is EndOfRange. The StartOfRange value may be supplied when the IndexTerm begins a range of text, so that processing engines can keep track of the range, which ends at the next IndexTerm that refers to the start-of-range IndexTerm by ID as the value of its StartRef attribute.

An IndexTerm for which a StartRef value is supplied must be empty (that is, an IndexTerm that ends a range points to the IndexTerm that begins the range by ID, and does not contain the term to be indexed).

Parents

IndexTerm occurs in ITermSet.

These elements contain IndexTerm at all levels by inclusion.

Appendix, Article, Book, Chapter, Part, PartIntro, Preface, RefEntry, Reference, Sect1, Set, SimpleSect

Children

IndexTerm contains these elements: Primary, Secondary, See, SeeAlso, Tertiary.

Attributes

Pagenum

PageNum is the number of the page on which a given element begins or occurs in a printed book.

Scope

Scope indicates which generated indices the IndexTerm should appear in: Global (whole document set), Local (this document only), or All (both). There is no default.

Significance

Significance indicates whether this IndexTerm is the most pertinent of its series (Preferred) or not (Normal, the default).

Class

Class indicates the type of the IndexTerm. The default is Singular unless the StartRef attribute has a supplied value, in which case the default is EndOfRange.

StartRef

StartRef holds the ID of the IndexTerm that starts the indexing range ended by this IndexTerm.

Zone

Zone holds the IDs of elements to which the IndexTerm applies, and indicates that the IndexTerm applies to those entire elements rather than the point at which the IndexTerm occurs.

Examples

<CHAPTER>
<TITLE>A Chapter About IndexTerms</TITLE>
<PARA>IndexTerm can be an inclusion at the book component level;
an example beginning at the paragraph level won't parse.</PARA>
<PARA>This paragraph deals with two subjects that should
be listed in
the index:  how to rotate your terminal and how to adjust
it.  The information on rotation goes in the index
to the current document; that on adjustment goes in that
index and the index to the document set of which the
current document is a part.
<INDEXTERM SCOPE="local" SIGNIFICANCE="preferred">
<PRIMARY>rotating your terminal
</PRIMARY>
</INDEXTERM>
For the topic of rotation, this is the best place to look
for information, so the 
<SGMLTAG CLASS="attribute">Significance</SGMLTAG> attribute is set to 
&ldquo;Preferred&rdquo;. 
<INDEXTERM>
<PRIMARY>display device
</PRIMARY>
<SEE>terminal
</SEE>
</INDEXTERM>
<INDEXTERM>
<PRIMARY>terminal
</PRIMARY>
<SECONDARY>rotation of
</SECONDARY>
<TERTIARY>side to side
</TERTIARY>
</INDEXTERM>
<INDEXTERM SCOPE="all">
<PRIMARY>terminal
</PRIMARY>
<SECONDARY SORTAS="adjustments">adjustment of
</SECONDARY>
<SEEALSO>troubleshooting
</SEEALSO>
</INDEXTERM>
</PARA>
</CHAPTER>
PrevHomeNext
IndexEntryUpInformalEquation