Template:Reference page: Difference between revisions

Template documentationview edit history purge

This template is used on approximately 80,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:String2

Shortcuts

{{rpTemplate:Rp}}
{{pg}}

"Rp" stands for "reference page(s)". This is a method of citing page numbers usually used when other methods produce undesirable results.

It can be used to refer to specific pages, page ranges, chapters, time stamps, or other locations in a cited work of nearly any kind.

Function

Use this template when you are referring to specific pages within a source which is cited many times in the same article. The following example sentence shows the formatting produced by:

<ref name="aardvark">... details of cited source ...</ref>{{rp|p=23}}

which would be used to refer to a fact on page 23 of reference [1]:

Apples should be eaten when they are ripe.^[1]^: 23

This second example sentence shows the formatting produced by:

<ref name="aardvark" />{{rp|p=56}}

which would be used as citation for a statement supported by a fact on page 56 of the same reference [1], which will appear only once in the list of references:

Porridge, usually eaten for breakfast, can also serve as a dessert.^[1]^: 56

References

↑ ^1.0 ^1.1 Aardvark, A. A. (1999). The Best Moments for Eating. Green Press.

Intent

This template is for appending page numbers and other types of in-source location information to notes. It is an alternative that can be used in articles with one or several sources that are cited multiple times, at numerous different pages.

It is a solution for the problem of a source that is cited many times, at numerous different pinpoint page numbers, in the same Wikipedia article. Cite.php's limitations pose two citation problems in such a case:

Regular use of <ref ...>...</ref> to provide a separate citation for each fact/statement sourced from a different page or page range (as in this example) will result in numerous individual lines, each repeating the entire bibliographic citation of a source, generated by <references/> (or through the equivalent {{reflist}}) in the "Notes" or "References" section.
Using a single <ref ...>...</ref> and a followup <ref .../> with the same name= and simply listing all of the pages cited would result in the single, very long <references/> (or {{reflist}}) entry for this source giving no way for readers to tell which facts were sourced from which pages in the work.

This template works around both of these problems. Doing so is important, because Featured Article as well as Good Article reviews generally insist upon specific facts being cited with specific page numbers.

{{rp}} is an alternative to the method of using shortened footnotes that does not require the reader to follow two links to see the source. In cases of numerous citations to the same source, the Cite.php <ref ...> footnoting system is less tedious to use and more difficult to break with incorrect formatting than the {{ref label}} and {{note label}} system (although, in other situations, those templates are not particularly difficult and may be quite useful).

In most cases, citing page numbers in the <ref>...</ref> code is just fine. This template is intended for sources that are used many times in the same article, but with differing page numbers. Even when used to specify individual page numbers in different locations of the article, it is often a good idea to specify the combined list of all page numbers referred to in an article in the core citation as well, as this makes it easier to obtain the source (if CS1/CS2 citation style is used for the core citation, the combined page numbers get also included in the meta-data).

Overuse of this template can make prose harder to read for some. Used judiciously, however, others find it is less interruptive to the visual flow than complete implementation of the reference citation styles that inspired it, particularly full Harvard referencing and AMA style.

If an article has an established citation style that uses an alternative to this template (e.g. Harvard style or another style using {{sfn}} shortened footnote templates), then do not unilaterally start using this template in the article. Instead, you should discuss options for citation styles with other editors and try to reach a consensus, per WP:CITEVAR.

How to use

Calling syntax

{{rp|page=page}} or {{rp|p=page}} (for a singular page)
{{rp|pages=pages}} or {{rp|pp=pages}} (for plural pages, including lists and ranges)
{{rp|at=in-source-location}} (for other in-source-location info)
{{rp|page number(s)}} (not recommended, because without one of the dedicated parameters above the type and numerus of the given page information will be ambiguous in some cases and thus the resulting tooltip has to remain somewhat vague)

The specified page number(s) can be a single page number (287), a list of several pages (xii, 287, 292, 418) or a range of pages (287–288) or any combination thereof. Do not add "Page", "pp.", etc.—just the numbers.

Other in-source-location information can also be used for non-numeric pages, for example: "f. 29", "A7", and "back cover", etc., and can also be used for non-paginated sources, e.g., "0:35:12" for a video source.

Choose one of the template parameters above according to the type of page or in-source-location specified.

While typically only one of these three types of parameters is given, it is also possible to combine them to suit more special use cases. If both, singular and plural page parameters are given at the same time, the plural page info is assumed to be the span of the article, whereas the singular page info is considered to be the page within that span supporting the statement. The template will indicate this by framing the singular page in square brackets following the plural page info. If an in-source-location is given in addition to the page info, the template assumes it to further detail the preceding page info rather than representing some kind of stand-alone in-source location info.

Do not attempt to use multiple aliases of a parameter at the same time. Only one will be chosen and the others may be ignored without error message.

Example

The example below shows {{rp}} in use both at a first occurrence [<ref ...>...</ref>], with other references and inline superscript templates present so one can see how it looks when used in series, and at a later [<ref ... />] occurrence.

