footnote

footnote — A footnote

Synopsis

footnote ::=

One or more of:
- annotation
- bridgehead
- remark
- revhistory
- Indexing inlines
  indexterm (db.indexterm.endofrange)
  
  indexterm (db.indexterm.singular)
  
  indexterm (db.indexterm.startofrange)
- Admonition elements
  caution
  
  important
  
  note
  
  tip
  
  warning
- Formal elements
  equation
  
  example
  
  figure
  
  table (db.cals.table)
  
  table (db.html.table)
- Graphic elements
  mediaobject
  
  screenshot
- HTML Form elements
  html:form
- Informal elements
  informalequation
  
  informalexample
  
  informalfigure
  
  informaltable (db.cals.informaltable)
  
  informaltable (db.html.informaltable)
- List elements
  bibliolist
  
  calloutlist
  
  glosslist
  
  itemizedlist
  
  orderedlist
  
  procedure
  
  qandaset
  
  segmentedlist
  
  simplelist
  
  variablelist
- Paragraph elements
  anchor
  
  formalpara
  
  para
  
  simpara
- Publishing elements
  address
  
  blockquote
  
  epigraph
  
  sidebar
- Synopsis elements
  classsynopsis
  
  cmdsynopsis
  
  constructorsynopsis
  
  destructorsynopsis
  
  fieldsynopsis
  
  funcsynopsis
  
  methodsynopsis
- Technical elements
  constraintdef
  
  msgset
  
  procedure
  
  productionset
  
  task
- Verbatim elements
  literallayout
  
  programlisting
  
  programlistingco
  
  screen
  
  screenco
  
  synopsis

Attributes

Common attributes and common linking attributes.

Additional attributes:

label (NMTOKEN)

Additional Constraints

footnote must not occur in the descendants of footnote
example must not occur in the descendants of footnote
figure must not occur in the descendants of footnote
table must not occur in the descendants of footnote
equation must not occur in the descendants of footnote
indexterm must not occur in the descendants of footnote
sidebar must not occur in the descendants of footnote
task must not occur in the descendants of footnote
epigraph must not occur in the descendants of footnote
caution must not occur in the descendants of footnote
important must not occur in the descendants of footnote
note must not occur in the descendants of footnote
tip must not occur in the descendants of footnote
warning must not occur in the 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 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.

Attributes

Common attributes and common linking attributes.

label: Identifies the desired footnote mark

Parents

These elements contain footnote: biblioentry, bibliomixed, bibliomset, biblioset, bridgehead, caption (db.html.caption), citation, citetitle, classsynopsisinfo, emphasis (db.emphasis), entry, firstterm, foreignphrase, funcsynopsisinfo, glosssee, glossseealso, glossterm, html:button, html:label, html:legend, link, literallayout, member, olink, orgdiv, para, phrase (db.phrase), primary, primaryie, programlisting, quote, refdescriptor, refentrytitle, refname, refpurpose, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry.

Children

The following elements occur in footnote: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, destructorsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glosslist, html:form, 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, mediaobject, methodsynopsis, msgset, note, orderedlist, 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, variablelist, warning.

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%^[4] will be charged on all balances carried forward.

ChangeLog

This alpha reference page is $Revision: 7120 $ published Sun, 22 Jul 2007.

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


firstterm		footnoteref