footnote
footnote — A footnote.
Synopsis
footnote ::=
- One or more of:
annotation
bridgehead
formalgroup
remark
revhistory
- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequation
informalexample
informalfigure
informaltable
(db.cals.informaltable)informaltable
(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
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
- danger 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.
- any attribute
Any attribute in any other explicit namespace
- 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
, buildtarget
, 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
, enumidentifier
, enumitemdescription
, enumname
, enumvalue
, 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
, macroname
, manvolnum
, markup
, mathphrase
, member
, meta
(db.meta.content), 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
, specializedtemplate
, state
, street
, subscript
, subtitle
, superscript
, surname
, symbol
, synopsis
, synopsisinfo
, systemitem
, tag
, td
, template
, templatename
, term
, termdef
, tertiary
, tertiaryie
, th
, title
, titleabbrev
, tocentry
, token
, trademark
, type
, typedefname
, unionname
, uri
, userinput
, varname
, volumenum
, wordasword
, year
.
Children
The following elements occur in footnote
: address
, anchor
, annotation
, bibliolist
, blockquote
, bridgehead
, calloutlist
, caution
, classsynopsis
, cmdsynopsis
, constraintdef
, constructorsynopsis
, danger
, destructorsynopsis
, enumsynopsis
, epigraph
, equation
, example
, fieldsynopsis
, figure
, formalgroup
, formalpara
, funcsynopsis
, glosslist
, important
, indexterm
(db.indexterm.endofrange), indexterm
(db.indexterm.singular), indexterm
(db.indexterm.startofrange), informalequation
, informalexample
, informalfigure
, informaltable
(db.cals.informaltable), informaltable
(db.html.informaltable), itemizedlist
, literallayout
, macrosynopsis
, mediaobject
, methodsynopsis
, msgset
, note
, orderedlist
, packagesynopsis
, para
, procedure
, productionset
, programlisting
, programlistingco
, qandaset
, remark
, revhistory
, screen
, screenco
, screenshot
, segmentedlist
, sidebar
, simpara
, simplelist
, synopsis
, table
(db.cals.table), table
(db.html.table), task
, tip
, typedefsynopsis
, unionsynopsis
, variablelist
, warning
.
Examples
1 |<article xmlns='http://docbook.org/ns/docbook'>
|<title>Example footnote</title>
||
<para>An annual percentage rate (<abbrev>APR</abbrev>) of 13.9%<footnote>
5 |<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>
10 |will be charged on all balances carried forward.
|</para>
||
</article>
An annual percentage rate (APR) of 13.9%1 will be charged on all balances carried forward.