anchor
Prev  DocBook Element Reference  Next

This is an alpha version of this book.

anchor

Name

anchor — A spot in the document

Synopsis

Content Model

anchor ::=
EMPTY

Attributes

Name

Type

Default
role CDATA None
os CDATA None
xreflabel CDATA None
remap CDATA None
userlevel CDATA None
condition CDATA None
security CDATA None
revisionflag

Enumeration:

added
changed
deleted
off
 None
conformance NMTOKENS None
id ID Required
pagenum CDATA None
vendor CDATA None
arch CDATA None
revision CDATA None

Parameter Entities

The following parameter entities contain anchor:

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; %qandaset.mix; %refcomponent.mix;
%refinline.char.mix; %revdescription.mix; %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, answer, appendix, application, article, attribution, bibliodiv, bibliography, bibliomisc, blockquote, bridgehead, callout, caution, chapter, citation, citetitle, classsynopsisinfo, command, computeroutput, constraintdef, emphasis, entry, firstterm, foreignphrase, funcparams, funcsynopsisinfo, function, glossary, glossdiv, glosssee, glossseealso, glossterm, important, index, indexdiv, label, lineannotation, link, listitem, literal, literallayout, lotentry, manvolnum, member, msgaud, msgexplan, msgtext, note, olink, optional, para, partintro, phrase, preface, primary, primaryie, procedure, productname, programlisting, qandadiv, qandaset, question, quote, refentrytitle, refpurpose, refsect1, refsect2, refsect3, refsynopsisdiv, remark, replaceable, revdescription, 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, term, tertiary, tertiaryie, tip, title, titleabbrev, tocback, tocentry, tocfront, trademark, ulink, userinput, warning, wordasword.

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 XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<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.

Prev  Home  Next
alt  Up  answer

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.