Code	Result
An asserted fact.^{[clarification needed]}^[1]^{: 143, 233–237}^[2]^[3] [...] Another asserted fact.^[1]^: 27 Also important.^[1]^{: foldout V} ↑ ^1.0 ^1.1 ^1.2 Jackson, Jennifer (1999). The Unlightable Being of Bareness. San Francisco, California: Funky Publications. ↑ Smith, Bob (2000). Another Source. Chicago, Illinois: Another Publisher. p. 27. ↑ Jones, Bill (20 January 2006). "Some Article". "Style" section. The New York Times. p. S4. Retrieved 17 March 2007.

Example page

Liouville number § Liouville numbers and measure

Display format

The default display format for the superscript is a colon prefix (:).

Alternatively, AMA style puts superscripted page numbers inside parentheses instead of after a colon. This style can be selected by adding the template parameter <syntaxhighlight lang="wikitext" inline style="display: none;" />|style=ama. In cases, where the p/pp prefix should not be displayed, it can be suppressed using <syntaxhighlight lang="wikitext" inline style="display: none;" />|no-pp=yes

Example

Code	Result
An asserted fact.^[1]^(p148) [...] Another asserted fact.^[1]^{(pp233–237)} [...] A third asserted fact.^[1]^{(dust jacket)} ↑ ^1.0 ^1.1 ^1.2 ^1.3 ^1.4 ^1.5 Jackson, Jennifer (1999). The Unlightable Being of Bareness. San Francisco, California: Funky Publications. Cite error: Invalid `<ref>` tag; name "Jackson 1999" defined multiple times with different content ↑ Smith, Bob (2000). Another Source. Chicago, Illinois: Another Publisher. p. 27. ↑ Jones, Bill (20 January 2006). "Some Article". "Style" section. The New York Times. p. S4. Retrieved 17 March 2007.

Missing page numbers

If a reference needs a page number but it is missing, use {{rp|needed=y|{{subst:DATE}}}} or {{rp|needed=y|date=October 2026}}. This will automatically use the {{page needed}} template to add the article to the appropriate category. For example, <ref name="Jackson 1999" />{{rp|needed=y|date=November 2012}} results in: ^[1]^{[page needed]}

This is preferable to something like {{rp|page number?}} or {{rp|?}}, since the cleanup categorization takes place. It is preferable to simply using {{page needed}} in articles that make use of {{rp}}, since it preserves the use of the {{rp}} syntax.

Do not nest the {{page needed}} template inside the {{rp}} template; doing so introduces a stray colon and the displayed results are too small to be legible to many readers. For instance, <ref name="Jackson 1999" />{{rp|{{page needed|date=November 2012}}}} results in the undesirable: ^[1]^{: ^{[page needed]}}

With a quote

The template can use the <syntaxhighlight lang="wikitext" inline style="display: none;" />|quote= or <syntaxhighlight lang="wikitext" inline style="display: none;" />|q= parameter to show a quote from the source when the mouse hovers over the location identifier. Use of these parameters provides some context for the reference, especially if the reference is to an offline source. This is especially important when using the off-line source to support a fact that might be controversial or is likely to be challenged.

Quotation marks are automatically inserted around the quote, and location identifiers with a quote will display with a dashed underline.

Code	Result
An asserted fact.^[1]^: 422 [...] Another asserted fact.^[1]^{: 233–237} [...] A third asserted fact.^[1]^{: dust jacket} ↑ ^1.0 ^1.1 ^1.2 ^1.3 ^1.4 ^1.5 ^1.6 ^1.7 Jackson, Jennifer (1999). The Unlightable Being of Bareness. San Francisco, California: Funky Publications.

If the in-source-location of the quote is more specific (or different) from the in-source-location specified with the set of <syntaxhighlight lang="wikitext" inline style="display: none;" />|page=/<syntaxhighlight lang="wikitext" inline style="display: none;" />|pages=/<syntaxhighlight lang="wikitext" inline style="display: none;" />|at= parameters for the citation discussed above, you can optionally use the separate set of <syntaxhighlight lang="wikitext" inline style="display: none;" />|quote-page=/<syntaxhighlight lang="wikitext" inline style="display: none;" />|quote-pages=/<syntaxhighlight lang="wikitext" inline style="display: none;" />|quote-at= parameters to specify an in-source-location for the specific quote.

If the quote is not in English, you can optionally use the <syntaxhighlight lang="wikitext" inline style="display: none;" />|language= parameter (or one of its aliases) to specify the language of the quote. A translation of the quote can be optionally provided through the <syntaxhighlight lang="wikitext" inline style="display: none;" />|translation= parameter (or one of its aliases).

If it is desirable to have the quotation present in the local tooltip as well as in the full citation, consider switching to use {{r}} with its |annotation=quote |quote=Quotation parameter instead of using {{rp}}.

Spacing

Where multiple citations occur in series, {{rp}} prevents line breaks between the citations. In this case, <syntaxhighlight lang="wikitext" inline style="display: none;" />|wrap=yes can be used to allow a line break. Alternatively, if line breaks should be allowed also inside a long page / location information, <syntaxhighlight lang="wikitext" inline style="display: none;" />|wrap=forced can be used instead (however, if this actually results in line breaks also depends on the browser, CSS and the skin selected).

