Template:Ref/doc

[template]documentation subpage[/template]
Using ref/note tags is not the only way to do [brwiki="Footnotes"]footnotes[/brwiki]. Some people prefer to use [wiki="m:Cite/Cite.php"]Cite.php[/wiki]. Cite.php has many advantages, but is not mandatory. You can use the [user="Cyde/Ref converter"]Ref converter[/user] to replace ref/note tags with the newer [wiki="m:Cite/Cite.php"]Cite.php[/wiki] style. If you are interested in the discussion, please see the [wiki="BrWiki_talk:Footnotes"]Footnotes talk page[/wiki].
[h="2"]Simple example[/h]
There are many ways to use [template]tl|Ref[/template] and [template]tl|Note[/template]. Among the simplest is:
[table] class=wikitable
!Article
!Wikitext
|-
|
Text that requires a footnote.[template]Ref|1[/template]
<b><font style="font-size:120%">Notes</font></b>
[hr][/hr]
[indent]1.[template]Note|1[/template]Body of the footnote.[/indent]
|<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:60px;">Text that requires a footnote.&#123;&#123;Ref&#124;1&#125;&#125;<br />&#61;&#61;Notes&#61;&#61;<br />&#91;indent&#93;1.&#123;&#123;Note&#124;1&#125;&# 125;Body of the footnote.&#91;/indent&#93;</pre></div>[/table]
[h="2"]Alternative referencing style[/h]
The Cite.php &lt;ref&gt; and &lt;references/&gt; system is an alternative style of referencing to the templates discussed on this page. For details on this system, please see [brwiki]Footnotes[/brwiki] and [brwiki]Cite sources[/brwiki].
A third-party tool to translate articles using the templates described on this page into the Cite.php system is available, see [i][user="Cyde/Ref converter"]Ref converter[/user][/i].
[h="2"] Usage [/h]
For multiple links to one citation in the Reference section, use different [b]id[/b] values ("a", "b", etc.), beginning with the first citation. The "id" is used to make multiple backlinks from the note.
[h="3"]Ref-family templates and Links[/h]
The [template]tl|ref[/template] family of templates is used to place links into an article. Each link is identified with a [i]reference_name[/i] parameter which is used to generate an invisible name to link it with a matching [template]tl|note[/template] template sharing that invisible name. [template]tl|note[/template] templates are usually located just prior to a footnote or other referenced item. It is sometimes useful to use [template]tl|ref[/template] templates more than once with the same reference_name. Whenever that is done, an optional parameter [i]noid=noid[/i] should be specified, in exactly that form. The backlink supplied by the matching [template]tl|note[/template] template will be paired with the [template]tl|ref[/template] template instance with the matching [i]reference-name[/i] parameter and in which the optional [i]noid=noid[/i] parameter was not supplied.
[h="4"] Simple [/h]
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:84px;">fuu&#123;&#123;ref&#124;reference&#95;name&#95;A& #125;&#125;<br />fuu&#123;&#123;ref&#124;reference&#95;name&#95;B& #125;&#125;<br />fuu&#123;&#123;ref&#124;reference&#95;name&#95;B& #124;noid&#61;noid&#125;&#125;<br />fuu&#123;&#123;ref&#124;reference&#95;name&#95;C& #124;label&#125;&#125;<br />fuu&#123;&#123;ref&#124;reference&#95;name&#95;C& #124;label&#124;noid&#61;noid&#125;&#125;</pre></div>This creates simple links to three separate footnotes, with "reference_name_A", etc. being unique invisible names which are used to create a clickable link to a matching [template]tl|note[/template] template placed at the footnote locations. The backlink from the [template]tl|Note[/template] template at the footnote location would pair with the [template]tl|ref[/template] template for which the [i]noid=noid[/i] parameter was not supplied. A superscripted clickable link surrounded by square brackets is generated. If supplied, the optional second parameter is used to label the clickable link.
[indent]fuu[template]ref|reference_name_A[/template]<br>[/indent]:fuu[template]ref|reference_name_B[/template]<br>
[indent]fuu[template]ref|reference_name_B|noid=noi d[/template]<br>[/indent]:fuu[template]ref|reference_name_C|label[/template]<br>
[indent]fuu[template]ref|reference_name_C|label|no id=noid[/template][/indent]
[h="4"] Complex [/h]
There are three complex Ref-family templates: [template]tl|ref label[/template], [template]tl|ref harvard[/template] and [template]tl|ref harv[/template]. These all pair up with a matching [template]tl|note label[/template] template. All of these, and the matching [template]tl|note label[/template] template have three required parameters: [i]reference_name[/i], [i]label[/i], and [i]id[/i]. The invisible name used to link these templates to the matching [template]tl|note label[/template] template is formed by concatenating the first and third parameters (i.e., "referencenameid"). If a particular [i]reference_name[/i] and [i]id[/i] parameter pair is used more than once, the optional [i]noid=noid[/i] parameter should be supplied in all but one instance.
[h="4"] Ref label [/h]
[template]tl|ref label[/template] displays the clickable link using the [i]label[/i] parameter, surrounded by square-brackets and superscripted.
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:36px;">fuu&#123;&#123;ref label&#124;reference&#95;name&#95;D&#124;label&#12 4;id&#125;&#125;</pre></div>:fuu[template]ref label|reference_name_D|label|id[/template]<br />
[h="4"] Harvard [/h]
[template]tl|ref harvard[/template] displays the clickable link using the [i]label[/i] parameter, surrounded by parentheses but not superscripted.
[template]tl|ref harv[/template] displays the clickable link using the [i]'label[/i] parameter, surrounded by parentheses and superscripted.
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:60px;">fuu&#123;&#123;ref harvard&#124;reference&#95;name&#95;E&#124;Harvard reference&#124;id&#95;1&#125;&#125;<br />fuu&#123;&#123;ref harv&#124;reference&#95;name&#95;E&#124;Harvard reference&#124;id&#95;2&#125;&#125;<br />fuu&#123;&#123;ref harv&#124;reference&#95;name&#95;E&#124;Harvard reference&#124;id&#95;2&#124;noid&#61;noid&#125;&# 125;</pre></div>:fuu[template]ref harvard|reference_name_E|Harvard reference|id_1[/template]<br />
[indent]fuu[template]ref harv|reference_name_E|Harvard reference|id_2[/template]<br />[/indent]:fuu[template]ref harv|reference_name_E|Harvard reference|id_2|noid=noid[/template]
[h="3"] Note templates and backlinks [/h]
There are two Note-family templates: [template]tl|note[/template] and [template]tl|note label[/template]. These templates are usually placed just prior to the location of a footnote or other item referenced in the text by matching [template]tl|ref[/template] family templates. The parameters in these templates match the parameters in the [template]tl|ref[/template], and it is often convenient to copy a particular [template]tl|ref[/template] template instance to the [template]tl|note[/template] location, and change the name of the copied template from [i]ref[/i] to [i]note[/i] or from [i]ref (whatever)[/i] to [i]note label[/i] . Any parameters which are not required by [template]tl|note[/template] templates are ignored if supplied.
[h="4"] Simple [/h]
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:48px;">&#42;&#123;&#123;note&#124;reference&#95;name&#95 ;A&#125;&#125;bar<br />&#42;&#123;&#123;note&#124;reference&#95;name&#95 ;C&#124;label&#125;&#125;bar</pre></div>Creates a simple footnote for the reference with the invisible unique id [i]reference_name[/i] and generates a clickable backlink to the [template]tl|ref[/template] template with the matching [i]reference_name[/i] and in which the [i]noid=noid[/i] is not specified.
[indent]*[template]note|reference_name_A[/template]bar[/indent]:*[template]note|reference_name_C|label[/template]bar
[h="4"] Complex [/h]
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:36px;">&#42;&#123;&#123;note label&#124;reference&#95;name&#124;number&#124;id& #125;&#125;bar</pre></div>Creates a clickable link labeled with the [i]id[/i] parameter, and paired with the [template]tl|ref label[/template] instance which has matching [i]reference_name[/i] and [i]id[/i] parameters. The [i]label[/i] parameter is not used and is ignored.
[indent]*[template]note label|reference_name|number|id[/template]bar[/indent]
A footnote which is cited from multiple locations in the text might have multiple [template]tl|note label[/template] instances associated with it.
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:36px;">&#42;&#123;&#123;note label&#124;Smith2000&#124;Smith 2000:12&#124;a&#125;&#125;&#123;&#123;note label&#124;Smith2000&#124;Smith 2000:45:&#124;b&#125;&#125; Smith (2000), "A book about yammering".</pre></div>which could produce something like
[indent]*[template]note label|Smith2000|Smith 2000:12|a[/template][template]note label|Smith2000|Smith 2000:45:|b[/template] Smith (2000), "A book about yammering".[/indent]
[h="2"] Examples [/h]
=== Combining Ref and Note 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
<div class="bbcode_container"> <div class="bbcode_description">Code:</div> <pre class="bbcode_code" style="height:120px;">Yammer yammer yammer.&lt;ref name&#61;smith2000&gt;Smith wrote the definitive book on yammering.&#123;&#123;ref&#124;Smith2000&#124;Smit h 2000&#125;&#125;<br />&lt;/ref&gt;Yammer yammer yammer.&lt;ref name&#61;smith2000/&gt;<br />...<br />&#61;&#61;References&#61;&#61;<br />&lt;References/&gt;<br />...<br />&#61;&#61;Bibliography&#61;&#61;<br />&#42;&#123;&#123;note&#124;Smith2000&#125;&#125 ;, Smith 2000, "A book about yammering".</pre></div>which could produce something like:
[indent]Yammer yammer yammer.<ref name=smith2000>Smith wrote the definitive book on yammering.[template]ref|Smith2000|Smith 2000[/template]</ref>Yammer yammer yammer.<ref name=smith2000/>[/indent]:...
[indent]==References==[/indent]:<References/>
[indent]...[/indent]:==Bibliography==
[indent]*[template]note|Smith2000[/template], Smith 2000, "A book about yammering".[/indent]
Also see examples and explanation in [brwiki]Footnote3[/brwiki].
[h="3"] Table footnotes [/h]
One common application for [template]tl|ref[/template] and [template]tl|notes[/template] templates is in placing footnotes below tables, as in the following example taken from [wiki]Kent#Economy[/wiki]:
[indent][table] class="wikitable"[/indent]|-
! Year || Regional GVA[template]ref label|rounding|A|A[/template] ||COLSPAN=2| Agriculture ||COLSPAN=2| Industry[template]ref label|energy|B|B[/template] ||COLSPAN=2| Services[template]ref label|financial|C|C[/template]
|-
|COLSPAN=8 | County of Kent (excluding Medway)
|-
| 1995 || [b]12,369[/b] || 379 || 3.1% || 3,886 || 31.4% || 8,104 || 65.5%
|-
| 2000 || [b]15,259[/b] || 259 || 1.7% || 4,601 || 30.2% || 10,399 || 68.1%
|-
| 2003 || [b]18,126[/b] || 287 || 1.6% || 5,057 || 27.9% || 12,783 || 70.5%
|-
|COLSPAN=8 | Medway
|-
| 1995 || [b]1,823[/b] || 21 || 3.1% || 560 || 31.4% || 1,243 || 68.2%
|-
| 2000 || [b]2,348[/b] || 8 || 1.7% || 745 || 30.2% || 1,595 || 67.9%
|-
| 2003 || [b]2,671[/b] || 10 || 1.6% || 802 || 27.9% || 1,859 || 69.6%
[/table]
[indent][template]note label|rounding|A|A[/template] Components may not sum to totals due to rounding[/indent]:[template]note label|energy|B|B[/template] includes energy and construction
[indent][template]note label|financial|C|C[/template] includes financial intermediation services indirectly measured[/indent]
[h="3"] Further examples [/h]
[template]Confusing|date=December 2006[/template]
The following examples from [template]tl|Ref/examples[/template] are rendered as a template in the following table:
[template]Ref/examples[/template]
Also see examples and explanation in [brwiki]Footnote3[/brwiki].
[h="2"]Instructions[/h]
In an article, a [wiki="Reference#Scholarship"]reference[/wiki] link to supporting material can be made with the [b][template]tl|ref[/template][/b] template, such as this[template]ref|ref_example[/template]. (Note the link to the reference's footnote; at present it appears as a small number.)
A significant advantage of using this method is that the reference contains a named link which allows recovery from various edit problems. Otherwise, connections to references can be lost if only numbers are used and editors alter footnote numbers.
[list][*]For multiple references to the same work it is suggested that the [i]page number[/i] be used to make each reference unique, i.e. [i]&#123;&#123;ref&#124;Jones1954a&#45;25&#125;&#1 25;[/i].
[*]For journal articles it is suggested a reference similar to [i]AuthorYear[/i] be used, i.e. [i]&#123;&#123;ref&#124;Jones1954a&#125;&#125;[/i].
[/redirect]
[list][*]Instructions for adding a citations using these templates:
[/redirect]
[indent]:Footnotes use names, not numbers. Please see [brwiki]Footnote3[/brwiki] for details.[/indent]:::1) Assign your footnote a unique name, for example "TheSun_Dec9".
[indent]::2) Add the template &#123;&#123;ref&#124;TheSun&#95;Dec9&#125;&#125 ; to the body of the article where you want the new footnote.[/indent]:::3) Take note of the name of the footnote that immediately proceeds yours in the article body.
[indent]::4) Add &#35;&#123;&#123;Note&#124;TheSun&#95;Dec9&#125;&# 125; to the reference list, immediately below the footnote you noted in step 3.[/indent]:::5) Multiple sources in the text pointing to the same reference will not work: each source must have uniquely-named notes in the References section.
[indent]It is important to add the citations in the right order in the Reference (or Notes) list.[/indent][list][*]These templates can be used in conjunction with other non-linking templates at [brwiki]Cite_sources/example_style[/brwiki] and [brwiki]Template_messages/Sources_of_articles/Generic_citations[/brwiki]. All citations are listed at [brwiki]Template_messages/Sources_of_articles[/brwiki] as well.
[/redirect]
[h="3"]References (example for Notes)[/h]
[list=1][*](used earlier)
[*][template]note|ref_example[/template] This is a [wiki]footnote[/wiki] with supporting material to the above reference. This footnote is created with the template syntax: &#123;&#123;note&#124;ref&#95;example&#125;&#12 5;. The [b][template]tl|note[/template][/b] template presently creates a small symbol ("^") that contains a link back up to the source in the text. Readers thus have links back and forth within the text. The number at the beginning of this line was created with the Wiki notation [b]&#35; [/b] placed at the beginning of the line, which only displays a numbered list. The matching number is not necessary, and [b][brwiki]Cite sources[/brwiki][/b] suggests using the bulleted list notation: [b]&#42; [/b]
[/redirect]
[h="2"] See also [/h]
[list][*] [brwiki]Footnotes[/brwiki] &mdash; Discussion about this reference method
[*] [brwiki]Template messages/Sources of articles[/brwiki]
[*] [template="Ref"]Ref[/template] &mdash; Template for references using this method
[*] [template="Ref label"]Ref label[/template] &mdash; Same as [template]tl|Ref[/template], but with more features
[*] [template="Footnote label"]Footnote label[/template] &mdash; Same as, and redirect to, [template]tl|Ref label[/template], but ignored by bots that convert [template]tl|Ref label[/template] and [template]tl|Ref[/template] to [wiki="WP:FN"]Cite.php[/wiki] references; for use of these templates for informational footnotes as opposed to reference citations
[*] [template="Note"]Note[/template] &mdash; Template for footnotes using this method
[*] [template="Note label"]Note label[/template] &mdash; Same as Note, but with more features
[*] [category=Citation templates]Citation templates[/category] &mdash; More citation templates, some of which are not part of the Ref/Note Label system
[/redirect]