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
Prev		Next

---

Footnote

Name

Footnote -- A footnote

Synopsis

Content Model

Footnote ::=
((CalloutList|GlossList|ItemizedList|OrderedList|SegmentedList|
  SimpleList|VariableList|LiteralLayout|ProgramListing|
  ProgramListingCO|Screen|ScreenCO|ScreenShot|Synopsis|
  CmdSynopsis|FuncSynopsis|FormalPara|Para|SimPara|Address|
  BlockQuote|Graphic|GraphicCO|MediaObject|MediaObjectCO|
  InformalEquation|InformalExample|InformalFigure|InformalTable)+)

Attributes

Common attributes

Name	Type	Default
Label	CDATA	None

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

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

Description

This element is a wrapper around the contents of a footnote.

Additional references to the same footnote may be generated with FootnoteRef.

Processing expectations

The Footnote element usually generates a mark (a superscript symbol or number) at the place in the flow of the document in which it occurs. The body of the footnote is then presented elsewhere, typically at the bottom of the page.

Alternative presentations are also possible. In print environments that do not support footnotes at the bottom of the page, they may be presented as end notes occurring at the end of the component that contains the Footnote. Online systems may choose to present them inline or as "pop-ups," or links, or any combination thereof.

Parents

These elements contain Footnote: 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

The following elements occur in Footnote: Address, BlockQuote, CalloutList, CmdSynopsis, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, InformalEquation, InformalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, MediaObject, MediaObjectCO, OrderedList, Para, ProgramListing, ProgramListingCO, Screen, ScreenCO, ScreenShot, SegmentedList, SimPara, SimpleList, Synopsis, VariableList.

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

In some contexts, the following elements are excluded: InformalTable.

Attributes

Label

Label identifies the desired footnote mark.

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
An annual percentage rate (<abbrev>APR</>) of 13.9%<footnote>
<para>
The prime rate, as published in the <citetitle>Wall Street
Journal</citetitle> on the first business day of the month,
plus 7.0%.
</para>
</footnote>
will be charged on all balances carried forward.
</para>

An annual percentage rate (APR) of 13.9%[1] will be charged on all balances carried forward.

For additional examples, see also FootnoteRef, RefEntry.

Notes

[1]	The prime rate, as published in the Wall Street Journal on the first business day of the month, plus 7.0%.

---

Prev	Home	Next
FirstTerm	Up	FootnoteRef

Back to: DocBook: The Definitive Guide