View source for Template:Ref/doc

{{documentation subpage}}
{{wikipedia text|Template:Ref/doc|426009483}}
{{Missing information non-contentious|1=complete syntax of this template and the description of each parameter (only two parameters are explained, although this template seems to have three)}}
==Ref-family templates==
The {{tl|ref}} family of templates is used to place labeled references and notes and references into an article, with the labels normally being clickable links for navigating from a ref to a corresponding note and back from the note to the ref. The links and backlinks are identified internally by combining the specified parameters. The templates take a variable number of unnamed parameters identified by their position and, optionally, a named parameter named ''noid'' which, if used, should be set by specifying it as "noid=noid".

=== Very simple example ===

{| class=wikitable                  
!Article
!Wikitext
|-
|<pre>
Text that requires a footnote.{{ref|a|1}}

==Notes==
:1.{{note|a}}Body of the footnote.
</pre>
|{{quotation|
Text that requires a footnote.{{ref|a|1}}

{{Fake heading|Notes}}
:1.{{note|a}}Body of the footnote.
|}

The first parameter of {{tlx|ref}} is the label that has to be used for the parameter of the corresponding {{tlx|note}}. The second parameter is the marker of the resulting link as it will be shown on the page, as a superscript. The easiest choice is to make these two the same, but this is not a requirement.

=== Labels must be unique ===

A common error when using {{tl|ref}} is to use it multiple times with the same label. For example:

<pre>
Text that requires a footnote.{{ref|1|1}}
Some other text that requires the same footnote.{{ref|1|1}}

==Notes==
:1.{{note|1}}Body of the footnote.
</pre>

This generates two citations with the same label, which is [[Help:Markup validation#ID already defined|invalid HTML]]. To fix the problem, use multiple unique IDs; see ''[[#More complex examples|More complex examples]]''.

=== Simple examples ===

{{tl|ref}} and {{tl|note}}

Example:
<pre style="border:1; background:white; margin: 0; padding:0; line-height: 130%; word-wrap: break-word;
white-space: -moz-pre-wrap;
white-space:   -o-pre-wrap;
white-space:     -pre-wrap;
white-space:      pre-wrap">
Article text{{ref|reference_name_A|a}} more text{{ref|reference_name_B|b}} more text {{ref|reference_name_C|c|noid=noid}}.
*Bulleted text{{ref|reference_name_B|b|noid=noid}}
*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).}}
</pre>

This would produce:
<div style="margin: 1em; padding: 1em; border:1px solid #999">
Article text{{ref|reference_name_A|a}} more text{{ref|reference_name_B|b}} more text {{ref|reference_name_C|c|noid=noid}}.
*Bulleted text{{ref|reference_name_B|b|noid=noid}}
*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).}}
</div>

Notice that the navigation back from the note to the ref does not work by clicking the backlink for refs which specify "noid=noid". In practice, if "noid=noid" is specified, it is usually specified for all refs having identical unnamed parameters, and navigation back to the associated ref is done by using the browser's "Back" button.

Also notice that browsers which support highlighting of link-accessed material highlight the active backlink by default, and that the highlighting has been extended to encompass the text for note c by specifying that text as a final template parameter instead of placing it outside of the template.

=== More complex examples ===
{{tl|ref label}} pairs with {{tl|note label}}.
The {{tl|note label}} template will normally have identical parameters with the ref label with which it is paired, and is normally created by copying the ref, pasting it into the note location, and changing its name to "note label"; this avoids having parameters mismatched because of a typo. Navigation forward uses parameters 1 and 3, navigation backward uses parameters 1 and 2. Parameter 3 is optional, and {{tl|note label}} has an optional fourth parameter.

Example:
<pre style="border:1; background:white; margin: 0; padding:0; line-height: 130%; word-wrap: break-word;
white-space: -moz-pre-wrap;
white-space:   -o-pre-wrap;
white-space:     -pre-wrap;
white-space:      pre-wrap">
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).}}}}
</pre>

This would produce:
<div style="margin: 1em; padding: 1em; border:1px solid #999">
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).}}}}
</div>
#Note that {{tl|ref label}} produces a superscripted link with square brackets. 
#The note for ref e has a "^" character as its backlink, because parameter 3 was specified as "none".
#The notes for refs f  and g do not have a clickable backlink, because parameter 3 was not specified.

