DocBook: The Definitive Guide

docbook: the definitive guide
By Norman Walsh & Leonard Muellner
1st Edition October 1999
1-56592-580-7, Order Number: 5807
652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
PrevNext

Name

IndexTerm -- A wrapper for terms to be indexed

Synopsis

Content Model

IndexTerm ::= (Primary,  ((Secondary,    ((Tertiary,      (See|SeeAlso+)?)|     See|SeeAlso+)?)|   See|SeeAlso+)?)

Attributes

Common attributes

Name

Type

Default

Significance

Enumeration:

Normal
Preferred

"Normal"
StartRefIDREFContent reference
PagenumCDATANone
Class

Enumeration:

EndOfRange
Singular
StartOfRange

None
Scope

Enumeration:

All
Global
Local

None
ZoneIDREFSNone

Tag Minimization

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

Parameter Entities

%admon.mix;%bibliocomponent.mix;%bookcomponent.content;
%component.mix;%cptr.char.mix;%divcomponent.mix;
%docinfo.char.mix;%example.mix;%figure.mix;
%glossdef.mix;%highlights.exclusion;%highlights.mix;
%legalnotice.mix;%ndxterm.class;%ndxterm.exclusion;
%para.char.mix;%programlisting.content;%qandaset.mix;
%refcomponent.mix;%refinline.char.mix;%screen.content;
%sidebar.mix;%smallcptr.char.mix;%tbl.entry.mdl;
%tbl.table.mdl;%title.char.mix;%ubiq.exclusion;
%ubiq.inclusion;%ubiq.mix;%word.char.mix;

Description

IndexTerms identify text that is to be placed in the index. In the simplest case, the placement of the IndexTerm in the document identifies the location of the term in the text. In other words, the IndexTerm is placed in the flow of the document at the point where the IndexEntry in the Index should point. In other cases, attributes on IndexTerm are used to identify the location of the term in the text.

IndexTerms mark either a single point in the document or a range. A single point is marked with an IndexTerm placed in the text at the point of reference. There are two ways to identify a range of text:

Processing expectations

IndexTerms are suppressed in the primary text flow, although they contribute to the population of an index and serve as anchors for cross references. Under no circumstances is the actual content of IndexTerm rendered in the primary flow.

It is possible to construct index terms that are difficult to parse at best and totally illogical at worst. Consider the following:

<indexterm class=startofrange zone="id1 id2">...</indexterm>

There is no way that this can fit into the semantics of an IndexTerm. Although it claims to be the start of a range, it does not have an ID for the end-of-range IndexTerm to point back to. In addition, it includes zoned terms, and mixing the two different methods for indicating a range in the same IndexTerm is probably a bad idea.

Parents

These elements contain IndexTerm: Abbrev, Accel, Ackno, Acronym, Action, Answer, Appendix, Application, ArtHeader, Article, ArtPageNums, Attribution, AuthorInitials, BiblioDiv, BiblioEntry, Bibliography, BiblioMisc, BiblioMixed, BiblioMSet, BiblioSet, BlockQuote, BookBiblio, BookInfo, BridgeHead, Callout, Caution, Chapter, Citation, CiteTitle, City, ClassName, CollabName, Command, Comment, ComputerOutput, ConfDates, ConfNum, ConfSponsor, ConfTitle, Constant, ContractNum, ContractSponsor, Contrib, CorpAuthor, CorpName, Country, Database, Date, Dedication, DocInfo, Edition, Email, Emphasis, entry, EnVar, ErrorCode, ErrorName, ErrorType, Example, Fax, Figure, Filename, FirstName, FirstTerm, ForeignPhrase, FormalPara, FuncParams, FuncSynopsisInfo, Function, Glossary, GlossDef, GlossDiv, GlossEntry, GlossSee, GlossSeeAlso, GlossTerm, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, Highlights, Holder, Honorific, Important, Index, InformalExample, InformalFigure, Interface, InterfaceDefinition, InvPartNumber, ISBN, ISSN, IssueNum, ITermSet, JobTitle, KeyCap, KeyCode, KeySym, Label, LegalNotice, Lineage, LineAnnotation, Link, ListItem, Literal, LiteralLayout, LoTentry, ManVolNum, Markup, MediaLabel, Member, ModeSpec, MouseButton, MsgAud, MsgExplan, MsgLevel, MsgOrig, MsgText, Note, ObjectInfo, OLink, Option, Optional, OrgDiv, OrgName, OtherAddr, OtherName, PageNums, Para, Parameter, PartIntro, Phone, Phrase, POB, Postcode, Preface, Procedure, ProductName, ProductNumber, ProgramListing, Prompt, Property, PubDate, PublisherName, PubsNumber, QandADiv, QandASet, Question, Quote, RefEntryTitle, RefMiscInfo, RefPurpose, RefSect1, RefSect1Info, RefSect2, RefSect2Info, RefSect3, RefSect3Info, RefSynopsisDiv, RefSynopsisDivInfo, ReleaseInfo, ReturnValue, RevNumber, RevRemark, Screen, ScreenInfo, Sect1, Sect1Info, Sect2, Sect2Info, Sect3, Sect3Info, Sect4, Sect4Info, Sect5, Sect5Info, Section, SectionInfo, Seg, SegTitle, SeriesInfo, SeriesVolNums, SetIndex, SetInfo, SGMLTag, ShortAffil, Sidebar, SimPara, SimpleSect, State, Step, Street, StructField, StructName, Subtitle, Surname, Symbol, Synopsis, SystemItem, Table, Term, Tip, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Token, Type, ULink, UserInput, VarName, VolumeNum, Warning, WordAsWord, Year.

