Template:R/doc: Difference between revisions

From Project Mailer
(No difference)

Revision as of 17:14, 31 October 2018

For redirect templates, see Wikipedia:Template messages/Redirect pages.

Intent

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/>

Displays as: For example, fact[1][2][3] and fact.[4][5][6]

Instead using {{r}} For example, fact{{r|RefName|Bam|Bar}} and fact.{{r|Bas|Bay|Baz}}

Displays as: For example, fact[1][2][3] and fact.[4][5][6]

{{r}} and <ref> can coexist on the same page, and like <ref>, {{r}} can be used with or without list-defined references. In addition, a |page= or |p= parameter adds the functionality of {{rp}}:

Using {{r}} with
|p= parameter 		For example, fact.{{r|RefName|p=22}}

Displays as: For example, fact.[1]:22

Usage

Usage Display Notes
{{r|RefName}} Text.[1] Equivalent to <ref name="RefName" />.
{{r|RefName|p=100}}

{{r|RefName|pp=100}}

{{r|RefName|page=100}}

{{r|RefName|pages=100}}

Text.[1]:100 Adds a page number (or other location identifier) within the source.

The |p=, |pp=, |page=, and |pages= parameters are equivalent.

If the article cites only one location in a given source, reduce clutter by coding simply {{r|RefName}} and integrating the location into the main RefName citation.

{{r|RefName|p=10–14}}

{{r|RefName|pp=3, 6}}

{{r|RefName|page=§C}}

{{r|RefName|pages=Dust jacket}}

{{r|RefName|pages=para. 7}}

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}}

{{r|1=RefName|p1=100|2=Bam|p2=10–14|3=Bar|4=Bas|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. |1= matches |p1=

{{r|group=Notes|NtName}}

{{r|grp=Notes|NtName|NtCam}}

{{r|g=Notes|NtName|p=13}}

Text.[Notes 1]

Text.[Notes 1][Notes 2]

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}}

{{r|RefName|p=100|quote=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/​location identifier, signaling availability of a quote from the source, which pops up when the mouse is hovered over the underlined bit.
{{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:

References
  1. ↑ 1.00 1.01 1.02 1.03 1.04 1.05 1.06 1.07 1.08 1.09 1.10 1.11 1.12 1.13 Reference text.
  2. ↑ 2.0 2.1 2.2 2.3 2.4 Bam reference text.
  3. ↑ 3.0 3.1 3.2 3.3 3.4 Bar reference text.
  4. ↑ 4.0 4.1 4.2 4.3 Bas reference text.
  5. ↑ 5.0 5.1 Bay reference text.
  6. ↑ 6.0 6.1 Baz reference text.
Notes
  1. ↑ 1.0 1.1 1.2 Note text.
  2. ↑ Cam note text.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for 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.

Template parameters

ParameterDescriptionTypeStatus
Reference groupgroup g grp

The reference group of all the references displayed; see WP:REFGROUP for help.

Default
Defaults to not being in a group.
Stringsuggested
Reference name 11

If this is "RefName", the template displays <ref name="RefName"/>.

Stringrequired
Pages number(s): reference 1page1 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.

Example
"2", "34–38", "inside cover"
Contentsuggested
Quote: reference 1q1 quote q quote1

A quote from the source. Appears when hovering over the page number, so the page number must be specified.

Stringsuggested
Reference name 22

If this is "RefName", the template displays <ref name="RefName"/>.

Stringsuggested
Pages number(s): reference 2page2 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.

Example
"2", "34–38", "inside cover"
Contentoptional
Quote: reference 2q2 quote2

A quote from the source. Appears when hovering over the page number, so the page number must be specified.

Stringoptional
Reference name 33

If this is "RefName", the template displays <ref name="RefName"/>.

Stringsuggested
Pages number(s): reference 3page3 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.

Example
"2", "34–38", "inside cover"
Contentoptional
Quote: reference 3q3 quote3

A quote from the source. Appears when hovering over the page number, so the page number must be specified.

Stringoptional
Reference name 44

If this is "RefName", the template displays <ref name="RefName"/>.

Stringoptional
Pages number(s): reference 4page4 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.

Example
"2", "34–38", "inside cover"
Contentoptional
Quote: reference 4q4 quote4

A quote from the source. Appears when hovering over the page number, so the page number must be specified.

Stringoptional
Reference name 55

If this is "RefName", the template displays <ref name="RefName"/>.

Stringoptional
Pages number(s): reference 5page5 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.

Example
"2", "34–38", "inside cover"
Contentoptional
Quote: reference 5q5 quote5

A quote from the source. Appears when hovering over the page number, so the page number must be specified.

Stringoptional
Reference name 66

If this is "RefName", the template displays <ref name="RefName"/>.

Stringoptional
Pages number(s): reference 6page6 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.

Example
"2", "34–38", "inside cover"
Contentoptional
Quote: reference 6q6 quote6

A quote from the source. Appears when hovering over the page number, so the page number must be specified.

Stringoptional
Reference name 77

If this is "RefName", the template displays <ref name="RefName"/>.

Stringoptional
Pages number(s): reference 7page7 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.

Example
"2", "34–38", "inside cover"
Contentoptional
Quote: reference 7q7 quote7

A quote from the source. Appears when hovering over the page number, so the page number must be specified.

Stringoptional
Reference name 88

If this is "RefName", the template displays <ref name="RefName"/>.

Stringoptional
Pages number(s): reference 8page8 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.

Example
"2", "34–38", "inside cover"
Contentoptional
Quote: reference 8q8 quote8

A quote from the source. Appears when hovering over the page number, so the page number must be specified.

Stringoptional
Reference name 99

If this is "RefName", the template displays <ref name="RefName"/>.

Stringoptional
Pages number(s): reference 9page9 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.

Example
"2", "34–38", "inside cover"
Contentoptional
Quote: reference 9q9 quote9

A quote from the source. Appears when hovering over the page number, so the page number must be specified.

Stringoptional

See also

Notes

  1. ↑ Here we also add alliteration.


Retrieved from "https://projectmailer.net/index.php?title=Template:R/doc&oldid=1110"