DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

FootnoteRef

Name

FootnoteRef -- A cross reference to a footnote (a footnote mark)

Synopsis

Content Model

FootnoteRef ::=
EMPTY

Attributes

Common attributes

Name

Type

Default

LabelCDATANone
LinkendIDREFRequired

Tag Minimization

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

Parameter Entities

%ndxterm.char.mix;%para.char.mix;%programlisting.content;
%refinline.char.mix;%screen.content;%tbl.entry.mdl;
%title.char.mix;%xref.char.class;

Description

This element forms an IDREF link to a Footnote. It generates the same mark or link as the Footnote to which it points.

In technical documentation, FootnoteRef occurs most frequently in tables.

Processing expectations

The FootnoteRef element usually generates the same mark as the Footnote to which it points, although its mark can be influenced by the Label attribute.

Neither SGML nor XML provide a mechnism (at this time) for asserting that some IDREF links must point to specific classes of elements. If a FootnoteRef points to something other than a Footnote, the parser will not report it as an error. It is an error nonetheless. Processing is undefined.

Parents

These elements contain FootnoteRef: Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Comment, Emphasis, entry, 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.

Children

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

Attributes

Label

Label identifies the desired footnote mark.

Linkend

Linkend points to the Footnote referenced.

Examples

<!DOCTYPE informaltable PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<informaltable>
<tgroup cols=2>
<tbody>
<row>
<entry>foo<footnote id=fnrex1a><para>A meaningless
word</para></footnote></entry>
<entry>3<footnote id=fnrex1b><para>A meaningless
number</para></footnote></entry>
</row>
<row>
<entry>bar<footnoteref linkend=fnrex1a></entry>
<entry>5<footnoteref linkend=fnrex1b></entry>
</row>
</tbody>
</tgroup>
</informaltable>

foo[a]3[b]
bar[a]5[b]
Notes:
a. A meaningless word
b. A meaningless number

PrevHomeNext
FootnoteUpForeignPhrase

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