Children

The following elements occur in IndexTerm: Primary, Secondary, See, SeeAlso, Tertiary.

Attributes

Class

Class identifies the type of IndexTerm. If StartRef is supplied, the default for Class is EndOfRange, otherwise it is Singular.

Pagenum

PageNum indicates the page on which this index term occurs in some version of the printed document.

Scope

Scope identifies in which indexes the IndexTerm should appear. Global means the index for the whole collection of documents, Local means the index for this document only, and All means both indexes.

Significance

Significance specifies whether or not this IndexTerm is considered the most important location for information about the terms being indexed. Generally, Preferred IndexTerms get special typographic treatment in the Index.

StartRef

The use of StartRef implies a spanning index entry. StartRef is used on the term that defines the end of the span and points to the term which defines the beginning.

Zone

The use of Zone implies a spanning index entry. Zone holds the IDs of the elements to which it applies. The IndexTerm applies to the contents of the entire element(s) to which it points. If Zone is used, the phyiscal placement of the IndexTerm in the flow of the document is irrelavant.

See Also

IndexEntry, Primary, PrimaryIE, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Tertiary, TertiaryIE

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <para> The Tiger<indexterm> <primary>Big Cats</primary> <secondary>Tigers</secondary></indexterm> is a very large cat indeed. </para>

The Tiger is a very large cat indeed.

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <chapter><title>Example Chapter</title> <!-- index term for "Example Chapter" is a span --> <indexterm  class=startofrange>   <primary>Example Chapter</primary></indexterm> <!-- index term for "Example Chapter" also cross references the       "Examples" entry in the index --> <indexterm><primary>Example Chapter</primary>   <seealso>Examples</seealso></indexterm> <!-- index term for "Chapter, Example" refers the reader to the entry      under which the index term is actually listed, "Example Chapter" --> <indexterm><primary>Chapter</primary><secondary>Example</secondary>   <see>Example Chapter</see></indexterm> <!-- other content --> <!-- index term, end of "Example Chapter" span --> <indexterm startref="idxexchap" class=endofrange> <para>some content</para> </chapter>

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <chapter><title>Example Chapter</title> <indexterm zone="a1"><primary>Network Configuration</primary></indexterm> <!-- other content here --> <sect1 id=a1><title>Configuring Your Network</title> <para>&hellip;</para> </sect1> </chapter>

For additional examples, see also Chapter.


PrevHomeNext
IndexEntryUpInformalEquation

Back to: DocBook: The Definitive Guide


O'Reilly Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts
International | About O'Reilly | Affiliated Companies

© 1999, O'Reilly & Associates, Inc.



DocBook. The Definitive Guide
DocBook 5: The Definitive Guide
ISBN: 0596805020
EAN: 2147483647
Year: 1999
Pages: 412
Authors: Walsh Norman, Richard L. Hamilton
BUY ON AMAZON

Similar book on Amazon
DocBook XSL: The Complete Guide (4th Edition)
DocBook XSL: The Complete Guide (4th Edition)
XSLT, 2nd Edition
XSLT, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XML: Visual QuickStart Guide (2nd Edition)
XML: Visual QuickStart Guide (2nd Edition)

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net