DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

Anchor

Name

Anchor -- A spot in the document

Synopsis

Content Model

Anchor ::=
EMPTY

Attributes

Name

Type

Default

RoleCDATANone
OSCDATANone
XRefLabelCDATANone
RemapCDATANone
UserLevelCDATANone
RevisionFlag

Enumeration:

Added
Changed
Deleted
Off

None
ConformanceNMTOKENSNone
IdIDRequired
PagenumCDATANone
VendorCDATANone
ArchCDATANone
RevisionCDATANone

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;%base.char.class;%bookcomponent.content;
%component.mix;%cptr.char.mix;%divcomponent.mix;
%genobj.class;%indexdivcomponent.mix;%ndxterm.char.mix;
%para.char.mix;%programlisting.content;%qandaset.mix;
%refcomponent.mix;%refinline.char.mix;%screen.content;
%sidebar.mix;%tbl.entry.mdl;%title.char.mix;
%word.char.mix;

Description

An anchor identifies a single spot in the content. This may serve as the target for a cross reference, for example, from a Link. The Anchor element may occur almost anywhere.

Anchor has the Role attribute and all of the common attributes except Lang.

Processing expectations

Anchor has no content and generally produces no output. It is a link target.

Parents

These elements contain Anchor: Abbrev, Acronym, Action, Answer, Appendix, Application, Article, Attribution, BiblioDiv, Bibliography, BiblioMisc, BlockQuote, BridgeHead, Callout, Caution, Chapter, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, entry, Filename, FirstTerm, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, Glossary, GlossDiv, GlossSee, GlossSeeAlso, GlossTerm, Hardware, Important, Index, IndexDiv, Interface, InterfaceDefinition, KeyCap, Label, LineAnnotation, Link, ListItem, Literal, LiteralLayout, LoTentry, ManVolNum, Member, MsgAud, MsgExplan, MsgText, Note, OLink, Option, Optional, Para, Parameter, PartIntro, Phrase, Preface, Primary, PrimaryIE, Procedure, ProductName, ProgramListing, Property, QandADiv, QandASet, Question, Quote, RefEntryTitle, RefPurpose, RefSect1, RefSect2, RefSect3, RefSynopsisDiv, Replaceable, Screen, ScreenInfo, Secondary, SecondaryIE, Sect1, Sect2, Sect3, Sect4, Sect5, Section, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SetIndex, Sidebar, SimPara, SimpleSect, Step, Subscript, Subtitle, Superscript, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Tip, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput, Warning, WordAsWord.

Children

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

Attributes

Pagenum

PageNum indicates the page on which the anchor occurs in some printed version of the document.

The PageNum attribute does not influence the pagination or page numbering of an SGML application processing the document; it is informative, not declarative.

See Also

Link, OLink, ULink, XRef

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
The anchor element<anchor id="example.anchor.1"> is empty and contributes
nothing to the flow of the content in which it occurs.  It is only useful
as a target.
</para>

The anchor element is empty and contributes nothing to the flow of the content in which it occurs. It is only useful as a target.

PrevHomeNext
AltUpAnswer

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.