Help:Footnotes and endnotes

Introduction to Wikisource's presentation style

English Wikisource has many works with footnotes or endnotes, commonly also known as references. Whether the work is a book, a document, a press release, or the many other available types of work, they can contain these notes, in a myriad of styles utilised by publishers through the ages in the placement of these notes, their style, or, their presentation, in whatever the published work. So in tune with the general guidance in our style guide there is a general means to present notes in our works.

Wikisource remains true to the publishing of these notes from works, however, due to metamorphosis of these works to the web, and the mediawiki platform that we utilise, we do not present footnotes on basis of per page of the original work. Wikisource instead aims to present these notes as endnotes at the end of the presented pages—work or subpage of the work. As part of this approach, and from our experience, there is both a need and a wish to standardise the presentation of the style of endnotes, rather than replicate the styles utilised by each publisher at that time of original publication.

If the work only uses special symbols in one symbol set, the house style is to instead use incremental numbers.

Types of footnote

In publishing there are, and have been, various methods of printing notes: either as notes at the bottom of the page, or aggregated at the end of a chapter or section. Sometimes all notes are accumulated as lists at the end of the book.

Footnotes are often indicated by numbers or typographical symbols: such as the section §, the Pilcrow or paragraph mark ¶, the single and double daggers † ‡, and the asterisk *.

Adding footnotes

On Wikisource all footnotes should be implemented with <ref> tags. These can be automatically collected and listed by another tag at the bottom of the page: either <references/> {{reflist}} or {{smallrefs}}.

Footnotes

Instead of putting the footnote text at the bottom of the page, it should be placed immediately following the noted text (ie. where the note indicator is in the text) wrapped in <ref> ... </ref> tags.

For example, if the printed page contains the following text:

And here it is doubtless thought by some, as it is in France by M. de Lagevenais, that Government, by supplying good music, should exclude the bad, such as that of Offenbach.⁴

For which the accompanying footnote at the base of the page is:

⁴ Revue des Deux Mondes, February 15, 1872.

When rendering this into wikitext while proofreading, it should look like:

And here it is doubtless thought by some, as it is in France by M. de Lagevenais, that Government, by supplying good music, should exclude the bad, such as that of Offenbach.<ref>''Revue des Deux Mondes'', February 15, 1872.</ref>

Once saved, this will appear as:

And here it is doubtless thought by some, as it is in France by M. de Lagevenais, that Government, by supplying good music, should exclude the bad, such as that of Offenbach.^[1]

For reference: this example is based on Page:Popular Science Monthly Volume 1.djvu/13; which can be seen as part of "The Study of Sociology I," an article published in Popular Science Monthly in May 1872.

Displaying the footnotes

The most basic way of displaying footnotes is with the <references/> tag. This should be placed:

1. At the bottom of the page in the main namespace, immediately after the transcluded text and before the categories and other footer items.
2. In the "footer" field of each page in the Page namespace that contains footnotes. By default, all index pages automatically add this footer but this can be overridden manually at the index page.

This tag will automatically create a numbered list of all items in <ref> tags on the page. It does not matter if the tagged text has been directly written into the page by editing or if it has been transcluded from the Page namespace. The list will be sorted in the order the footnotes exist on the page (ie. first footnote is number 1, second footnote is number 2, etc).

Using the example above:

Wikitext	<references/>
Appearance	Revue des Deux Mondes, February 15, 1872.

Optionally, instead of the <references/> tag, one of the following templates may be used instead:

• {{reflist}}
• {{smallrefs}}

Endnotes

If the original work put the notes at the end of the section or chapter and the full section or chapter will be transcluded into one subpage in the main namespace: use the method described above.

If the original work put the notes in a separate section, for example, collecting all footnotes for all chapters in one section or appendix at the back of the book, either:

1. Ignore the formatting of the original work and include all footnotes at the bottom of the section or chapter as described in the method above.
2. Create a separate subpage for the endnote section. See Alternatives for possible ways to link between note indicator and the footnote itself.

In some cases it is possible to turn endnotes into footnotes by using the advanced functionality described below at #Footnotes that continue over page breaks.

Advanced

Footnotes that continue over page breaks

See also: Help:Page breaks

In some works, footnotes can continue on to the next page and, in some cases, one or more pages beyond that. When proofreading individual pages in the Page namespace, this will be impossible to handle using the basic method described above.

When using the <ref> tags for the first part of the footnote, add the "name" parameter. The name used can be chosen by the individual proofreader but it is best practice to use the page number.

Other parts of the footnote should use the "follow" parameter with the same name. The position of this text does not matter to the footnote but adding it to the bottom of the page, where the footnote would normally be, is the most obvious position. Make sure that it is a part of the page that will be transcluded with the rest of the footnote: ie. not in the header or footer of the Page, not in <noinclude> tags, and—if sectional transclusion is being used—in the same section as the rest of the footnote (so all parts are transcluded into the same page in the main namespace).

