Reference. Reference for the DocBook DTD

[Prev] [Next]


XRef

Name

XRef---Cross reference link to another part of the document

Synopsis

Content Model
  EMPTY

Attributes

This element has common and Role attributes.

Name Value(s) Type Default Value
Endterm IDREF #IMPLIED  
Linkend IDREF #REQUIRED  

Tag Minimization

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

Description

Cross reference link to another part of the document. XRef is empty, and has common, Linkend, and Endterm attributes.

Processing Expectations

XRef must have a Linkend, but the Endterm is optional. If it is used, the content of the element it points to is displayed as the text of the cross reference; if it is absent, the XRefLabel of the cross-referenced object is displayed.

Parents

These elements contain XRef: Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Comment, Emphasis, ForeignPhrase, GlossSee, GlossSeeAlso, GlossTerm, LineAnnotation, Link, LiteralLayout, LoTentry, Member, MsgAud, OLink, Para, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Quote, RefEntryTitle, RefPurpose, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SimPara, Subtitle, Synopsis, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, ULink, and entry.

Attributes

Endterm

Endterm holds the ID of an element that contains text and which is to be fetched from elsewhere in the document to appear as the content of this element.

Linkend

ID of target pointed to by this element.

Examples

<SECT1 ID="s1123"><TITLE>A Self-Referential Section</TITLE>
<PARA ID="NONESUCH-7">Any element with an ID value can be linked 
to by a <SGMLTAG ID="stag123" CLASS="attribute">LINKEND</SGMLTAG>, 
including this paragraph.
</PARA>
<PARA>You can refer to that ID Anchor with the EMPTY
element XRef.  The ENDTERM attribute can be used to point to the 
ID of some element to be inserted in the text at the point of the 
XRef.  Thus it is easy to refer to titled objects such as
<XREF LINKEND="NONESUCH-7" ENDTERM="s1123">.
</PARA> 
</SECT1>


[Prev] xref.char.class
[Next] Year
[Reference Home] [Davenport Group Home]