Teamplaid:R/documentation

This is a documentation subpage for Teamplaid:R.
It contains usage information, categories and other content that is not part of the original teamplaid page.

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=Bal/><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\|Bal\|Bam\|Bar}} and fact.{{R\|Bas\|Bay\|Baz}}` Displays as: For example, fact^[7]^[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.^[7]^:22

Ùsaid - Usage

Usage	Display	Notes
`{{R\|RefName}}`	Text.^[7]	Equivalent to `<ref name="RefName" />`.
`{{R\|RefName\|p=100}}` `{{R\|RefName\|pp=100}}` `{{R\|RefName\|page=100}}` `{{R\|RefName\|pages=100}}`	Text.^[7]^: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.^[7]^:10–14 Text.^[7]^{:3, 6} Text.^[7]^:§C Text.^[7]^{:Dust jacket} Text.^[7]^{:Para. 7}
`{{R\|RefName\|Bam\|Bar}}`	Text.^[7]^[2]^[3]	Equivalent to `{{R\|RefName}}{{R\|Bam}}{{R\|Bar}}` or Teamplaid:Nobr Up to nine references may be "bundled" this way.
Teamplaid:Nobr `{{R\|1=RefName\|p1=100\|2=Bam\|p2=10–14\|3=Bar\|4=Bas\|p4=§C}}`	Teamplaid:Nobr	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	group=, `\|grp=`, and `\|g=` parameters are equivalent and echo Teamplaid:Nobr 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.^[7]^:100	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.^[7]^:100^[2]^:10–14^[3]^[4]^:§C	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. Teamplaid:Nobr or Teamplaid:Nobr.

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

↑ Mearachd leis an tùs: Invalid <ref> tag; no text was provided for refs named Bal
↑ ^2.0 ^2.1 ^2.2 ^2.3 Bam reference text.
↑ ^3.0 ^3.1 ^3.2 ^3.3 Bar reference text.
↑ ^4.0 ^4.1 ^4.2 Bas reference text.
↑ ^5.0 ^5.1 Bay reference text.
↑ ^6.0 ^6.1 Baz reference text.
↑ ^7.00 ^7.01 ^7.02 ^7.03 ^7.04 ^7.05 ^7.06 ^7.07 ^7.08 ^7.09 ^7.10 ^7.11 Reference text.

Notes

↑ ^1.0 ^1.1 ^1.2 Note text.
↑ Cam note text.

Teamplaid-dàta - TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

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.

Paramadairean na teamplaide[Stiùirich an TemplateData]
Paramadair		Tuairisgeul	Seòrsa	Staid
Reference group	`group` `g` `grp`	The reference group of all the references displayed; see WP:REFGROUP for help. Bun-roghainn Defaults to not being in a group.	Sreang	molta
Reference name 1	`1`	If this is "RefName", the template displays <ref name="RefName"/>.	Sreang	riatanach
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. Ball-eisimpleir "2", "34–38", "inside cover"	Susbaint	molta
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.	Sreang	molta
Reference name 2	`2`	If this is "RefName", the template displays <ref name="RefName"/>.	Sreang	molta
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. Ball-eisimpleir "2", "34–38", "inside cover"	Susbaint	roghainneil
Quote: reference 2	`q2` `quote2`	A quote from the source. Appears when hovering over the page number, so the page number must be specified.	Sreang	roghainneil
Reference name 3	`3`	If this is "RefName", the template displays <ref name="RefName"/>.	Sreang	molta
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. Ball-eisimpleir "2", "34–38", "inside cover"	Susbaint	roghainneil
Quote: reference 3	`q3` `quote3`	A quote from the source. Appears when hovering over the page number, so the page number must be specified.	Sreang	roghainneil
Reference name 4	`4`	If this is "RefName", the template displays <ref name="RefName"/>.	Sreang	roghainneil
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. Ball-eisimpleir "2", "34–38", "inside cover"	Susbaint	roghainneil
Quote: reference 4	`q4` `quote4`	A quote from the source. Appears when hovering over the page number, so the page number must be specified.	Sreang	roghainneil
Reference name 5	`5`	If this is "RefName", the template displays <ref name="RefName"/>.	Sreang	roghainneil
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. Ball-eisimpleir "2", "34–38", "inside cover"	Susbaint	roghainneil
Quote: reference 5	`q5` `quote5`	A quote from the source. Appears when hovering over the page number, so the page number must be specified.	Sreang	roghainneil
Reference name 6	`6`	If this is "RefName", the template displays <ref name="RefName"/>.	Sreang	roghainneil
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. Ball-eisimpleir "2", "34–38", "inside cover"	Susbaint	roghainneil
Quote: reference 6	`q6` `quote6`	A quote from the source. Appears when hovering over the page number, so the page number must be specified.	Sreang	roghainneil
Reference name 7	`7`	If this is "RefName", the template displays <ref name="RefName"/>.	Sreang	roghainneil
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. Ball-eisimpleir "2", "34–38", "inside cover"	Susbaint	roghainneil
Quote: reference 7	`q7` `quote7`	A quote from the source. Appears when hovering over the page number, so the page number must be specified.	Sreang	roghainneil
Reference name 8	`8`	If this is "RefName", the template displays <ref name="RefName"/>.	Sreang	roghainneil
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. Ball-eisimpleir "2", "34–38", "inside cover"	Susbaint	roghainneil
Quote: reference 8	`q8` `quote8`	A quote from the source. Appears when hovering over the page number, so the page number must be specified.	Sreang	roghainneil
Reference name 9	`9`	If this is "RefName", the template displays <ref name="RefName"/>.	Sreang	roghainneil
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. Ball-eisimpleir "2", "34–38", "inside cover"	Susbaint	roghainneil
Quote: reference 9	`q9` `quote9`	A quote from the source. Appears when hovering over the page number, so the page number must be specified.	Sreang	roghainneil

Faic cuideachd - Also see

Help:List-defined references, which provides all the specifications for using List-defined references, especially with regard to naming references and groups.
Shortened footnotes in Wikipedia:Citing sources, which describes the most common way of citing multiple pages of the same source.
{{Sfn}}, a template that implements the most common way of citing multiple pages of the same source.
Citation bundling in Wikipedia:Citing sources, a recommended way of combining a list of several consecutive footnotes into a single footnote.
Wikipedia:Footnotes
Wikipedia:Citing sources

Nòtaichean - Notes

↑ Here we also add alliteration.

[Bal-2] Mearachd leis an tùs: Invalid <ref> tag; no text was provided for refs named Bal

[Bam-3] 2.0 ^2.1 ^2.2 ^2.3 Bam reference text.

[Bar-4] 3.0 ^3.1 ^3.2 ^3.3 Bar reference text.

[Bas-5] 4.0 ^4.1 ^4.2 Bas reference text.

[Bay-6] 5.0 ^5.1 Bay reference text.

[Baz-7] 6.0 ^6.1 Baz reference text.

[RefName-8] 7.00 ^7.01 ^7.02 ^7.03 ^7.04 ^7.05 ^7.06 ^7.07 ^7.08 ^7.09 ^7.10 ^7.11 Reference text.

[NtName-9] 1.0 ^1.1 ^1.2 Note text.

[NtCam-10] Cam note text.

[1] Here we also add alliteration.

[note 1]

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[Notes 1]

[Notes 2]

Usage	Display	Notes
`{{R\|RefName}}`	Text.^[7]	Equivalent to `<ref name="RefName" />`.
`{{R\|RefName\|p=100}}` `{{R\|RefName\|pp=100}}` `{{R\|RefName\|page=100}}` `{{R\|RefName\|pages=100}}`	Text.^[7]^: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.^[7]^:10–14 Text.^[7]^{:3, 6} Text.^[7]^:§C Text.^[7]^{:Dust jacket} Text.^[7]^{:Para. 7}
`{{R\|RefName\|Bam\|Bar}}`	Text.^[7]^[2]^[3]	Equivalent to `{{R\|RefName}}{{R\|Bam}}{{R\|Bar}}` or Teamplaid:Nobr Up to nine references may be "bundled" this way.
Teamplaid:Nobr `{{R\|1=RefName\|p1=100\|2=Bam\|p2=10–14\|3=Bar\|4=Bas\|p4=§C}}`	Teamplaid:Nobr	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	group=, `\|grp=`, and `\|g=` parameters are equivalent and echo Teamplaid:Nobr 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.^[7]^:100	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.^[7]^:100^[2]^:10–14^[3]^[4]^:§C	1= and `\|p1=` and `\|q1=` all match.