Footnotes

Footnote / Endnote Container

Footnotes are entered inline within the main scripture body text. The boundaries of the footnote text are defined by an opening and closing marker. The individual elements which make up the note content are described under the heading Footnote Content Elements below.

\f ...\f*

Syntax:\f_+_(\fr_REF_)footnote content\f*
Type:note
Added:1.0
Use:Beginning and ending of the footnote element.

+

  • The footnote caller, which may be one of the following three types:

    + – indicates that the caller should be generated automatically by the translation editor, or publishing tools.
    - – indicates that no caller should be generated, and is not used.
    ? – where ? represents the character to be used for the caller. The caller is defined for the specific note by the author.

footnote content (see below)

  • All of the text elements which make up the footnote:

    • origin reference
    • special footnote elements such as keywords, quotations, alternate renderings etc.
    • footnote text
  • Each element should be prefixed by the appropriate marker (listed below).

Note

Important: See Syntax Notes for addition information on the use of endmarkers for elements within footnote content.

\fe ...\fe*

Syntax:\f_+_(\fr_REF_)footnote content\f*
Type:note
Added:1.0
Use:Beginning and ending of the footnote element.

Footnote Content Elements

The following markup can be included as part of the footnote content:

\fr

Syntax:\fr_##SEP##
Type:character (note)
Added:1.0
Use:Footnote origin reference.
This is the chapter and verse(s) that note refers to.
SEP indicates where the appropriate chapter/verse separator should be used (i.e. colon ”:”, full stop ”.” etc.)

\fq

Syntax:\fq_text...
Type:character (note)
Added:1.0
Use:Footnote translation quotation.
A quotation from the current scripture text translation for which the note is being provided.
Longer quotations are sometimes shortened using an ellipsis (i.e. suspension dots ”...”).

Note

Many existing translation texts have marked both quotations from the existing translation text, as well as alternative translations, using fq. An additional marker – \fqa – is provided for marking alternative translations, and can be used to distinguish between quotations and alternatives.

Text and Formatting Samples - Quotations and Alternative Translations - Mark 1.1; 1.4 (GNT)

\s1 The Preaching of John the Baptist
\r (Matthew 3.1-12; Luke 3.1-18; John 1.19-28)
\p
\v 1 This is the Good News about Jesus Christ, the Son of God. \f + \fr 1.1: \ft Some
manuscripts do not have \fq the Son of God.\f*
...

Footnotes

../_images/usfm-character_fq.jpg

Footnote caller in body text

../_images/usfm-character_fq-call.jpg

\fqa

Syntax:\fqa_text...
Type:character (note)
Added:1.0
Use:Footnote alternate translation.
Used to distinguish between a quotation of the current scripture text translation, and an alternate translation.

\fk

Syntax:\fk_text...
Type:character (note)
Added:1.0
Use:Footnote keyword.
The specific keyword/term from the text for which the footnote is being provided.

Text and Formatting Sample - Genesis 3.20 (GNT)

\p
\v 20 Adam \f + \fr 3.20: \fk Adam: \ft This name in Hebrew means “all human beings.”\f*
named his wife Eve, \f + \fr 3.20: \fk Eve: \ft This name sounds similar to the Hebrew
word for “living,” which is rendered in this context as “human beings.”\f* because she
was the mother of all human beings.
\v 21 And the \nd Lord\nd* God made clothes out of animal skins for Adam and his wife,
and he clothed them.
../_images/usfm-character_fk.jpg

\fl

Syntax:\fl_text...
Type:character (note)
Added:2.03
Use:Footnote label text.
Can be used for marking or “labeling” a word or words which are used consistently across certain types of translation notes (such as the words “Or” in an alternative translation note, “Others”, “Heb.”, “LXX” etc.).

\fp

Syntax:\fp_text...
Type:character (note)
Added:2.03
Use:Footnote additional paragraph.
Use this marker to if you need to indicate the start of a new paragraph within a footnote (uncommon).

\fv ...\fv*

Syntax:\fv_##\fv*
Type:character (note)
Added:1.0
Use:Footnote verse number.
Use this marker to if you need to indicate the start of a new paragraph within a footnote (uncommon).

Note

This marker will typically be nested within another footnote content element, like \ft, \fq or \fqa. See Nesting Character Markup for details.

Text and Formatting Sample - John 7.38 (GNT)

\p
\v 37 On the last and most important day of the festival Jesus stood up and said in a
loud voice, “Whoever is thirsty should come to me, and
\v 38 whoever believes in me should drink. As the scripture says, ‘Streams of life-
giving water will pour out from his side.’” \f + \fr 7.38: \ft Jesus' words in verses
37-38 may be translated: \fqa “Whoever is thirsty should come to me and drink.
\fv 38\fv* As the scripture says, ‘Streams of life-giving water will pour out from
within anyone who believes in me.’”\f*
../_images/usfm-character_fv.jpg

\ft

Syntax:\ft_text...
Type:character (note)
Added:1.0
Use:Footnote text.
The essential (explanatory) text of the footnote.

\fdc ...\fdc*

Syntax:\fdc_text...\fdc*
Type:character (note)
Added:1.0
Deprecated:3.0 usfm3.0
Use:Footnote Deuterocanonical content.
Text between these markers is material to be included only in published editions that contain the Deuterocanonical books.
Deprecated (i.e. use is discouraged).

ico_Cg Recommended alternate: General purpose use of \dc ...\dc* or nested \+dc ...\+dc* wherever DC-only content is being marked.

Text and Formatting Sample - Hebrews 1.3 (Spanish DHE)

\v 3 Él es el resplandor glorioso de Dios,\f c \fr 1.3: \fk Resplandor: \ft Cf.
Jn 1.4-9,14\fdc ; también Sab 7.25-26, donde algo parecido se dice de la sabiduría.\f*
la imagen misma de lo que Dios es y el que sostiene todas las cosas con su palabra
poderosa. Después de limpiarnos de nuestros pecados, se ha sentado en el cielo, a la
derecha del trono de Dios,
\v 4 y ha llegado a ser superior a los ángeles, pues ha recibido en herencia un título
mucho más importante que el de ellos.

\fm ...\fm*

Syntax:\fm_text...\fm*
Type:character (note)
Added:1.0
Use:Footnote reference mark.
Used where two or more locations in the scripture text should ideally refer the reader to the same footnote text (as seen in identical footnote text which is referenced at Gen 2.9 and Gen 2.17 in some translations).

Warning

Because the nature of this marker is related directly to the published form of the text, it is not intended for use in scripture authoring. It may be used during the publishing process to connect two callers to the same footnote text.