fn
- A footnote with no given id attribute
is a single-use footnote. Upon output, it generates a number
as a superscript
callout
that is linked to the placement of the footnote, such as at the bottom of the immediate printed page or at the end of an online article. If a character is specified in the callout attribute for the footnote, that character should be used as the superscriptcallout
that is linked to the placement of the footnote. - A footnote entered with an id attribute
is a use-by-reference footnote. Upon output, it does not appear
anywhere unless it has been referenced using an <xref>
with the type attribute set to
fn
. - Ordinarily, a footnote in one topic can't be referenced in another
topic. The previous behaviors are local to each topic. But by using
the conref mechanism, you can create a new copy
of another topic's footnote within the local topic where it will then
follow these behaviors:
- If you use
<fn conref="file.dita#topic/thatid"></fn>all by itself, the result will be the same as the single-use footnote entered literally in the same location. That is, it creates a local copy of the footnote with no local id attribute, so it uses the behavior from the first bullet above. - If you use
<fn conref="file.dita#topic/thatid" id="thisid"></fn>, followed by<xref href="#thistopic/thisid" type="fn"/>, the result will be the same as the use-by-reference model described in the second bullet. That is, the <fn> element creates a local copy of the footnote with an id of "thisid"; that local copy is then referenced by the <xref> element.
- If you use
Note
Contains
Note
| Doctype | Content model |
|---|---|
| topic (base), map (base), classifyMap, subjectScheme, learningBookmap, learningMap | ( text data or dl or fig or imagemap or image or lines or lq or note or hazardstatement or object or ol or p or pre or sl or ul or boolean or cite or keyword or ph or b or i or sup or sub or tt or u or q or term or tm or xref or state or data or data-about or foreign or unknown) (any number) |
| topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap | ( text data or dl or parml or fig or syntaxdiagram or imagemap or image or lines or lq or note or hazardstatement or object or ol or p or pre or codeblock or msgblock or screen or sl or ul or boolean or cite or keyword or apiname or option or parmname or cmdname or msgnum or varname or wintitle or ph or b or i or sup or sub or tt or u or codeph or synph or filepath or msgph or systemoutput or userinput or menucascade or uicontrol or q or term or abbreviated-form or tm or xref or state or data or data-about or foreign or unknown) (any number) |
| machineryTask | ( text data or dl or fig or imagemap or image or lines or lq or note or hazardstatement or object or ol or p or pre or screen or sl or ul or boolean or cite or keyword or wintitle or ph or b or i or sup or sub or tt or u or menucascade or uicontrol or q or term or tm or xref or state or data or data-about or foreign or unknown) (any number) |
| learningAssessment, learningContent, learningOverview, learningPlan, learningSummary | ( text data or dl or fig or imagemap or lcInteractionBase or lcTrueFalse or lcSingleSelect or lcMultipleSelect or lcSequencing or lcMatching or lcHotspot or lcOpenQuestion or image or lines or lq or note or lcInstructornote or object or ol or p or pre or sl or ul or boolean or cite or keyword or ph or b or i or sup or sub or tt or u or q or term or tm or xref or state or data or data-about or foreign or unknown) (any number) |
Contained by
Inheritance
- topic/fn
Example
The first example is of a single-use footnote. It uses a simple fn element, with no ID and no callout attribute. In that case, markup such as the following:
The memory storage capacity of the computer is 2 GB<fn>A GB (gigabyte) is equal to 1000 million bytes</fn> with error correcting support.may produce output similar to the following:
The memory storage capacity of the computer is 2 GB1 with error correcting support.
......
1 A GB (gigabyte) is equal to 1000 million bytes
----- [bottom of page] -----------------------------------------------------------------
The second example is a single-use footnote that uses a callout attribute. It is marked up as follows:
The memory storage capacity of the computer is 2 GB<fn callout="#">A GB (gigabyte) is equal to 1000 million bytes</fn> with error correcting support.That DITA markup may produce output similar to the following:
The memory storage capacity of the computer is 2 GB# with error correcting support.
......
# A GB (gigabyte) is equal to 1000 million bytes
----- [bottom of page] -----------------------------------------------------------------
The third example is a use-by-reference footnote. It uses an ID on a footnote, and then references that ID multiple times. The DITA markup looks like this:
I like pets. <fn id="reuse-fn">This is the name of an animal.</fn> At my house, I have a dog<xref href="#topic/reuse-fn" type="fn"/>, a cat<xref href="#topic/reuse-fn" type="fn"/>, and a llama<xref href="#topic/reuse-fn" type="fn"/>.and may produce output similar to the following:
I like pets. At my house, I have a dog1, a cat1, and a llama1.
......
1This is the name of an animal.
----- [bottom of page] -----------------------------------------------------------------
Attributes
| Name | Description | Data Type | Default Value | Required? |
|---|---|---|---|---|
| callout | Specifies what character is used for the footnote link, for example a number or an alpha character. The attribute may also specify a short string of characters. When no callout value is specified, footnotes are numbered. | CDATA | #IMPLIED | No |
| univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | A set of related attributes, described in univ-atts attribute group | |||
| global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
| class, outputclass | Common attributes described in Other common DITA attributes |