Hyphens

Per MOS:DASH, page ranges should be declared with an ndash ({{rp|pages=27–29}}→^[ref]^: 27–29) rather than a hyphen. Tools like WP:AWB will automatically convert hyphens to dashes in such instances. For the plural page parameters <syntaxhighlight lang="wikitext" inline style="display: none;" />|pages=, <syntaxhighlight lang="wikitext" inline style="display: none;" />|pp= and <syntaxhighlight lang="wikitext" inline style="display: none;" />|quote-pages= and aliases, {{rp}} will automatically translate hyphens into ndashes for display purposes. (This does not apply to the singular and other in-source-location parameters <syntaxhighlight lang="wikitext" inline style="display: none;" />|page=, <syntaxhighlight lang="wikitext" inline style="display: none;" />|p=, <syntaxhighlight lang="wikitext" inline style="display: none;" />|at=, <syntaxhighlight lang="wikitext" inline style="display: none;" />|loc=, <syntaxhighlight lang="wikitext" inline style="display: none;" />|quote-page= and aliases.) If the hyphen is actually desired for whatever reason, the "accept-this-as-written-markup" (which is also supported by {{ran}} and {{r}}, the family of {{sfn}}- and {{harv}}-style templates, and all CS1/CS2 citation templates) can be used to indicate this ({{rp|pages=((27-2, 47-3))}}→^[ref]^{: 27-2, 47-3}).

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Reference page in articles based on its TemplateData.

TemplateData for Reference page

<templatedata> { "description": "This template is used to refer to specific page numbers when citing a source multiple times within the same article. It should be placed immediately after a reference.", "params": { "1": { "label": "Page number(s)", "description": "Write the page number(s) referred to in this reference. Do not add 'Page', 'p.', 'pp.', etc.; just the number(s). (This parameter is supported for backward compatibility, but if the numerus is known, use one of the more specific parameters 'page'/'p', 'pages'/'pp', 'location'/'at' instead to eliminate any potential ambiguity and improve the tooltip.)", "type": "string", "suggested": false, "deprecated": true, "example": "26–27" }, "page": { "aliases": [ "p" ], "description": "If the page number referred to in this reference is singular, specify the single page number using this parameter. Do not add 'Page', 'p.', etc.; just the number.", "label": "Singular page number", "type": "string", "suggested": true, "example": "26" }, "pages": { "aliases": [ "pp" ], "description": "If there are multiple page numbers referred to in this reference, specify them using this parameter. Do not add 'Pages', 'pp.', etc.; just the numbers.", "label": "Plural pages", "type": "string", "suggested": true, "example": "26–27" }, "location": { "aliases": [ "loc", "at" ], "description": "Specify the in-source-location referred to in this reference, if it is not a normal page or number of pages.", "label": "In-source-location", "type": "string", "suggested": true, "example": "sheet 3" }, "quote": { "aliases": [ "q", "quotation" ], "label": "Quote (in original language) from source", "type": "string" }, "quote-page": { "aliases": [ "qp", "quotation-page" ], "label": "Singular quote page", "description": "Write the page number referred to in the quote (only if different from page). Do not add 'Page', 'p.', 'pp.', etc.; just the number. (Special token 'page'/'p' refers to page.)", "type": "string", "example": "26" }, "quote-pages": { "aliases": [ "qpp", "quotation-pages" ], "label": "Plural quote pages", "description": "Write the page numbers referred to in the quote (only if different from pages). Do not add 'Page', 'p.', 'pp.', etc.; just the numbers. (Special token 'pages'/'pp' refers to pages.)", "type": "string", "example": "26–27" }, "quote-location": { "aliases": [ "quote-loc", "quote-at", "quotation-location" ], "label": "Quote location", "description": "Write the in-source-location referred to in the quote (only if different from pages). Do not add 'Page', 'p.', 'pp.', etc.; (Special token 'pages'/'pp'/'page'/'p' refers to pages.)", "type": "string", "example": "§3" }, "language": { "aliases": [ "lang", "l", "ql", "quote-language", "quotation-language", "quote-lang", "quotation-lang" ], "label": "Language of quote", "description": "Optional language code or language name for quote, if not English.", "type": "content", "example": "de" }, "translation": { "aliases": [ "trans", "t", "tq", "translation-quote", "translation-quotation", "trans-quotation", "xlat" ], "label": "English translation of a quote", "type": "string" }, "no-pp": { "aliases": [ "nopp" ], "label": "Hide \"pp\" for AMA?", "type": "unknown" }, "style": { "label": "Display control", "type": "content", "example": "ama, AMA, Ama" }, "wrap": { "label": "Wrapping control", "type": "string", "suggestedvalues": [ "no", "yes", "forced" ] }, "needed": { "label": "Request page number" }, "date": { "label": "Page request date", "type": "content" }, "reason": { "label": "Page request reason", "type": "string" } }, "format": "inline" } </templatedata>