Footnote and Endnote Elements

Syntax notes.

Footnote and Endnote Syntax

\f * Footnote

Footnotes are built in the following way:

\f_footnotes caller_footnote content\f*

They consist of these four parts:

1. \f: (initial marker) starts the footnote.

2. footnote caller: may be one of these three:

* + means that the caller is generated automatically, eg. progressive letters or numbers.

* - means no caller is generated.

* * means any character, where * represents the character to be used as the caller – defined by the user.

3. footnote content:

* Everything that is part of the footnote.

* This will contain the footnote text, reference, and any additional footnote elements (keywords, quotations etc.)

* Each element should be prefixed by the relevant back-slash code listed below.

4. \f*: (final marker) ends the footnote

\fe * Endnote

Endnotes are built in the same way as footnotes:

\fe_endnotes caller_endnote content\fe*

See the f marker above for explanation.

\fm * Footnote Mark

\fm_...\fm*_

* Footnote mark.

* Used in a situation where two or more points in the text need to refer to the same footnote as seen in Gen 2.9 and Gen 2.17.

* Important: Not to be used in scripture authoring. Intended for use during the publishing process.

Example of use (Gen 2.9 and 2.17):

\v 9 He made all kinds of beautiful trees grow there and produce good fruit.
In the middle of the garden stood the tree that gives life and the tree that
gives knowledge of what is good and what is bad. \f i \fr 2.9: \fq knowledge
of what is good and what is bad; \ft or \fq knowledge of everything.\f*

and later in the file

\v 17 except the tree that gives knowledge of what is good and what is
bad. \fm i \fm* You must not eat the fruit of that tree; if you do, you will
die the same day.?

* When markers have not been predefined (i.e. when the \f + format is being used), reference footnote text used earlier in the current book by specifying chapter and verse.

\v 17 except the tree that gives knowledge of what is good and what is
bad. \fm 2.9 \fm* You must not eat the fruit of that tree; if you do, you will
die the same day.?

Footnote Content Elements

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

\fr (*) Reference

\fr_##.##

* Footnote reference.

* The chapter and verse(s) that note refers to.

\fk (*) Keyword

\fk_

* Footnote keyword.

* The specified word(s) for which the footnote is being provided.

\fq (*) Quotation

\fq_

* Quotation from the scripture text.

* The current and/or alternative translations of a portion of the scripture text.

\fqa (*) Alternative translation

\fqa_

* Alternative translation.

* To be used when it is preferable to distinguish between a quotation of the current translation of the scripture text, and an alternative translation (instead of using \fq for marking both of these elements).

\fl (*) Labelled Text

\fl_

* A footnote label text item.

* For marking or "labelling" a word or words which are used consistently across certain types of translation notes (such as the words "Or" in an alternate translation note, "Others", "Heb.", "LXX" etc.).

\fp (*) Additional Paragraph

\fp_

* A footnote additional paragraph marker.

* Use this marker to indicate the start of a new paragraph within a footnote.

* In order to display a new line (in Paratext formatted view) before the start of a new footnote paragraph, add a soft-return before the \fp marker.

\fv (*) Verse in Text

\fv_

* Footnote verse number.

* A verse number in the the text being quoted in the footnote.

\ft (*) Text

\ft_

* Footnote text.

* The (explanatory) text of the footnote.

\fdc * Apocrypha

\fdc_...\fdc*_

* Text between these markers is material to be included only in editions that contain the Apocrypha.

Examples of use

Example showing the caller within the body text (TEV Mrk 6.37):

\p
\v 37 ?You yourselves give them something to eat,?
Jesus answered.
\p They asked, ?Do you want us to go and spend two hundred
silver coins \f j \fr 6.37: \fk silver coins: \ft A silver
coin was the daily wage of a rural worker (see Mt 20.2).\f*
on bread in order to feed them??

Examples showing the footnote text (1Ch 4.9 ; Mrk 1.1; Mrk 6.11):

\p
\v 9 There was a man named Jabez, who was the most respected
member of his family. His mother had given him the name Jabez,
\f i \fr 4.9: \fk jabez: \ft This name sounds like the Hebrew
for ?pain.?\f* because his birth had been very painful.
c 1
\s 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 a \fr 1.1: \ft Some manuscripts do not have \fq the Son
of God.\f*
\q1
\v 11 Give us today the food we need. \f c \fr 6.11: \fq we
need; \ft or \fq for today, \ft or \fq for tomorrow.\f*
\q1
\v 12 Forgive us the wrongs we have done,
\q2 as we forgive the wrongs that others have done to us.

Nesting

By default footnote codes are not nested (i.e. they are not embedded within each other). The use of each new code cancels out the 'environment' of the previous. However, an alternative markup may be used requiring each internal marker to be explicitly closed (e.g. \f + \fk...\fk*...\f*.). The examples below include variants which use the "nested", and "non-nested" approach. The \ft code is used in the non-nested markup to indicate a return to normal explanatory footnote text. If the nested approach is used, each code must be explicitly closed, and the unmarked text within \f ..\f* is assumed to be normal footnote text.

Additional examples of use (A=non-nested variant, B=nested variant):

\f + Please refer to the illustration in Gen 1.\f*
\f + Some manuscripts do not include John 8:1-20.\f*
\f + \fk Issac:\ft In Hebrew means "laughter"\f*
\f + \fk Issac:\fk* In Hebrew means "laughter"\f*
\f + \fq Feast of the Unleavened Bread:\ft please refer to the explanation
in the glossary\f*
\f + \fq Feast of the Unleavened Bread:\fq* please refer to the explanation
in the glossary\f*
\f + \fq In the beginning\ft or \fq While God began\f*
\f + \fq In the beginning\fq* or \fq While God began\fq*\f*

Gen 1:14

\f + \fr 1.14 \fq religious festivals;\ft or \fq seasons.\f*
\f + \fr 1.14\fr* \fq religious festivals;\fq* or \fq seasons.\fq*\f*

Gen 2:4

\f + \fr 2.4 \fk The \nd Lord\nd*: \ft See \nd Lord\nd* in Word List.\f*
\f + \fr 2.4\fr* \fk The \nd Lord\nd*:\fk* See \nd Lord\nd* in Word List.\f*

Gen 3:20

\f + \fr 3.20 \fk Adam: \ft This name in Hebrew means "humanity".\f*
\f + \fr 3.20\fr* \fk Adam:\fk* This name in Hebrew means "humanity".\f*

Gen 10:14

\f + \fr 10.14 \ft Probable text \fq and of Crete...descended; \ft Hebrew \fq from
whom the Philistines are descended, and Crete.\f*
\f + \fr 10.14\fr* Probable text \fq and of Crete...descended;\fq* Hebrew \fq from
whom the Philistines are descended, and Crete.\fq*\f*