Template:Rp/doc

From Wikishire
Revision as of 12:35, 11 September 2013 by RB (talk | contribs) (Created page with '{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> ==Function== "Rp" stands for "reference pages". Use this template when you ar…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Template:Mbox

Function

"Rp" stands for "reference pages".

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

Usage

With colon

{{rp|page number(s)}}

"Page number(s)" can be a single page number (287), several (xii, 287, 292, 418) or a range (287–88) or any combination thereof. Do not add "Page", "pp.", etc.—just the numbers. Of course, it 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.

This template is for appending page numbers in Harvard referencing style (or AMA style, as an option – see "With parentheses", below) to Cite.php-generated inline reference citations. It is a solution for the problem of an article with a source that must be cited many, many times, at numerous different pages. It is an alternative to the more common method of using shortened footnotes, that does not require the reader to follow two links to see the source. The Cite.php <ref ...> footnoting system is desired to be used instead of the incredibly tedious and easy-to-break {{ref label}} and {{note label}} system (tedious and fragile in this context; the templates are not terribly difficult to use and are quite useful in other situations).

The problem of course is that a work cited 100+ times with page numbers in each appearance, with individual <ref ...>'s will result in more than 100 lines generated for the same source by <references /> (or {{Reflist}}),[*note] while using a single <ref ...>...</ref> and followup <ref ... />'s with the same name= and simply mentioning all of the pages cited, in the single line generated by <references /> could result in at least 100 pages being specifically cited in a single reference citation footnote, rendering it basically unreadable and certainly useless.

This template solves this problem (perhaps temporarily, as Cite.php may be upgraded at some future date to account for this problem, in which case a bot can be created to convert {{Rp}} instances to the new, improved "Super-<ref ...>").

Template:Anchor* Note: See this diff for a short but already reader-annoying example. Imagine it with 100+ citations to one source instead of just 13.

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

An asserted fact.{{Clarifyme|date=November 2024}}<ref name="Jackson1999">{{Cite book
|last=Jackson
|first=Jennifer
|title=The Unbearable Likeness of Forgery
|publisher=Madeup Publications|location=[[Cambridge]]
|year=1999
|isbn=1-2345-6789-0
}}</ref>{{rp|233–7}}<ref name="Smith2000">{{Cite book
|last=Smith
|first=Bob
|title=Another Source
|publisher=Another Publisher
|location=[[Manchester]]
|year=2000
|isbn=0-0986-5432-1
|page=27
}}</ref><ref name="NYT20060120">{{Cite news
|url= http://url.goes.here.tld/
|title=Some Article
|last=Jones
|first=Bill
|work=New York Times
|page=S4, "Style" section
|date=January 20, 2006
|accessdate=2007-03-17
}}</ref>

...
Another asserted fact.<ref name="Jackson1999" />{{rp|27, 422}}
...
{{Reflist}}

Results

An asserted fact.[clarify][2]:233–7[3][4]
...
Another asserted fact.[2]:27, 422
...

  1. 1.0 1.1 A. A. Aardvark (1999). The Best Moments for Eating. Green Press.
  2. 2.0 2.1 Jackson, Jennifer (1999). The Unbearable Likeness of Forgery. Cambridge: Madeup Publications. ISBN 1-2345-6789-0. 
  3. Smith, Bob (2000). Another Source. Manchester: Another Publisher. p. 27. ISBN 0-0986-5432-1. 
  4. Jones, Bill (January 20, 2006). "Some Article". New York Times: p. S4, "Style" section. http://url.goes.here.tld/. Retrieved 2007-03-17. 

With parentheses

AMA style puts superscripted page numbers inside parenthesis instead of after a colon. For editors that prefer this style, this template has parameters page, pages, and at.

Code

An asserted fact.<ref name="Jackson1999">{{Cite book
|last=Jackson
|first=Jennifer
|title=The Unbearable Likeness of Forgery
|publisher=Madeup Publications|location=[[Cambridge]]
|year=1999
|isbn=1-2345-6789-0
}}</ref>{{rp|page=148}}

...
Another asserted fact.<ref name="Jackson1999" />{{rp|pages=233–7}}
...
A third asserted fact.<ref name="Jackson1999" />{{rp|at=dust jacket}}
...
{{Reflist}}

Results

An asserted fact.[a 1](p148)
...
Another asserted fact.[a 1](pp233–7)
...
A third asserted fact.[a 1](dust jacket)
...

  1. 1.0 1.1 1.2 Jackson, Jennifer (1999). The Unbearable Likeness of Forgery. Cambridge: MadeupPublications. ISBN 1-2345-6789-0. 

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=November 2024}}. This will automatically use the {{page needed}} template to add the article to the appropriate category. For example, <ref group="b" name="Jackson 1999 ex. 1" />{{tlx|rp|needed=y|date=November 2012}} results in: [b 1]This article requires significant work to match Wikishire standards

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. The result of this nesting is demonstrated in the following example: <ref group="b" name="Jackson 1999" />{{tlx|rp|{{tlx|page needed|date=November 2012}} results in the undesirable: [b 1]:This article requires significant work to match Wikishire standards

  1. 1.0 1.1 Jackson, Jennifer (1999). The Unbearable Likeness of Forgery. Cambridge: Madeup Publications. ISBN 1-2345-6789-0.  Cite error: Invalid <ref> tag; name "Jackson1999" defined multiple times with different content

A note on spacing

Where multiple citations occur in series, {{rp}} may result in line breaks between the citations. The "Non-breaking space" code &#8288; may be used to prevent this.

Warning

This template should not be used unless necessary. In the vast majority of cases, citing page numbers in the <ref ...>...</ref> code is just fine. This template is only intended for sources that are used many, many times in the same article, to such an extent that normal citation would produce a useless line in <references /> or too many individual ones. Overuse of this template will make prose harder to read, and is likely to be reverted by other editors. Used judiciously, however, it is much less interruptive to the visual flow than full Harvard referencing and some other reference citation styles.

See also

  • {{sfn}}, a template that implements the most common way of citing multiple pages of the same source.

<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 numbers",
     "description": "Write the page number(s) referred to in this reference.",
     "type": "string",
     "required": true
   }
 }

}</templatedata>