Template:Ref/doc
 | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
 | This is Template:Plainlink the recommended method of citing sources. It may still be used for adding footnotes where a lightweight low-complexity method is needed. For information on how to place and format citations, see Wikipedia:Citing sources. An explanation on how to create 'numbered footnotes' is at Help:Footnotes. |
This documentation is for the {{ref}}, {{note}}, {{ref label}} and {{note label}} templates. The note templates place notes into an article, and the ref templates place labeled references to the notes, with the labels normally hyperlinks for navigating from a ref to a corresponding note and back from the note to the ref. The label pair of templates are similar to the pair without the label name, but with more features.
The links and backlinks are identified internally by combining the specified parameters. The templates accepts a number of unnamed parameters identified by their position. It also accepts a named parameter (named noid) which is deprecated since its introduction.
The first parameter of {{ref}} is a label that has to be used for the parameter of the corresponding {{note}}. The label is used to form the fragment identifier for the footnote link and back link. The second parameter of {{ref}} is the footnote reference marker, shown as a superscript. The easiest choice is to make these two the same, but this is not a requirement. If the second parameter is not supplied, the marker is a superscripted external link of the form [n].
Syntax
[edit]The following illustrates the general syntax of each template:
- {{ref|id}}
- {{note|id}}
- {{ref label|id}}
- {{note label|id}}
Description of each parameter is as follows:
id
[edit]Identifier for a note and its back link (mandatory). This is the only mandatory parameter for {{ref}} and {{note}} couple, which can be used to add simple footnotes.
Every pair of {{ref}} and {{note}}, as well as every pair of {{ref label}} and {{note label}}, should have unique identifiers. This applies even if two references pointing to the same footnote are desired. (Correct method of implementing this feature is illustrated further below.) Duplicate identifiers generate invalid code, to which web browsers react differently. Some browsers report errors, while others may randomly keep one id and discard others silently. In all cases, however, navigation between some footnote marks and their body texts does not work as desired. See Help:Markup validation.
| Code | Result |
|---|---|
Text that requires a footnote.{{ref|a}}
== Notes ==
:1.{{note|a}}Body of the footnote.
|
Text that requires a footnote.[1]
|
label
[edit]Label text displayed where these templates are inserted (mandatory for {{ref label}} and {{note label}}). The following explains template specific behavior:
- In {{ref}}, {{ref label}} and {{note label}}, the label appears in superscript; in {{note}}, the label appear as standard-sized baseline bold text.
- In {{ref}}, {{ref label}} and {{note}}, the label is also hyperlinked and helps navigating back and forth between the inline footnote marker (in the prose) and its body text. {{Note label}}, however, attaches not hyperlink to the label but disregards this parameter when the backlink parameter (explained later) is present.
- In {{ref label}}, the label is always enclosed in brackets.
| Code | Result |
|---|---|
Text alpha.{{ref|Alpha|α}} Text beta.{{ref label|Beta|β}}
==Notes==
:{{note|Alpha|α}} Information on alpha
:{{note label|Beta|β}} Information on beta
|
|
This parameter is optional in {{ref}} and {{note}}, therefore:
- {{Ref}} displays a unique number in square brackets if this parameter is omitted. (See example above.)
- {{Note}} appends this label to a back linked caret (^), so if omitted, only a caret is displayed. (See example above.)
There is no mandate to include this parameter in both ref and note portion at the same time. In fact, there may be the need to do the opposite. This example shows how to use {{ref}} and {{note}} to link multiple footnote markers of the same appearance to the same footnote.
| Code | Result |
|---|---|
... The reunification project started in 1959 and concluded in 1961. The outcome of the project was instrumental in the company's success.{{ref|Lewinsky1|A}} ...
... The consolidation efforts in 1992 had a huge impact on the company's success.{{Ref|Lewinsky2|A}} ...
... The final development stage set the cornerstone for company's future activities.{{Ref|LewinskyFinal|A}}...
==Notes==
:A.{{Note|Lewinsky1}}{{Note|Lewinsky2}}{{Note|LewinskyFinal}}See Brown, Lewinsky and Hart, 2009.
|
... The reunification project started in 1959 and concluded in 1961. The outcome of the project was instrumental in the company's success.A ...
... The consolidation efforts in 1992 had a huge impact on the company's success.A ... ... The final development stage set the cornerstone for company's future activities.A... |
... The reunification project started in 1959 and concluded in 1961. The outcome of the project was instrumental in the company's success.{{ref label|Brown1|B}} ...
... The consolidation efforts in 1992 had a huge impact on the company's success.{{Ref label|Brown2|B}} ...
... The final development stage set the cornerstone for company's future activities.{{Ref label|BrownLast|B}}...
==Notes==
:B.{{Note label|Brown1|^}}{{Note label|Brown2|^}}{{Note label|BrownLast|^}}See Brown, Lewinsky and Hart, 2009.
|
... The reunification project started in 1959 and concluded in 1961. The outcome of the project was instrumental in the company's success.[B] ...
... The consolidation efforts in 1992 had a huge impact on the company's success.[B] ... ... The final development stage set the cornerstone for company's future activities.[B]..
|
backlink
[edit]As explained above, {{note label}} does not generate a back link from label parameter. A unique parameter of {{ref label}}-{{note label}}, backlink is a complementary parameter that is part id and part label:
- "Complementary parameter" means a {{ref label}}-{{note label}} may either forgo this parameter or must both have it.
- "Part id" means in a {{ref label}}-{{note label}} pair, both ends must have the same backlink value. In addition, in any {{ref label}}-{{note label}} pair, the combination of id and backlink must be unique.
- "Part label" means in {{note label}}, this parameter completely overrides label parameter.
A {{ref label}} with a backlink cannot connect to a {{note}}. Likewise, a {{note label}} with a backlink cannot connect to a {{ref}}.
Example:
| Code | Result |
|---|---|
Some text.{{ref label|id5|5|1}}
Some other text.{{ref label|id5|5|2}}
-----
;Notes:
...
:5.{{note label|id5||1}}{{note label|id5||2}} Some important comment!
|
Some text.[5] Some other text.[5]
... |
This parameter (backlink) also accepts the special value "none" (without quotation marks), which causes a caret to appear where {{note label}} is placed.
| Code | Result |
|---|---|
Body text.{{ref label|id4|Label 4|none}}
:{{note label|id4||none}}Footnote text
|
Body text.[Label 4]
|
text
[edit]In all previous examples, the body text of a piece of footnote was inserted outside {{note}} or {{note label}} template. However, it is possible to insert the body text inside the template, in place of text parameter. Everything put inside text parameter glows when the user clicks on the footnote mark. In the example below, try clicking on S and T and see the difference.
| Code | Result |
|---|---|
Some text.{{Ref|NoteS|S}}
Some other text.{{Ref|NoteT|T}}
==Notes==
:S.{{Note|NoteS}}Some footnote text
:T.{{Note|NoteT||Some other footnote text}}
|
Some text.S
Some other text.T |
Since the footnote body text starts without a delimiter after this string, there is a caveat: If the footnote body text start with a lowercase letter, the first word may be attached to the back link. (For more info, see Help:Wikilinks.)
| Code | Result |
|---|---|
:{{ref label|id ref2a|Label 2a|Back}}
:{{ref label|id ref2b|Label 2b|Back}}
:{{note label|id ref2a|Label 2a|Back|Capitalized footnote}}
:{{note label|id ref2b|Label 2b|Back|lower case footnote}}
|
noid=noid
[edit]Deprecated parameter – Suppresses back linking from note component to ref. In case of {{Note}}, an active hyperlink still appears, although it is broken.
This parameter was originally meant to alleviate the problem of connecting many ref tags with the same ID to one note tag with that ID. However, it only replaces one form of broken code with another. Consider using {{note label}} instead, which does not generate any back link unless configured to do so. There must always be one and only one note template for every ref template with the same id.
Additional examples
[edit]| Code | Result |
|---|---|
Article text{{ref label|reference_name_A|a|1}} more text{{ref label|reference_name_G|g|}} more text{{ref label|reference_name_B|b|2}} more text{{ref label|reference_name_C|c|3}} more text{{ref label|reference name_D|d|4}} more text{{ref label|reference name_E|e|none}} more text{{ref label|reference name_F|f|}} more text.{{ref label|reference_name_H|h|8}}
*
*intervening text
*
*{{note label|reference_name_A|a|1}}Text of note for ref a.
*{{note label|reference_name_B|b|2}}Text of note for ref b.
*{{note label|reference_name_C|c|3|ABCDE}}Text of note for ref c.
*{{note label|reference_name_D|d|4|FGHIJ}}Text of note for ref d.
*{{note label|reference_name_E|e|none}}Text of note for ref e.
*{{note label|reference_name_F|f}}Text of note for ref f.
*{{note label|reference_name_G|g||{{note label|reference_name_H|h|8|Text of note for refs g and h (with extended highlighting).}}}}
|
Article text[a] more text[g] more text[b] more text[c] more text[d] more text[e] more text[f] more text.[h] |
Unique ID issue
[edit]As explained earlier, the id parameter for every {{ref}}-{{note}} pair should be unique. The following example shows what happens when two refs use the same id. Try navigating from bulleted text to footnotes and back.
| Code | Result |
|---|---|
Article text{{ref|reference_name_A|a}} more text{{ref|reference_name_B|b}} more text{{ref|reference_name_C|c}}.
*Bulleted text{{ref|reference_name_B|b}}
*Bulleted text{{ref|reference_name_C|c}}.
*
*intervening text
*
*{{note|reference_name_A|a}}Text for note a.
*{{note|reference_name_B|b}}Text for note b.
*{{note|reference_name_C|c|Text for note c (with extended highlighting).}}
|
Table footnotes
[edit]One common application for ref and note templates is in placing footnotes below tables, as in the following example taken from the Kent#Economy article:
| Year | Regional GVA[A] | Agriculture | Industry[B] | Services[C] | |||
|---|---|---|---|---|---|---|---|
| County of Kent (excluding Medway) | |||||||
| 1995 | 12,369 | 379 | 3.1% | 3,886 | 31.4% | 8,104 | 65.5% |
| 2000 | 15,259 | 259 | 1.7% | 4,601 | 30.2% | 10,399 | 68.1% |
| 2003 | 18,126 | 287 | 1.6% | 5,057 | 27.9% | 12,783 | 70.5% |
| Medway | |||||||
| 1995 | 1,823 | 21 | 3.1% | 560 | 31.4% | 1,243 | 68.2% |
| 2000 | 2,348 | 8 | 1.7% | 745 | 30.2% | 1,595 | 67.9% |
| 2003 | 2,671 | 10 | 1.6% | 802 | 27.9% | 1,859 | 69.6% |
- ↑Components may not sum to totals due to rounding
- ↑Includes energy and construction
- ↑Includes financial intermediation services indirectly measured
Alternative referencing style
[edit]Using ref/note tags is not the only way to create footnotes. Cite.php is currently the preferred method of creating footnotes, especially when the number of footnotes increases and the size of the article (or the area in which footnotes are used) grows. Ref converter can convert ref/note tags to the newer Cite.php style.
The following examples compares two method and also shows how they can be combined:
| Code | Result |
|---|---|
Yammer yammer yammer.<ref name=smith2000>Smith wrote the definitive book on yammering.{{ref|Smith2000|Smith 2000}}</ref> Yammer yammer yammer.<ref name=smith2000/>
...
== References ==
<References/>
...
== Bibliography ==
*{{note|Smith2000}} Smith (2000). "A book about yammering".
|
Yammer yammer yammer.[1] Yammer yammer yammer.[1] ...
...
|
Also see examples and explanation in Wikipedia:Footnote3.
See also
[edit]- Wikipedia:Footnote3 — An essay on this footnote-creation method
- Help:Footnotes
- Wikipedia:Template messages/Sources of articles
- Category:Citation templates — More citation templates, some of which are not part of the Ref/Note Label system
- {{Notice}}