Template:R/doc
 | This is a documentation subpage for Template:R (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
Intent[edit]
Provides a compact shorthand for <ref name="RefName" /> citation tags, simplifying syntax so cutting code clutter.[note 1]
For example:
Using <ref>
|
For example, fact<ref name=RefName/><ref name=Bam/><ref name=Bar/> and fact.<ref name=Bas/><ref name=Bay/><ref name=Baz/>
|
|---|---|
Instead using {{r}}
|
For example, fact{{r|RefName|Bam|Bar}} and fact.{{r|Bas|Bay|Baz}}
|
{{r}} and <ref> can coexist on the same page, and like <ref>, {{r}} can be used with or without list-defined references:
Using {{r}} with|p= parameter
|
For example, fact.{{r|RefName|p=22}}
Displays as: For example, fact.[1]:22 |
|---|
Usage[edit]
| Usage | Display | Notes |
|---|---|---|
{{r|RefName}}
|
Text.[1] | Equivalent to <ref name="RefName" />.
|
{{r|RefName|p=100}}
|
Text.[1]:100 | Adds a page number (or other location identifier) within the source.
The If the article cites only one location in a given source, reduce clutter by coding simply |
{{r|RefName|p=10–14}}
|
Text.[1]:10–14
Text.[1]:3, 6 Text.[1]:§C Text.[1]:Dust jacket Text.[1]:para. 7 | |
{{r|RefName|Bam|Bar}}
|
Text.[1][2][3] | Equivalent to {{r|RefName}}{{r|Bam}}{{r|Bar}} or <ref name=RefName/><ref name=Bam/><ref name=Bar/>.
Up to nine references may be "bundled" this way. |
{{r|1=RefName|2=Bam|3=Bar|4=Bas|p1=100|p2=10–14|p4=§C}}
|
Text.[1]:100[2]:10–14[3][4]:§C | Equivalent to {{r|RefName|p=100}}{{r|Bam|p=10–14}}{{r|Bar}}{{r|Bas|p=§C}}.
In the example, not all references have pages; make sure that e.g. |
{{r|group=Notes|NtName}}
|
Text.[Notes 1]
Text.[Notes 1]:13 |
The |group=, |grp=, and |g= parameters are equivalent and echo <ref group=Notes name=NtName/>.
If present, the parameter applies to all references in the template. |
{{r|RefName|p=100|q=quote from the text}}
|
Text.[1]:100 | Makes sense only if |p= (or one of its synonyms) is present. |quote= (or |q=) underlines the superscript page number/ |
{{r|1=RefName|2=Bam|3=Bar|4=Bas|p1=100|p2=10–14|p4=§C|q1=Quote from 100|q4=Quote from §C}}
|
Text.[1]:100[2]:10–14[3][4]:§C | In the example, not all references have quotes; make sure that e.g. |1= and |p1= and |q1= all match.
|
The ref names may be defined within a {{reflist}} (as illustrated below) or (in the more usual way) scattered throughout the article text using e.g. <ref name=RefName>Reference text</ref> or {{refn|name=RefName|Reference text}}.
===References===
{{reflist|refs=
<ref name=RefName>Reference text.</ref>
<ref name=Bam>Bam reference text.</ref>
<ref name=Bar>Bar reference text.</ref>
<ref name=Bas>Bas reference text.</ref>
<ref name=Bay>Bay reference text.</ref>
<ref name=Baz>Baz reference text.</ref>
}}
===Notes===
{{reflist|group=Notes|refs=
<ref name=NtName>Note text.</ref>
<ref name=NtCam>Cam note text.</ref>
}}
Resulting in:
TemplateData[edit]
R
Provides a simple wrapper for up to nine consecutive <ref name=RefName/> citation tags that minimizes visual impact on the text which, along with the simpler syntax, increases code readability and ease of editing.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Reference group | group g grp | The reference group of all the references displayed; see WP:REFGROUP for help.
| String | suggested |
| Reference name 1 | 1 | If this is "RefName", the template displays <ref name="RefName"/>. | String | required |
| Pages number(s): reference 1 | page1 p page pages pp p1 pages1 pp1 | Adds a page number (or other location identifier) within the source. Note that you can also put this information in the original reference instead so it need only be stated once.
| Content | suggested |
| Quote: reference 1 | q1 quote q quote1 | A quote from the source. Appears when hovering over the page number, so the page number must be specified. | String | suggested |
| Reference name 2 | 2 | If this is "RefName", the template displays <ref name="RefName"/>. | String | suggested |
| Pages number(s): reference 2 | page2 p2 pages2 pp2 | Adds a page number (or other location identifier) within the source. Note that you can also put this information in the original reference instead so it need only be stated once.
| Content | optional |
| Quote: reference 2 | q2 quote2 | A quote from the source. Appears when hovering over the page number, so the page number must be specified. | String | optional |
| Reference name 3 | 3 | If this is "RefName", the template displays <ref name="RefName"/>. | String | suggested |
| Pages number(s): reference 3 | page3 p3 pages3 pp3 | Adds a page number (or other location identifier) within the source. Note that you can also put this information in the original reference instead so it need only be stated once.
| Content | optional |
| Quote: reference 3 | q3 quote3 | A quote from the source. Appears when hovering over the page number, so the page number must be specified. | String | optional |
| Reference name 4 | 4 | If this is "RefName", the template displays <ref name="RefName"/>. | String | optional |
| Pages number(s): reference 4 | page4 p4 pages4 pp4 | Adds a page number (or other location identifier) within the source. Note that you can also put this information in the original reference instead so it need only be stated once.
| Content | optional |
| Quote: reference 4 | q4 quote4 | A quote from the source. Appears when hovering over the page number, so the page number must be specified. | String | optional |
| Reference name 5 | 5 | If this is "RefName", the template displays <ref name="RefName"/>. | String | optional |
| Pages number(s): reference 5 | page5 p5 pages5 pp5 | Adds a page number (or other location identifier) within the source. Note that you can also put this information in the original reference instead so it need only be stated once.
| Content | optional |
| Quote: reference 5 | q5 quote5 | A quote from the source. Appears when hovering over the page number, so the page number must be specified. | String | optional |
| Reference name 6 | 6 | If this is "RefName", the template displays <ref name="RefName"/>. | String | optional |
| Pages number(s): reference 6 | page6 p6 pages6 pp6 | Adds a page number (or other location identifier) within the source. Note that you can also put this information in the original reference instead so it need only be stated once.
| Content | optional |
| Quote: reference 6 | q6 quote6 | A quote from the source. Appears when hovering over the page number, so the page number must be specified. | String | optional |
| Reference name 7 | 7 | If this is "RefName", the template displays <ref name="RefName"/>. | String | optional |
| Pages number(s): reference 7 | page7 p7 pages7 pp7 | Adds a page number (or other location identifier) within the source. Note that you can also put this information in the original reference instead so it need only be stated once.
| Content | optional |
| Quote: reference 7 | q7 quote7 | A quote from the source. Appears when hovering over the page number, so the page number must be specified. | String | optional |
| Reference name 8 | 8 | If this is "RefName", the template displays <ref name="RefName"/>. | String | optional |
| Pages number(s): reference 8 | page8 p8 pages8 pp8 | Adds a page number (or other location identifier) within the source. Note that you can also put this information in the original reference instead so it need only be stated once.
| Content | optional |
| Quote: reference 8 | q8 quote8 | A quote from the source. Appears when hovering over the page number, so the page number must be specified. | String | optional |
| Reference name 9 | 9 | If this is "RefName", the template displays <ref name="RefName"/>. | String | optional |
| Pages number(s): reference 9 | page9 p9 pages9 pp9 | Adds a page number (or other location identifier) within the source. Note that you can also put this information in the original reference instead so it need only be stated once.
| Content | optional |
| Quote: reference 9 | q9 quote9 | A quote from the source. Appears when hovering over the page number, so the page number must be specified. | String | optional |
See also[edit]
- {{sfn}}, a template that implements the most common way of citing multiple pages of the same source.
Notes[edit]
- ^ Here we also add alliteration.