[Prev] [Next]

See

Name

Synopsis

  (#PCDATA | FootnoteRef | XRef | Abbrev | Acronym | Citation
  | CiteRefEntry | CiteTitle | Emphasis | FirstTerm
  | ForeignPhrase | GlossTerm | Footnote | Phrase | Quote
  | Trademark | WordAsWord | Link | OLink | ULink | Action
  | Application | ClassName | Command | ComputerOutput
  | Database | Email | EnVar | ErrorCode | ErrorName
  | ErrorType | Filename | Function | GUIButton | GUIIcon
  | GUILabel | GUIMenu | GUIMenuItem | GUISubmenu | Hardware
  | Interface | InterfaceDefinition | KeyCap | KeyCode
  | KeyCombo | KeySym | Literal | Markup | MediaLabel
  | MenuChoice | MouseButton | MsgText | Option | Optional
  | Parameter | Prompt | Property | Replaceable | ReturnValue
  | SGMLTag | StructField | StructName | Symbol | SystemItem
  | Token | Type | UserInput | Anchor | Author | AuthorInitials
  | CorpAuthor | ModeSpec | OtherCredit | ProductName
  | ProductNumber | RevHistory | Comment | Subscript
  | Superscript
  | InlineGraphic)+

Attributes

This element has common and Role attributes.

Tag Minimization

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

Description

Part of IndexTerm, indicating, for a word or phrase in the text, the index entry to which the reader is to be directed when he consults the stub index entry for another element within the IndexTerm. See must be nested within IndexTerm tags and must follow a Primary or Secondary element. It may contain in-line elements, and has common attributes.

Parents

See occurs in IndexTerm.

Children

See contains these elements: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, Command, Comment, ComputerOutput, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, GlossTerm, Hardware, InlineGraphic, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, #PCDATA, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Trademark, Type, ULink, UserInput, WordAsWord, and XRef.

In some contexts, some of these elements may be invalid due to exclusions in parent elements.

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>

[Prev] sect.title.content
[Next] SeeAlso
[Reference Home] [Davenport Group Home]