TechInfoDepot:Footnote3

This page explains a previously used footnote system, which is totally superseded by the newer footnoting system. The ref and note templates should only be used in specific circumstances, not for general purpose referencing.

The pairs of templates discussed in this guideline are:

Not all references are made using footnotes : Please see TechInfoDepot:Citing sources for guidance on references and alternative markup.

Also, not all footnotes are citations of information sources. They are also used for clarification or other notes about material. Common uses include explaining the meaning of a table header, or an exception regarding a specific entry in a table, etc.

Footnote overview
A footnote is a note placed at the bottom of a page of a document that comments on, and may cite a reference for, a part of the main text. The connection between the relevant text and its footnote is often indicated with a number or symbol which is used both after the text fragment and before the footnote.

Footnotes are sometimes useful for relevant text that would distract from the main point if embedded in the main text, yet are helpful in explaining a point in greater detail. Footnotes are also often used to cite references which are relevant to a text. Citation of sources is important in supporting Verifiability, a key aspect of TechInfoDepot.

Footnote usage
The ref templates generate automatically-numbered links in text to connect to footnotes in the section, most commonly named Notes or References, and footnotes contain matching note templates which generate backlinks back to the referring text.


 * To avoid an editor having to renumber footnotes due to insertion or deletion, this method uses automatically-generated numbers as much as possible (ref templates, plus a "numbered list" of footnotes to give automatic numbering of footnotes).
 * The connection between text and footnote uses appropriately-created name attributes per the template table above, so it is possible to identify the intended footnote even if numbering becomes incorrect.
 * The footnote connection is intended to be robust so content can be converted for use with future versions of supporting software.
 * To reduce disruption in the flow of text, footnote references are displayed as small, superscripted numbers.

This method has the following disadvantages:
 * When using the ref template there can only be one sequence of footnotes from the text -- although using the ref label template can circumvent that sequence. This is an example. Most articles have little reason to do that, but it can be useful, for example, in indicating that multiple pieces of data in a table come from the same source.
 * Every footnote number in the text refers to a separate note at the bottom: if you want to reuse a number so that it refers to the same footnote at the bottom, the ref label/note label variant must be used and manually numbered.
 * WARNING: It is not possible to test footnotes while previewing.  Clicking on a footnote ejects the user, perhaps to the previous version of the article (use the back arrow to return).  One can test the back link, which should really confirm the forward link as well.

How to use

 * See also help:footnotes for a concise manual and examples

The basic use of the ref and note templates is just choosing a one word descriptive   for your reference and:
 * put   where you want the footnote number to be
 * put a numbered list at the bottom of your document  # , for automatic numbering of your footnotes.

Use a separate note template for each reference template.

There are three examples below: The first is for this basic use of the ref and note templates. The second example explains how to build identical references, referring to the same footnote, using the ref label and note label templates for additional references to a ref/note footnote. The third example is a combination of the two, but with the multiple references made only within the footnotes section for easier maintenance by editors and easier navigation by the reader.

Example
According to scientists, the Sun is pretty big. The Moon, however, is not so big.

==Notes==


 * 1)  Miller, E: "The Sun.", page 23. Academic Press, 2005
 * 2)  Smith, R: "Size of the Moon", Scientific American, 46(78):46

The 's in the Notes section must occur in the same order as the corresponding  's in the main text. This is an important issue to consider when adding more footnotes later.

The template (where the numbers of the text references are fixed and not automatically assigned) can be used instead of the  template, but this should only be used when necessary due to the lack of automatic numbering.

It is encouraged that other, non-numbered references use citation templates such as shown in TechInfoDepot:Template messages/Sources of articles/Generic citations.

Example with multiple references to the same footnote
For the same footnote to be used several times, the additional template pairs now also include the footnote number, and a backlink label with which to identify the backlink (usually a letter "a" through "z"). This is an example of a whole document in wiki format. Another reference to the same source can be made. In this case, "1" is the number in the References section and "a" is the backlink label.

==References==

of a book. If known, give full reference including title, author, and ISBN.
 * 1)  and this is a note about the text from page 25

Footnote [2] in this article is referred to multiple times in the text, as well as in latter sections of the article, following this example.

Example with multiple uses of the same footnote
Another way to get to and use the same footnote is by travelling within the Footnotes section itself. Get to the footnotes section using the auto-numbered "ref/note" template pair, the basic template. Then use the "ref label/note label" template pair, exactly as in the preceding Example with multiple references.., but now entirely within the Footnotes section. Say something like "See above footnote 2c" to help the reader navigate. Future maintenance of footnote numbers and backlink labels is easier, within just the Footnote section, than trying to locate footnote references buried in a long text such as this article is. This alternative may cost the reader two extra clicks, a tradeoff against easier navigation. This approach is shown in this footnote.

Finally, the original footnote could be multiply repeated in the Footnotes section, each time with a new number -- in this article footnote [2] would appear five times, with five different numbers. This alternative is acceptable if done judiciously -- but not in this article.


 * WARNING: It is not possible to test footnotes while previewing.  Clicking on a footnote ejects the user, perhaps to the previous version of the article (use the back arrow to return).  One can test the back link, which should really confirm the forward link as well.  This repeated warning may save you some time.

