DocBook: The Definitive GuideBy Norman Walsh & Leonard Muellner1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM |
SeeIE
Synopsis
Mixed Content Model
SeeIE ::= ((#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|Constant|Markup|MediaLabel|MenuChoice|MouseButton| MsgText|Option|Optional|Parameter|Prompt|Property|Replaceable| ReturnValue|SGMLTag|StructField|StructName|Symbol|SystemItem| Token|Type|UserInput|VarName|Anchor|Author|AuthorInitials| CorpAuthor|ModeSpec|OtherCredit|ProductName|ProductNumber| RevHistory|Comment|Subscript|Superscript|InlineGraphic| InlineMediaObject)+)Attributes
Name
Type
Default
Linkend IDREF None Tag Minimization
The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.
Description
SeeIE identifies a "See" cross reference in an IndexEntry. IndexEntrys occur in an Index, not in the flow of the text. They are part of a formatted index, not markers for indexing.
Processing expectations
Formatted as a displayed block. IndexEntrys that include a SeeIE should be formatted normally, with the "See also" indented below the term. There should be no other entries for this term.
SeeIE is usually expected to generate the text, "See."
The Linkend attribute should point to the referenced IndexEntrys, which should be in the same Index. Online systems may use the link information to form a hypertext link.
Future Changes
The InterfaceDefinition element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.
Children
The following elements occur in SeeIE: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, Command, Comment, ComputerOutput, Constant, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, Function, GlossTerm, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, InlineGraphic, InlineMediaObject, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Trademark, Type, ULink, UserInput, VarName, WordAsWord, XRef.
In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.
See Also
IndexEntry, IndexTerm, Primary, PrimaryIE, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, Tertiary, TertiaryIE
Back to: DocBook: The Definitive Guide
© 2001, O'Reilly & Associates, Inc.