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

SeeAlsoIE -- A "See also" entry in an index, rather than in the text

Synopsis

Mixed Content Model

SeeAlsoIE ::= ((#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

Common attributes

Name

Type

Default

LinkendsIDREFSNone

Tag Minimization

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

Description

SeeAlsoIE identifies a "See also" 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 SeeAlsoIE should be formatted normally, with the "See also" indented below the term.

SeeAlsoIE is usually expected to generate the text "See Also".

The Linkends attribute should point other IndexEntrys in the same Index. Online systems may use them to form hypertext links.

(4.0) 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.

Parents

These elements contain SeeAlsoIE: IndexEntry.

Children

The following elements occur in SeeAlsoIE: 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.

Attributes

Linkends

Linkends points to a the related IndexEntrys.

See Also

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

Examples

For examples, see Index.


PrevHomeNext
SeeAlsoUpSeeIE

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