Notice that, because the notes for refs g and h above use the same text, note h was made a part of the text passed as a final parameter to note g in order for the extended highlighting to cover both notes.

== Table footnotes ==

One common application for {{tl|ref}} and {{tl|note}} templates is in placing footnotes below tables, as in the following example taken from the [[Kent#Economy]] article:

To allow the preview, <nowiki><ol type="A"></nowiki> is used. to form the needed [[Help:List|list]].

{| class="wikitable"
|-
! Year || Regional GVA{{ref label|rounding|A|^}} ||COLSPAN=2| Agriculture ||COLSPAN=2| Industry{{ref label|energy|B|^}} ||COLSPAN=2| Services{{ref label|financial|C|^}}
|-
|COLSPAN=8 | 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%
|-
|COLSPAN=8 | 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%
|}
<ol type="A">
<li>{{note label|rounding|A|^}} Components may not sum to totals due to rounding
<li>{{note label|energy|B|^}} includes energy and construction
<li>{{note label|financial|C|^}} includes financial intermediation services indirectly measured
</ol>

==Alternative referencing style==

Using ref/note tags is not the only way to do [[Wikipedia:Footnotes|footnotes]]. Some people prefer to use [[mw:Extension:Cite/Cite.php|Cite.php]]. Cite.php has many advantages, but is not mandatory. You can use the [[User:Cyde/Ref converter|Ref converter]] to replace ref/note tags with the newer [[mw:Extension:Cite/Cite.php|Cite.php]] style. If you are interested in the discussion, please see the [[Wikipedia_talk:Footnotes|Footnotes talk page]]. For details of that system, please see [[Wikipedia:Footnotes]].

=== Combining Ref family templates with the alternative referencing style ===

An example combining the use of Ref-family templates with the alternative referencing style might be something like

<pre style="border:1; background:white; margin: 0; padding:0; line-height: 130%; word-wrap: break-word;
white-space: -moz-pre-wrap;
white-space:   -o-pre-wrap;
white-space:     -pre-wrap;
white-space:      pre-wrap">
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".
</pre>

which could produce something like:
{| class="wikitable" style="margin-left:10em;"
|-
|
Yammer yammer yammer.<ref name=smith2000>Smith wrote the definitive book on yammering.{{ref|Smith2000|Smith 2000}}</ref>Yammer yammer yammer.<ref name=smith2000/>

...

{{fake heading|References}}
<References/>

...

{{fake heading|Bibliography}}
*{{note|Smith2000}} Smith (2000). "A book about yammering".
|}

Also see examples and explanation in [[Wikipedia:Footnote3]].

==Third party tool==
A third-party tool to translate articles using the templates described on this page into the Cite.php system is available, see ''[[User:Cyde/Ref converter|Ref converter]]''.

== See also ==
* [[Wikipedia:Footnotes]] &mdash; Discussion about this reference method
* [[Wikipedia:Template messages/Sources of articles]]
* [[Template:Ref]] &mdash; Template for references using this method
* [[Template:Ref label]] &mdash; Same as {{tl|Ref}}, but with more features
* [[Template:Footnote label]] &mdash; Same as, and redirect to, {{tl|Ref label}}, but ignored by bots that convert {{tl|Ref label}} and {{tl|Ref}} to [[wikipedia:WP:FN|Cite.php]] references; for use of these templates for informational footnotes as opposed to reference citations
* [[Template:Note]] &mdash; Template for footnotes using this method
* [[Template:Note label]] &mdash; Same as Note, but with more features
* [[:Category:Citation templates]] &mdash; More citation templates, some of which are not part of the Ref/Note Label system

<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Citation templates|{{PAGENAME}}]]
[[Category:Inline templates|{{PAGENAME}}]]

{{#switch:{{FULLPAGENAME}}
  |Template:Ref=
<!-- ADD INTERWIKIS FOR [[Template:Ref]] BELOW THIS LINE -->

  |Template:Ref label=
<!-- ADD INTERWIKIS FOR [[Template:Ref label]] BELOW THIS LINE -->

  |Template:Note=
<!-- ADD INTERWIKIS FOR [[Template:Note]] BELOW THIS LINE -->

  |Template:Note label=
<!-- ADD INTERWIKIS FOR [[Template:Note label]] BELOW THIS LINE -->
}}</includeonly>