Revision as of 15:00, 28 July 2008 editGimmetrow (talk | contribs)Administrators45,380 editsm Reverted edits by Book Author (talk) to last version by Francis Schonken← Previous edit |
Latest revision as of 12:37, 27 June 2022 edit undoWbm1058 (talk | contribs)Autopatrolled, Administrators264,984 editsm removing over-categorization (via WP:JWB) |
(522 intermediate revisions by more than 100 users not shown) |
Line 1: |
Line 1: |
|
|
#Redirect ] |
|
{{Redirect3|WP:FOOT|You may be looking for ]}} |
|
|
{{Misplaced Pages subcat guideline|style guideline|Footnotes|WP:FN|WP:FOOT|WP:NOTES}} |
|
|
A ''']''' is a note placed at the bottom of an article that expands on a specific portion of the text. The connection between that portion of the text and the corresponding footnote is indicated by a number or symbol in the text. Misplaced Pages has several mechanisms for creating footnotes that contain reciprocal hyperlinks; in other words, clicking on the number/symbol found in the main text brings one to the corresponding footnote, and vice versa. |
|
|
|
|
|
|
|
{{Redirect category shell|1= |
|
Footnotes serve two purposes. First, they are used to add material that explains a point in greater detail, particularly if the explanation would be distracting if written out in the main article. Second, they are used to cite the reliable sources that support an assertion in the main article. This is known as an "inline citation". Two different types of footnotes may be used for these two different purposes, as described below. |
|
|
|
{{Redirect from move}} |
|
|
|
|
|
{{Redirect from merge}} |
|
The prevailing system for adding footnotes to an article involves the '''<ref>''' tag. This system has several advantages, including automatic sequential numbering of the footnotes and provisions for multiple references to the same footnote. To add such a footnote to an article, the editor includes the text of the footnote between two HTML-style tags, e.g., <nowiki><ref>Text of footnote goes here.</ref></nowiki>. Different classes of footnotes can be defined within an article using the "group" parameter inside the "ref" tag, as described below. |
|
|
|
{{Redirect to project namespace}} |
|
|
|
|
|
{{Redirect to section}} |
|
Editors may also use the older system of ]-based footnotes, such as {{tl|ref label}} and {{tl|note label}}. These have the disadvantage that they are not numbered automatically; the editor has to choose a specific label. It is generally expected that footnotes will be labeled in the order in which they occur in the text. Therefore, if an editor adds such a template-based footnote in the middle of an article, the editor should also renumber/increment all the subsequent footnotes of the same type, by hand. |
|
|
|
}} |
|
|
|
|
Footnotes are not the only way to ]. Alternative methods are ] and ] (also known as ''author-date'' or ''parenthetical'' referencing). For more information, see ], the main style guide on citations. |
|
|
|
|
|
] sources is important for improving the quality of Misplaced Pages's articles. A key content policy, ], says that any material that is challenged or likely to be challenged, including any contentious material about ], and all quotations, must have a source. Unsourced or poorly sourced material may be removed from any article, and if it is, the burden of proof is on the editor who wishes to restore it. |
|
|
|
|
|
{{style}} |
|
|
|
|
|
==How to use== |
|
|
:''A simplified explanation is given at ]'' |
|
|
:''See ] for some template based implementation examples.'' |
|
|
|
|
|
# Place a '''<ref>''' ... '''</ref>''' where you want a footnote reference number to appear in an article—type the text of the note between the ref tags. |
|
|
# Place the '''<nowiki><references /></nowiki>''' tag or '''<nowiki>{{reflist}}</nowiki>''' tag in either a "Notes" or "References" section as explained in the ] — the list of notes will be generated in that section. (The choice between {{tl|reflist}} and <nowiki><references /></nowiki> is a matter of style; Misplaced Pages does not have a general rule.) |
|
|
|
|
|
This page itself uses footnotes, such as the one at the end of this sentence.<ref name="example">This footnote is used as an example in the "How to use" section.</ref> If you view the Wikicode of this page by clicking "Edit this page", you can see a working example of footnotes. |
|
|
|
|
|
===Ref tags and punctuation=== |
|
|
Material may be referenced mid-sentence, but footnotes are usually placed at the end of a sentence or paragraph. Footnotes at the end of a sentence or phrase are normally placed immediately after the punctuation, except for dashes, as recommended by the '']'' and other style guides.<ref>''The Chicago Manual of Style'', 14th ed. 1993, Clause 15.8, p. 494 - "The superior numerals used for note reference numbers in the text should follow any punctuation marks except the dash, which they precede. The numbers should also be placed outside closing parentheses." - See also .</ref><ref>Other style guides suggesting that superscript note reference numbers should generally be placed ''after'' punctuation include: <!--inFootnotesSection-->, , , <!--ArchivedLink-->, and (as well as the general exception for dashes, guides may variously make other exceptions for colons, semicolons and quotation marks).</ref> Some editors prefer the in-house style of journals such as '']'', which place references before punctuation. If an article has evolved using predominantly one style of ref tag placement, the whole article should conform to that style unless there is a ] to change it. |
|
|
|
|
|
=== Naming a ref tag so it can be used more than once === |
|
|
{{shortcut|WP:REFNAME}} |
|
|
To give a footnote a unique identifier, use '''<ref name="name">''' ... '''</ref>'''. You can then refer to the same footnote again by using a ref tag with the same name. The name cannot be a number, or the extension will return an error. The ref name need not be placed within quotes unless it consists of more than one word (the wiki parser converts single word quoteless attribute values into validly quoted XHTML). Note that any quotation marks placed around the ref name must be straight quotes ('''"''') rather than curly quotes ('''“''' or '''”'''). |
|
|
|
|
|
Named references are used when there are several cases of repetition of exactly the same reference, including the page number for books; they should not be used to cite different pages in the same book. Named references in wikitext serve a purpose similar to ] or ] in printed media. ''See also cautions in ] below''. |
|
|
|
|
|
Only the first occurrence of text in a named ref will be used, although that occurrence may be located anywhere in the article. You can either copy the whole footnote, or you can use a terminated empty ref tag that looks like this: '''<nowiki><ref name="name" /></nowiki>'''. Such forward-slash-terminated named tags may precede the definition of the named reference.<ref>]. November 13, 2006.</ref> In subsequent uses of the named tag the use of '''<nowiki><ref name="name" /></nowiki>''' is encouraged rather than copying the whole footnote again, as whole footnotes tend to reduce the readability of the article's text in edit mode, which makes finding specific parts of the text when editing tedious. |
|
|
|
|
|
In the following example, the same source is cited three times. |
|
|
|
|
|
<blockquote style="color:#999; background:white; margin:0; padding:1em; border:1px solid #999;"> |
|
|
<div> |
|
|
<tt> |
|
|
This is an example of multiple references to the same footnote.<span style="color:black;">'''<ref name="multiple"/>'''</span> |
|
|
|
|
|
Such references are particularly useful when citing sources, if different statements come from |
|
|
the same source.<span style="color:black;">'''<ref name="multiple">'''Remember that when you refer to the same footnote multiple times, the text from the first reference is used.'''</ref>'''</span> |
|
|
|
|
|
A concise way to make multiple references is to use empty ref tags, which have a slash at the |
|
|
end.<span style="color:black;">'''<ref name="multiple">'''This text is superfluous, and won't show up anywhere. We may as well just use an empty tag.'''</ref>'''</span> |
|
|
|
|
|
<span style="color:#666;">== Notes ==</span> |
|
|
|
|
|
<span style="color:black;">'''<references />'''</span> |
|
|
</tt> |
|
|
</div> |
|
|
</blockquote> |
|
|
|
|
|
The text above gives the following result in the article (see also ] below): |
|
|
{{quote|This is an example of multiple references to the same footnote.<ref name="multiple" /> |
|
|
|
|
|
Such references are particularly useful when citing sources, when different statements come from the same source.<ref name="multiple">Remember that when you refer to the same footnote multiple times, the text from the first reference is used.</ref> |
|
|
|
|
|
A concise way to make multiple references is to use empty ref tags, which have a slash at the end.<ref name="multiple">This text is superfluous, and won't show up anywhere. We may as well just use an empty tag.</ref>}} |
|
|
|
|
|
One should be particularly careful when deleting a named reference with text content, because the footnote text will be deleted unless it is copied to another ref tag with the same name. |
|
|
|
|
|
===Citation templates=== |
|
|
Text placed between <code><nowiki><ref></nowiki></code> and <code><nowiki></ref></nowiki></code> may be short notes or full bibliographic references, and may be formatted either by hand or with the assistance of templates. Instructions on available templates to help format bibliographic references may be found at ]. Use of such templates is not required; see ]. |
|
|
|
|
|
=== Previewing a single section edit=== |
|
|
;Notes and references not normally visible |
|
|
When you ] on a long page, the Notes or References section will not be visible when you ]. Thus you ordinarily cannot see how your footnotes (text you place between <code><nowiki><ref></nowiki></code> and <code><nowiki></ref></nowiki></code> tags) will later appear when you save your edits. |
|
|
|
|
|
;Workaround for notes and references |
|
|
A simple workaround is to ''temporarily'' insert a <code><nowiki><references/></nowiki></code> or <code><nowiki>{{reflist}}</nowiki></code> tag at the bottom of the edit box of the section you are editing. Your footnotes will appear at the bottom of your section so you can preview them. When you are satisfied with your edits to the section, delete your temporary <code><nowiki><references/></nowiki></code> or <code><nowiki>{{reflist}}</nowiki></code> tag, and save your edits. Now your footnotes should appear in the "Notes" or "References" section along with other footnotes on the page. |
|
|
|
|
|
While you preview the footnotes in a section this way, the first footnote in the section will temporarily have a number of one (1), because the preview will not show footnotes from elsewhere on the page. The footnotes will renumber properly across the entire article after you save your edited section. |
|
|
|
|
|
;Re-use of reference(s) from another section |
|
|
Another complication is that you will not be able to preview the effect of ] merely by citing its name (for example: <code><nowiki><ref name="</nowiki>''multiple''<nowiki>"/></nowiki></code>). If the section you want to edit reuses footnotes from elsewhere on the page, a simple solution is to edit the whole page at once in order to preview the footnotes accurately. |
|
|
|
|
|
If you want to avoid this, the only workaround would be to copy and ''temporarily'' insert the full code of the relevant reference(s) at the top of the edit box of the section you are editing. If you have used the "workaround for notes and references" (above) the footnotes will appear at the bottom of your section so you can preview them. When you are satisfied with your edits to the section, delete the temporary full reference code and save your edits. Now your footnotes should appear in the "Notes" or "References" section along with other footnotes on the page. |
|
|
|
|
|
==Separating reference lists and explanatory notes== |
|
|
{{shortcut|WP:REFGROUP}} |
|
|
It is often desirable for an article to list sources separately from explanatory notes. When this is done the sources may appear in an alphabetized list unlinked to the article (''e.g.'', '']'') or in a list that is linked to specific text in the article (''e.g.'', ]). A separate section containing references is usually given the title "References," while the explanatory notes section retains the "Notes" title. |
|
|
|
|
|
One way to generate a linked list of sources involves the "group=" option of the <ref> tag, which is analogous to the "name=" option described above. In this approach, narrative references are given their own "group" namespace. The group identifier is specified inside explanatory note <ref> tags and its final <references/> tag. The closing tag </ref> does not change. |
|
|
|
|
|
For example: <pre style="line-height: 130%; word-wrap: break-word; margin:1em; border:1px solid DarkSeaGreen; |
|
|
white-space: -moz-pre-wrap; |
|
|
white-space: -o-pre-wrap; |
|
|
white-space: -pre-wrap; |
|
|
white-space: pre-wrap"> |
|
|
Example text,<ref group=nb>This is an example explanatory note</ref> more example text.<ref group=nb name=ex02>Explanatory notes can be shown separately from references or citations - giving a neater appearing alternative compared to having mixed "Notes and references" or "Notes and citations" sections. This is an example of such a note. It is generated via use of group extension of the reference tag.</ref> A point made with a supporting reference.<ref>Author, A. (2007). "How to cite references", New York: McGraw-Hill.</ref> A second appearance of a note.<ref group=nb name=ex02/> |
|
|
|
|
|
== Notes == |
|
|
<references group=nb/> |
|
|
|
|
|
== References == |
|
|
<references/> |
|
|
</pre> |
|
|
Rendering: |
|
|
<div style="margin: 1em; padding: 1em; border:1px solid #999"> |
|
|
Example text,<ref group=nb>This is an example explanatory note</ref> more example text.<ref group=nb name=ex02>Explanatory notes can be shown separately from references or citations - giving a neater appearing alternative compared to having mixed "Notes and references" or "Notes and citations" sections. This is an example of such a note. It is generated via use of group extension of the reference tag.</ref> A point made with a supporting reference.<sup id="nbFoot01" class="reference">]]</sup> A second appearance of a note.<ref group=nb name=ex02/> |
|
|
|
|
|
<font size=3><b>Notes</b></font> |
|
|
---- |
|
|
<references group=nb/> |
|
|
|
|
|
<font size=3><b>References</b></font> |
|
|
---- |
|
|
<div style="-moz-column-count:2; -webkit-column-count:2; column-count:2;"> |
|
|
<ol class="references"> |
|
|
<li id="noteFoot01" |
|
|
><b>]</b> Author, A. (2007). "How to cite references", New York: McGraw-Hill.</li> |
|
|
</ol></div> |
|
|
</div> |
|
|
|
|
|
In general practice note that footnotes that cite sources are ''not'' given a group identifier. This is because they are usually (by far) more numerous and more important to the quality of the article. Nothing special need be done for them; the usual methods, described above, will work as always. To maintain a separate list of scholarly footnotes, the group identifier "nb" or "note" is generally adopted. |
|
|
|
|
|
It is also possible to use the reference templates, e.g., {{tl|ref label}} and {{tl|note label}} to separate a sources list from content notes. As with all ], consensus should be achieved on the talk page before implementing such a change. |
|
|
|
|
|
==Style recommendations== |
|
|
* Do not use '']'', '']'' or similar abbreviations in footnotes. Other editors who add new references to the article may not take the time to correct Ibid references broken by their addition. Furthermore, not all readers are familiar with the meaning of the terms. If a reference is reused in more than one footnote, it is preferable to use the format "Smith, ''Short Title'', 182" rather than "Ibid, 182", so as to avoid these problems, or use ] if appropriate. |
|
|
* Consider maintaining a separate bibliography/references section that gives full publication details for frequently cited sources, then you only need to cite the author, short title, and page number in specific notes, following ]. For examples of this usage, see ] and ]. For another solution to this issue, especially when a single source is cited many times in one article, but cites to different pages in that source each time, see ]. |
|
|
* The decision on whether or not to use quotes in footnotes, is primarily a decision of style and may vary from article to article. Citation templates include parameters for quotes, as quoting text can be useful for the ] of material in an article. Footnoted quotes are acceptable if they are brief, relevant to the article text that is being footnoted, compliant to ] (including ] where applicable), of use or interest to the reader, and not used as an ] of ] (most notably: ]).<ref>For example, " to work around the proscription placed on editors by ]." </ref> Where there is disagreement on the use of quotes in footnotes on a particular article, ] should be sought on the talk page for that article. |
|
|
|
|
|
== Known bugs == |
|
|
* Internal links and wiki formatting work as normal within the text of the citation, like this: <tt><nowiki><ref>'']'', ], ].</ref></nowiki></tt> However, the "]" will not expand a link for you in ref text; you must type out <tt><nowiki>]</nowiki></tt>, rather than just typing <tt><nowiki>]</nowiki></tt> and letting the software fill in the text after the pipe. See ]. |
|
|
* When citing a website within the ref tags, include a name for the site inside the brackets for the URL. Unnamed URLs appear as numbers, so <tt><nowiki><ref></ref></nowiki></tt> results in the footnote being displayed as ; the reader clicks to the numbered footnote only to see another number. Thus, use a name in the link to display the website page title in the reference list, as in this example: <tt><nowiki><ref></ref></nowiki></tt> . |
|
|
* References cannot be nested: <tt><nowiki><ref name="Ran1912">J. Random, 1912. Cited in <ref name="Foo2005"/></ref></nowiki></tt> does not render correctly. |
|
|
**This bug can be bypassed using the #tag magic word: use <code><nowiki>{{#tag:ref|J. Random, 1912. Cited in <ref name="Foo2005"/>|name=Ran1912}}</nowiki></code> instead. |
|
|
* Avoid use of "subst", or at least verify that it works correctly. A Mediawiki bug prevents the expansion of certain (if not all) "subst"'s within refs. |
|
|
* Template parameters do not pass to <nowiki><ref></nowiki> tags (for example, <code><nowiki><ref></ref></nowiki></code> within template source code; see also ] and ]). Ref tags can be used in ''variables'' when a template is used, though (for example, {{tl|taxobox}}'s status_ref parameter). |
|
|
**This bug can be bypassed using the #tag magic word: use <code><nowiki><includeonly>{{#tag:ref|content|name=foo}}</includeonly></nowiki></code> in the template instead of <code><nowiki><ref name="foo">content</ref></nowiki></code>. |
|
|
|
|
|
==Resizing references== |
|
|
Some editors prefer references to be in a smaller font size than the text in the body of the article. Although smaller text has some disadvantages, it is common when there is a long list of references (as a rule of thumb, at least ten) to replace the basic <nowiki><references /></nowiki> tag with <tt>]</tt>, which reduces the text size to 90%. (''Note:'' Do '''not''' use <tt>]</tt> with a "subst:".) The underlying CSS class is "references-small", so an alternative is to use this directly: <tt><nowiki><div class="references-small"><references /></div></nowiki></tt>. If this class is used to make other sections at the bottom of the page ("Notes", "See also", "External links", etc.) small for consistency (this is rarely done), the div tags must be opened and closed within each section. |
|
|
|
|
|
A similar CSS class exists to create small footnotes in two columns, but this displays as a single column in some common browsers (like Internet Explorer). If desired, use <nowiki><div class="references-2column"><references /></div></nowiki> |
|
|
|
|
|
The same effect (with any number of columns) can be accomplished by using {{tlx|Reflist|<var>number of columns</var>}}. |
|
|
|
|
|
==Compatibility with other MediaWiki sites== |
|
|
As of late December 2005, the ] extension to ] has been installed on all Wikimedia wikis. Other wikis that use the ] software may not have this extension installed, and therefore may be unable to display Cite.php footnotes. The ] page on any MediaWiki wiki shows the installed extensions. |
|
|
|
|
|
Extensions like Cite/Cite.php are installed after installing MediaWiki software; these extension files are placed in the directory <code>wiki/extensions/</code>. |
|
|
|
|
|
==Caution on converting citation styles== |
|
|
An older system using {{tl|ref}} and {{tl|note}} templates is still common. Converting this older system<ref>The ] system created footnotes with the {{tl|ref}}/{{tl|note}} and the {{tl|ref_label}}/{{tl|note_label}} pairs of templates. The system may be encountered on many Misplaced Pages pages.</ref> to the new <nowiki><ref>...</ref></nowiki> system can make the references in an article easier to maintain. |
|
|
|
|
|
Converting citation styles should not be done without first gaining consensus for the change on the article's talk page. |
|
|
|
|
|
<!-- Sorry, if what follows sounds harsh, but I found no way of formulating it softer without making the links to the ArbCom case, and the SEWilco bot user page: the ArbCom decision did not leave any margin that SEWilco could use his bot or convert citation styles "after consensus", no, he was forbidden throughout, quote from the RFAr "Remedies" section: "SEWilco should not use a bot to convert citations on articles, nor should he manually convert citation styles on any articles." (Passed 7-0) / this note inserted by ~~~~ --> |
|
|
A ] ruled that the following scripts could no longer be used by a ]: |
|
|
* ], explained at ] |
|
|
* ], explained at ] |
|
|
|
|
|
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. For example, when using ] as listed below: |
|
|
* ] converts articles that use the {{tl|ref}} and {{tl|note}} system into the more recent ] system; |
|
|
* ] diagnoses and fixes sequencing and duplication errors in Cite.php references. In the future, Citation Tool may (optionally) enable user-guided conversion of some or all of the ] numbered citations to named notes using the ] ''template'' technology (which includes Harvard references). |
|
|
|
|
|
'''CAUTION: do not edit-war with automated tools that convert in opposing directions.''' |
|
|
|
|
|
==See also== |
|
|
*], the relevant policy regarding what material should be cited |
|
|
*], the relevant style guide. |
|
|
*], listing also several examples of ''non-numbered'' APA style and Harvard referencing techniques |
|
|
*] for complete list of templates that are available for citations; note that several of these templates can easily be combined with "footnote3" footnotes, see ] for an example. |
|
|
*]: Proposal for use of database of citations. |
|
|
*] |
|
|
*Other types of ''numbered'' footnotes: |
|
|
**], a very old, manually-numbered footnote system that should not be used. |
|
|
**], another obsolete system that should not be used. |
|
|
**], an automatically-numbered footnote system using templates, which is widely used but has been replaced by MediaWiki footnotes. |
|
|
*] |
|
|
*] (formerly at ]) - description of the <nowiki><ref>...</ref>/<references/></nowiki> system at metawiki |
|
|
*] - Biblio.php, an extension of Mediawiki which provides a citation manager. (beta maturity) |
|
|
*] |
|
|
*]. |
|
|
*] - adds ability to handle ] page number citations to Cite.php inline references (intended for use when one source is cited a large number of times, and would produce either too many individual entries under <nowiki><references /></nowiki> for the same source, or one exceedingly long entry that cited too many pages to possibly be useful to readers). |
|
|
* ] an idea for standardizing how facts are cited. |
|
|
* ] is the bibliographic catalog used by the WikiTextrose project. |
|
|
** ], a text relationship database for mapping the various interactions between interpretable artifacts. |
|
|
*] A simple practical guide to getting started. |
|
|
|
|
|
==Notes== |
|
|
<references /> |
|
|
# Additional references that are not created with '''<ref>''' ... '''</ref>''' ], do not continue the numbering. These are ''mistakes''; they should be corrected by converting them to footnotes using "ref" tags. |
|
|
|
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|
|
] |
|