For example, if the footnote "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa." has been split into "Lorem ipsum dolor sit amet, consectetuer" on page 51 and "adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa." on page 52:

The first part should be written as:

<ref name="p51">Lorem ipsum dolor sit amet, consectetuer</ref>

The second part should be written as:

<ref follow="p51">adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.</ref>

The separate parts will be rejoined by the <references/> tag, or equivalent template, in the main namespace.

The same procedure can also be used for a footnote over three pages. See e.g. Page:Principles_of_Political_Economy_Vol_1.djvu/129 and the following pages. And what it looks like in the main namespace: Principles of Political Economy (J.S. Mill, 1871), vol. 1/Book I, Chapter V.

The procedure can be used to turn endnotes into footnotes. For example, note [1] at Page:Medivalhymnsand00nealgoog.djvu/25 (page 1) references a note at Page:Medivalhymnsand00nealgoog.djvu/28 (page 4). When it's transcluded, the endnote is joined to the placeholder footnote, as can be seen at Mediaeval Hymns and Sequences/Pange lingua gloriosi (Fortunatus).

Paragraphs in footnotes

Some sources have footnotes which contain multiple paragraphs, and text in <ref> tags does not currently support this in the same way as ordinary text.

For example:

Lorem<ref>Example footnote paragraph 1.

Example footnote paragraph 2.

Example footnote paragraph 3.</ref>

<references />

Will appear as:

Lorem^[1]

1. Example footnote paragraph 1. Example footnote paragraph 2. Example footnote paragraph 3.

While <br/> or <p></p> tags could be used to separate the paragraphs, these do not always work well when exporting to PDF or eBook formats. Instead, use {{Paragraph break}} (or its shortcuts {{pbr}} / {{parabr}}) between the paragraphs.

For example:

Lorem<ref>Example footnote paragraph 1.
{{paragraph break}}
Example footnote paragraph 2.
{{paragraph break}}
Example footnote paragraph 3.</ref>

<references />

Will appear as:

Lorem^[1]

1. Example footnote paragraph 1.

   Example footnote paragraph 2.

   Example footnote paragraph 3.

Grouped footnotes

It may sometimes be necessary to split footnotes into different sections. Different footnotes may be listed in more than one place or there may be different types of footnote, each with its own list at the end. In these cases, the different sets of footnotes should be grouped.

When using the <ref> tags add the "group" parameter. The name of the group used can be chosen by the individual proofreader but note that it will be visible on the page as part of the numeric indicator for the footnote. All tags in a specific group must have the same "group" parameter.

Each <references/> tag must also have the same "group" parameter. Each tag will only list footnotes that have the same group name.

For example:

Lorem<ref group="A">Foo</ref>

Ispum<ref group="B">Bar</ref>
Dolar<ref group="A">Baz</ref>

Group "A": <references group="A" />

Group "B": <references group="B" />

This will appear as:

Lorem^{[A 1]}

Ipsum^{[B 1]}
Dolar^{[A 2]}

Group "A":

1. Foo
2. Baz

Group "B":

1. Bar

Nested footnotes

There is a known limitation in mediawiki that certain tags such as <ref> are parsed in a linear rather than hierarchic fashion, resulting in constructions such as:

This is a basic<ref>Not<ref>Here is an opportunity for a really bad pun.</ref> the computer language!</ref> statement.<references/>

unexpectedly resulting in…

This is a basic the computer language!</ref> statement.

…due to the parser attempting to match the first occurrence of </ref> back to the first occurrence of <ref> instead of to the innermost occurrence and generally thereafter becoming confused.

In these instances, the template {{refn}} may be used. This same sequence may be re-expressed as:

This is a basic{{refn|Not<ref>Here is an opportunity for a really bad pun.</ref> the computer language!}} statement.<references/>

which produces something closer to the expected result:

This is a basic^[2] statement.

1. Here is an opportunity for a really bad pun.
2. Not^[1] the computer language!

—but sadly, the footnotes are still "out-of-order" with regards to normal expectation.

In order to fix this, we can use the parameters name and follow with {{refn}} as follows:

This is a basic{{refn|name=dummy}}{{refn|Not<ref>Here is an opportunity for a really bad pun.</ref> the computer language!|follow=dummy}} statement. <references/>

This results in:

This is a basic^[1] statement.

1. Not^[2] the computer language!
2. Here is an opportunity for a really bad pun.

We may also apply this to nested grouped footnotes:

This is a basic{{refn|Not<ref group="B">Here is an opportunity for a really bad pun.</ref> the computer language!|group="A"}} statement.
Group "A": <references group="A" />

