DocBook 5.1: The Definitive Guide  (Version 1.5.3 for DocBook 5.1)

footnote

footnote — A footnote.

Synopsis

footnote ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • label (NMTOKEN)

Additional Constraints

  • footnote must not occur among the children or descendants of footnote
  • example must not occur among the children or descendants of footnote
  • figure must not occur among the children or descendants of footnote
  • table must not occur among the children or descendants of footnote
  • equation must not occur among the children or descendants of footnote
  • sidebar must not occur among the children or descendants of footnote
  • task must not occur among the children or descendants of footnote
  • epigraph must not occur among the children or descendants of footnote
  • caution must not occur among the children or descendants of footnote
  • important must not occur among the children or descendants of footnote
  • note must not occur among the children or descendants of footnote
  • tip must not occur among the children or descendants of footnote
  • warning must not occur among the children or descendants of footnote

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 endnotes 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.

Attributes

Common attributes and common linking attributes.

label

Identifies the desired footnote mark

Parents

These elements contain footnote: abbrev, accel, acronym, address, application, arg, artpagenums, attribution, authorinitials, bibliocoverage, biblioentry, biblioid, bibliomisc, bibliomixed, bibliomset, bibliorelation, biblioset, bibliosource, bridgehead, caption (db.html.caption), citation, citebiblioid, citetitle, city, classname, classsynopsisinfo, code, command, computeroutput, confdates, confnum, confsponsor, conftitle, constant, contractnum, contractsponsor, contrib, country, database, description, edition, email, emphasis (db._emphasis), emphasis (db.emphasis), entry, envar, errorcode, errorname, errortext, errortype, exceptionname, fax, filename, firstname, firstterm (db._firstterm), firstterm (db.firstterm), foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), funcdef, funcparams, funcsynopsisinfo, function, givenname, glosssee, glossseealso, glossterm (db._glossterm), glossterm (db.glossterm), guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, holder, honorific, initializer, interfacename, issuenum, jobtitle, keycap, keycode, keysym, label, lineage, lineannotation, link, literal, literallayout, manvolnum, markup, mathphrase, member, methodname, modifier, mousebutton, msgaud, msglevel, msgorig, olink, option, optional, orgdiv, orgname, otheraddr, othername, package, pagenums, para, paramdef, parameter, personname, phone, phrase (db._phrase), phrase (db.phrase), pob, postcode, primary, primaryie, productname, productnumber, programlisting, prompt, property, publishername, quote (db._quote), quote (db.quote), refdescriptor, refentrytitle, refmiscinfo, refname, refpurpose, releaseinfo, remark, replaceable, returnvalue, revnumber, revremark, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, seriesvolnums, shortaffil, simpara, state, street, subscript, subtitle, superscript, surname, symbol, synopsis, systemitem, tag, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry, token, trademark, type, uri, userinput, varname, volumenum, wordasword, year.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example footnote</title>

<para>An annual percentage rate (<abbrev>APR</abbrev>) 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>

</article>

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


[3] 

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