Style recommendations

 * Internal links should still be used as normal, like this: TechInfoDepot.
 * Consider using a separate bibliography section if the same book reference is used in multiple footnotes. In this case, just the page number and book name can be given in each note, following TechInfoDepot:Citing sources.
 * Where possible choose a name for each link which matches the author/page system used by academics - use a single word and a hyphen to connect the page number (hunter-47)
 * If you don't know the page number, just use a single word (field)
 * With multiple books by the same author, make a difference, e.g. hunterA and hunterB, as in hunterA-22, hunterA-46 & hunterB-35 for page 22 and 46 of hunter's first book and page 35 of her second book.

Helping editors unfamiliar with footnote templates
As the recommended footnote structure does not appear to be entirely intuitive to all editors, and as notes being placed in the wrong order can affect the order of all following notes, making notes appear as if they do not match up, this short HowTo description can be inserted at the top of the Footnotes section, marked off to hide it from the actual article:

Instead of copy-pasting this text, it is possible to insert the following: (don't forget the "subst:" as only then is the template tag replaced by the commentary!).

Other (obsolete) template names
Originally this proposal used the template and  ; these were made obsolete and have been deleted. The  template was used in another earlier proposal which was converted to use the same system as is listed here. Substituting {{endnote| with {{note| should update pages still using this system.

Design goals
The design goals behind this system were


 * get something working with the current Wikimedia software.
 * make a very short easy to use template
 * get rid of complex renumbering edits
 * avoid disturbing the flow of text too much
 * maintain nice features of fn/fnb template (back link from footnote to text, & simplicity, for example)
 * remain reasonably accessible
 * provide semantic markup to help future enhancements by labeling information about source materials.

Migration strategy
There is a perl script numlink2note.pl available which automatically converts numbered URL links in a page into footnotes with this system. The references should still be hand checked, but at least part of the work is done.

Migration from old footnote systems should be reasonably easy to automate. As an intermediate measure, the embedded footnote numbers can be used as temporary footnote names until better ones are generated manually.

The  template and   template can be simply changed to match an and note templates. The following substitution (untested perl code). m/\{\{fnb/ && /s/^\*/\#/ ; will provide automatic numbering of footnote comments.

The following code will warn about pages which use links without text. m,\[[a-z]://\W*\],i && warn "unprotected url in text";

How does it work?
This section describes the technical implementation based upon characteristics of the current software.

The uses tricks listed in  m:Help:Variable to create an external wiki link back to a section in the same page (like  ). This external link is then automatically numbered by the normal numbering system for external links without link text. The link is surrounded in a sup tag which makes it look like a footnote and gives a reference that the footnote can link back to.

becomes

 [ #endnote_Jefferson]

The is a bit simpler, and is basically a copy of the older. This just creates a section link back to the location of the footnote.

#

becomes


 * 1) ^

Normal link and list numbering then produces automatic numbering of the footnotes.

Converting citation styles
Converting citation styles should not be done without first gaining consensus for the change on the article's talk page.

A December 2005 ArbCom case ruled that following scripts could no longer be used by a certain TechInfoDepotian:
 * TechInfoDepot:Footnote3/numlink2note.pl, explained at TechInfoDepot talk:Footnote3/numlink2note.pl
 * TechInfoDepot:Footnote3/order-footnote.pl, explained at TechInfoDepot talk:Footnote3/order-footnote.pl

Similarly, individual users may be forbidden to "manually convert citation styles on any articles."

So, tread lightly, and seek consensus first, before converting citation styles.

Disadvantages and future improvements

 * Editors must make sure to keep the numbered list at the bottom of the page in the same order as the references in the article text, or else the numbers may not match up. (Though this is better than relying on manual numbering at both ends.)
 * We would like to see Mediawiki software support for automatically generating and/or numbering footnotes. Reportedly, Magnus Manske added code for this to Nupedia.
 * Because of the way links are numbered, some editors argue that inline external links cannot be used in combination with auto-numbered footnotes, but must be converted into footnotes too. Other editors argue that both citation styles can be used in the same article.
 * Superscripts cause an increase in line spacing for the line they are on. Because lines without superscripts are still displayed at the original line spacing, this makes the text unevenly spaced, and this looks bad. This is a general problem with superscripts.  It may require CSS changes or even improvements in web browsers or OS font rendering systems.  (This should be filed as a bug in Bugzilla if it hasn't already.)
 * Some people like the idea of having sidenotes instead of or in addition to footnotes, especially if this is an option one can turn on and off in Mediawiki preferences. (You can turn a table into a sidenote with style="float: right;".)
 * Some people like the idea of "hover" or "tooltip" notes, that appear only when "hovering" over the superscript with the mouse point. (See e.g. Template:Hnote.)
 * Bug 2745: Have References text edit window on Edit pages