View source for Template:R/doc

{{Documentation subpage}}
{{二次利用}}
{{for2|[[WP:RCAT|redirect templates]]|[[Wikipedia:Template messages/Redirect pages]]|the [[WP:NAVBOX|navigation box]] regarding the letter [[R]]|[[Template:LetterR]]}}
{{Notice|This template may soon be obsolete and deprecated: [[m:WMDE Technical Wishes/Book referencing]] would make it unnecessary. This expansion of MediaWiki's built-in {{xtag|ref|s}} syntax is already working at some wikis, but has not yet been implemented at English Wikipedia, {{as of|2020|08|lc=y|post=.}}}}

==Intent==
Provides a compact shorthand for [[mw:Extension:Cite/Cite.php|<code>&lt;ref name="RefName" /&gt;</code> citation tags]], simplifying syntax so cutting code clutter.<ref group=note>Here we also add alliteration.</ref> 

For example:
{| class="wikitable"
|-
! Using <code>&lt;ref&gt;</code>
| <code><nowiki>For example, fact<ref name=Bal/><ref name=Bam/><ref name=Bar/> and fact.<ref name=Bas/><ref name=Bay/><ref name=Baz/></nowiki></code>

''Displays as'': For example, fact<ref name=Bal/><ref name=Bam/><ref name=Bar/> and fact.<ref name=Bas/><ref name=Bay/><ref name=Baz/>
|-
! Instead using {{tnull|r}}
| <code><nowiki>For example, fact{{r|Bal|Bam|Bar}} and fact.{{r|Bas|Bay|Baz}}</nowiki></code>

''Displays as'': For example, fact{{r|Bal|Bam|Bar}} and fact.{{r|Bas|Bay|Baz}}
|}

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

{| class="wikitable"
|-
! Using {{tnull|r}} with<br/><code><nowiki>|p=</nowiki></code> parameter
| <code><nowiki>For example, fact.{{r|RefName|p=22}}</nowiki></code>

''Displays as'': For example, fact.{{r|RefName|p=22}}
|}

==Usage==
{| class="wikitable"
|-
! Usage
! Display
! Notes
|-
| <code><nowiki>{{r|RefName}}</nowiki></code> 
| Text.{{r|RefName}}
| Equivalent to <code><nowiki><ref name="RefName" /></nowiki></code>.
|-
| <code><nowiki>{{r|RefName|p=100}}</nowiki></code>

<code><nowiki>{{r|RefName|pp=100}}</nowiki></code>

<code><nowiki>{{r|RefName|page=100}}</nowiki></code>

<code><nowiki>{{r|RefName|pages=100}}</nowiki></code>
| Text.{{r|RefName|p=100}} 
| rowspan="2"| Adds a page number (or other location identifier) within the source.

The {{para|p}}, {{para|pp}}, {{para|page}}, and {{para|pages}} parameters are equivalent.

If the article cites only one location in a given source, reduce clutter by coding simply <code><nowiki>{{r|RefName}}</nowiki></code> and integrating the location into the main ''RefName'' citation.
|-
| <code><nowiki>{{r|RefName|p=10&ndash;14}}</nowiki></code>

<code><nowiki>{{r|RefName|pp=3, 6}}</nowiki></code>

<code><nowiki>{{r|RefName|page=&sect;C}}</nowiki></code>

<code><nowiki>{{r|RefName|pages=Dust jacket}}</nowiki></code>

<code><nowiki>{{r|RefName|pages=para. 7}}</nowiki></code>
| Text.{{r|RefName|p=10&ndash;14}}

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

Text.{{r|RefName|page=&sect;C}}

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

Text.{{r|RefName|pages=para. 7}}
|- 
| <code><nowiki>{{r|RefName|Bam|Bar}}</nowiki></code>
| Text.{{r|RefName|Bam|Bar}}
| Equivalent to <code><nowiki>{{r|RefName}}{{r|Bam}}{{r|Bar}}</nowiki></code> or {{nobr|<code><nowiki><ref name=RefName/><ref name=Bam/><ref name=Bar/></nowiki></code>.}}

Up to nine references may be "bundled" this way. <!--NOBREAK ON WIDEST EXAMPLES ESTABLISHES COLUMN WIDTHS-->
|-
| {{nobr| <code><nowiki>{{r|1=RefName|2=Bam|3=Bar</nowiki><nowiki>|4=Bas|p1=100|p2=10&ndash;14|p4=&sect;C}}</nowiki></code>}}

<code><nowiki>{{r|1=RefName|p1=100|2=Bam</nowiki><nowiki>|p2=10&ndash;14|3=Bar|4=Bas|p4=&sect;C}}</nowiki></code>

| {{nobr| Text.{{r|RefName|Bam|Bar|Bas|p1=100|p2=10&ndash;14|p4=&sect;C}}}}         
| Equivalent to <code><nowiki>{{r|RefName|p=100}}{{r|Bam|p=10&ndash;14}}{{r|Bar}}{{r|Bas|p=&sect;C}}</nowiki></code>.

In the example, not all references have pages; make sure that e.g. {{para|1}} matches {{para|p1}}
|-
| <code><nowiki>{{r|group=Notes|NtName}}</nowiki></code>

<code><nowiki>{{r|grp=Notes|NtName|NtCam}}</nowiki></code>

<code><nowiki>{{r|g=Notes|NtName|p=13}}</nowiki></code>
| Text.{{r|group=Notes|NtName}}

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

Text.{{r|g=Notes|NtName|p=13}}
| The {{para|group}}, {{para|grp}}, and {{para|g}} parameters are equivalent and echo {{nobr|<code><nowiki><ref group=Notes name=NtName/></nowiki></code>.}}

If present, the parameter applies to all references in the template.

|-
| <code><nowiki>{{r|RefName|p=100|q=quote from the text}}</nowiki></code>

<code><nowiki>{{r|RefName|p=100|quote=quote from the text}}</nowiki></code>

|Text.{{r|RefName|p=100|q=quote from the text}}
|Makes sense only if {{para|p}} (or one of its synonyms) is present. {{para|quote}} (or {{para|q}}) underlines the superscript page number/{{wbr}}location identifier, signaling availability of a quote from the source, which pops up when the mouse is hovered over the underlined bit. Not compatible with raw apostrophe ('); use &amp;apos; instead. Raw double quote (") works. Curved quotes are disfavored by [[MOS:STRAIGHT]].
|-
|<code><nowiki>{{r|1=RefName|2=Bam|3=Bar|4=Bas|p1=100|p2=10&ndash;14|p4=&sect;C|q1=Quote from 100|q4=Quote from &sect;C}}</nowiki></code>
||Text.{{r|1=RefName|2=Bam|3=Bar|4=Bas|p1=100|p2=10&ndash;14|p4=&sect;C|q1=Quote from 100|q4=Quote from &sect;C}}
|In the example, not all references have quotes; make sure that e.g. {{para|1}} and {{para|p1}} and {{para|q1}} all match.
|}

The ref names may be defined within a {{t|reflist}} (as illustrated below) or (in the more usual way) scattered throughout the article text using e.g. {{nobr|<code><nowiki><ref name=RefName>Reference text</ref></nowiki></code>}} or {{nobr|<code><nowiki>{{refn|name=RefName|Reference text}}</nowiki></code>}}.

<pre>
===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>
}}
</pre>

Resulting in:
<div style="padding-left:1em;border-left:1px solid #9ad">
{{fake heading|sub=3|References}}
{{reflist|refs=
<ref name=RefName>Reference text.</ref>
<ref name=Bal>Bal 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>
}}

{{fake heading|sub=3|Notes}}
{{reflist|group=Notes|refs=
<ref name=NtName>Note text.</ref>
<ref name=NtCam>Cam note text.</ref>
}}
</div>

==TemplateData==
{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Reference name 1",
			"description": "If this is \"RefName\", the template displays <ref name=\"RefName\"/>.",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "Reference name 2",
			"description": "If this is \"RefName\", the template displays <ref name=\"RefName\"/>.",
			"type": "string",
			"suggested": true
		},
		"3": {
			"label": "Reference name 3",
			"description": "If this is \"RefName\", the template displays <ref name=\"RefName\"/>.",
			"type": "string",
			"suggested": true
		},
		"4": {
			"label": "Reference name 4",
			"description": "If this is \"RefName\", the template displays <ref name=\"RefName\"/>.",
			"type": "string"
		},
		"5": {
			"label": "Reference name 5",
			"description": "If this is \"RefName\", the template displays <ref name=\"RefName\"/>.",
			"type": "string"
		},
		"6": {
			"label": "Reference name 6",
			"description": "If this is \"RefName\", the template displays <ref name=\"RefName\"/>.",
			"type": "string"
		},
		"7": {
			"label": "Reference name 7",
			"description": "If this is \"RefName\", the template displays <ref name=\"RefName\"/>.",
			"type": "string"
		},
		"8": {
			"label": "Reference name 8",
			"description": "If this is \"RefName\", the template displays <ref name=\"RefName\"/>.",
			"type": "string"
		},
		"9": {
			"label": "Reference name 9",
			"description": "If this is \"RefName\", the template displays <ref name=\"RefName\"/>.",
			"type": "string"
		},
		"group": {
			"aliases": [
				"g",
				"grp"
			],
			"label": "Reference group",
			"description": "The reference group of all the references displayed; see WP:REFGROUP for help.",
			"type": "string",
			"default": "Defaults to not being in a group.",
			"suggested": true
		},
		"page1": {
			"aliases": [
				"p",
				"page",
				"pages",
				"pp",
				"p1",
				"pages1",
				"pp1"
			],
			"label": "Pages number(s): reference 1",
			"description": "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\"",
			"type": "content",
			"suggested": true
		},
		"q1": {
			"aliases": [
				"quote",
				"q",
				"quote1"
			],
			"label": "Quote: reference 1",
			"description": "A quote from the source. Appears when hovering over the page number, so the page number must be specified.",
			"type": "string",
			"suggested": true
		},
		"page2": {
			"aliases": [
				"p2",
				"pages2",
				"pp2"
			],
			"label": "Pages number(s): reference 2",
			"description": "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\"",
			"type": "content"
		},
		"q2": {
			"aliases": [
				"quote2"
			],
			"label": "Quote: reference 2",
			"description": "A quote from the source. Appears when hovering over the page number, so the page number must be specified.",
			"type": "string"
		},
		"page3": {
			"aliases": [
				"p3",
				"pages3",
				"pp3"
			],
			"label": "Pages number(s): reference 3",
			"description": "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\"",
			"type": "content"
		},
		"q3": {
			"aliases": [
				"quote3"
			],
			"label": "Quote: reference 3",
			"description": "A quote from the source. Appears when hovering over the page number, so the page number must be specified.",
			"type": "string"
		},
		"page4": {
			"aliases": [
				"p4",
				"pages4",
				"pp4"
			],
			"label": "Pages number(s): reference 4",
			"description": "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\"",
			"type": "content"
		},
		"q4": {
			"aliases": [
				"quote4"
			],
			"label": "Quote: reference 4",
			"description": "A quote from the source. Appears when hovering over the page number, so the page number must be specified.",
			"type": "string"
		},
		"page5": {
			"aliases": [
				"p5",
				"pages5",
				"pp5"
			],
			"label": "Pages number(s): reference 5",
			"description": "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\"",
			"type": "content"
		},
		"q5": {
			"aliases": [
				"quote5"
			],
			"label": "Quote: reference 5",
			"description": "A quote from the source. Appears when hovering over the page number, so the page number must be specified.",
			"type": "string"
		},
		"page6": {
			"aliases": [
				"p6",
				"pages6",
				"pp6"
			],
			"label": "Pages number(s): reference 6",
			"description": "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\"",
			"type": "content"
		},
		"q6": {
			"aliases": [
				"quote6"
			],
			"label": "Quote: reference 6",
			"description": "A quote from the source. Appears when hovering over the page number, so the page number must be specified.",
			"type": "string"
		},
		"page7": {
			"aliases": [
				"p7",
				"pages7",
				"pp7"
			],
			"label": "Pages number(s): reference 7",
			"description": "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\"",
			"type": "content"
		},
		"q7": {
			"aliases": [
				"quote7"
			],
			"label": "Quote: reference 7",
			"description": "A quote from the source. Appears when hovering over the page number, so the page number must be specified.",
			"type": "string"
		},
		"page8": {
			"aliases": [
				"p8",
				"pages8",
				"pp8"
			],
			"label": "Pages number(s): reference 8",
			"description": "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\"",
			"type": "content"
		},
		"q8": {
			"aliases": [
				"quote8"
			],
			"label": "Quote: reference 8",
			"description": "A quote from the source. Appears when hovering over the page number, so the page number must be specified.",
			"type": "string"
		},
		"page9": {
			"aliases": [
				"p9",
				"pages9",
				"pp9"
			],
			"label": "Pages number(s): reference 9",
			"description": "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\"",
			"type": "content"
		},
		"q9": {
			"aliases": [
				"quote9"
			],
			"label": "Quote: reference 9",
			"description": "A quote from the source. Appears when hovering over the page number, so the page number must be specified.",
			"type": "string"
		}
	},
	"description": "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.",
	"paramOrder": [
		"group",
		"1",
		"page1",
		"q1",
		"2",
		"page2",
		"q2",
		"3",
		"page3",
		"q3",
		"4",
		"page4",
		"q4",
		"5",
		"page5",
		"q5",
		"6",
		"page6",
		"q6",
		"7",
		"page7",
		"q7",
		"8",
		"page8",
		"q8",
		"9",
		"page9",
		"q9"
	]
}
</templatedata>

==See also==
* [[Help:List-defined references]], which provides all the specifications for using List-defined references, especially with regard to naming references and groups.
* [[WP:CITESHORT|Shortened footnotes]] in [[Wikipedia:Citing sources]], which describes the most common way of citing multiple pages of the same source.
* {{tl|sfn}}, a template that implements the most common way of citing multiple pages of the same source.
* [[WP:CITEBUNDLE|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]]

==Notes==
{{reflist|group=note}}

<includeonly>{{Sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:ウィキペディアのテンプレート]]

}}</includeonly>