Group "B": <references group="B" />

This new coding results in:

This is a basic^{[A 1]} statement. Group "A":

1. Not^{[B 1]} the computer language!

Group "B":

1. Here is an opportunity for a really bad pun.

Multiple references that point to the same footnote

Sometimes two or more references may point to the same footnote, for example.

Text	Here is one reference[1] and here is another[1] pointing to the same footnote. Here is one more[1]
Footnote	This is the footnote that can be reached by the three different reference tags

This is accomplished by using the "name" parameter. Give the first reference a unique name, in our example it is ref and each subsequent reference that points to the same footnote is tagged <ref name= /> where you want the references to appear. In our example it is <ref name=ref />

Here is one reference<ref name=ref>This is the footnote that can be reached by the three different reference tags</ref> and here is another<ref name=ref /> pointing to the same footnote. Here is one more<ref name=ref />

Multiple pages that reference the same footnote

This solution only works on pages that are transcluded together in the Main namespace.

Sometimes, a page references a footnote located on another page earlier in the work. Here is one solution to make both pages and the whole transcluded document look right:

Page containing the footnote

The page containing the footnote should name the reference. Example:

This page references the footnote for the first time.<ref name="name-of-the-ref">This is the footnote that is referenced by multiple pages.</ref>

Other page referencing the footnote

In the body of the page, the reference should be given the name only. Example:

The other page referencing the footnote should only include its name in the body of the text.<ref name="name-of-the-ref" />

In the footer of the page, one of the following options must appear, depending on which reference format is being used elsewhere in the work:

With <references />: <references> <ref name="name-of-the-ref">This is the footnote that is referenced by multiple pages.</ref> </references>

With {{smallrefs}}: {{smallrefs|refx= <ref name="name-of-the-ref">This is the footnote that is referenced by multiple pages.</ref> }}

With {{reflist}}: {{reflist|refs= <ref name="name-of-the-ref">This is the footnote that is referenced by multiple pages.</ref> }}

See Page:Oregon Historical Quarterly vol. 4.djvu/35 and Page:Oregon Historical Quarterly vol. 4.djvu/38 for a demonstration.

Alternatives

The preceding instructions are best practice for producing footnotes on Wikisource. However, in some rare cases it may be more appropriate to use one of the following methods instead.

Ref and Note templates

The reference indicator can be replaced with a {{Ref}} template, with the matching text following a {{Note}} template. This gives the proofreader more control over the placement of the footnote but it has the strong drawback of not being able to group footnotes when transcluded to the main namespace.

Using the example above, the main text will be written as:

And here it is doubtless thought by some, as it is in France by M. de Lagevenais, that Government, by supplying good music, should exclude the bad, such as that of Offenbach.{{ref|4}}

The footnote will be written as:

{{sup|4}} {{note|4}} ''Revue des Deux Mondes'', February 15, 1872.

The result is:

Text	And here it is doubtless thought by some, as it is in France by M. de Lagevenais, that Government, by supplying good music, should exclude the bad, such as that of Offenbach.[4]
Footnote	4 ↑  Revue des Deux Mondes, February 15, 1872.

When using this method, it is important to prepend the footnote the appropriate figure or symbol. This means the note can be found if it is being read from a printed copy instead of on a screen.

Endnotes with anchors

If the original work had endnotes at the back of the book (or other publication) it may sometimes be more appropriate to list all the footnotes in a special subpage. This subpage should ideally transclude the endnotes section from a scan of the original work.

In order to create the link from the indicator in the text to the footnote, wikilinks and anchors can be used. The indicator should be a wikilink in a format such as [[My book/endnotes#footnote4]]. The footnote should be preceded by a {{anchor}} template.

If the preceding example were in this format, with the footnote in another section, the text would appear as:

And here it is doubtless thought by some, as it is in France by M. de Lagevenais, that Government, by supplying good music, should exclude the bad, such as that of Offenbach.{{sup|[[Help:Footnotes and endnotes#footnote4|4]]}}

Although, rather than this help page, the wikilink would look more like [[The Study of Sociology I/Endnotes#footnote4|4]].

The footnote would be written as:

{{anchor|footnote4}}{{sup|4}} ''Revue des Deux Mondes'', February 15, 1872.

The result is:

Text	And here it is doubtless thought by some, as it is in France by M. de Lagevenais, that Government, by supplying good music, should exclude the bad, such as that of Offenbach.4
Endnote	4 Revue des Deux Mondes, February 15, 1872.

See also

• Template:Authority reference for including endnotes in the components parts of a produced work.
• Cite extension on MediaWiki, the source of the <ref> tags.
• Help:Footnotes on Wikipedia, where the same system is used to create lists of citations.