Template:Cite RNB1823/doc
This is a documentation subpage for Template:Cite RNB1823. It may contain usage information, categories and other content that is not part of the original template page. |
This template is wrapper around {{cite encyclopedia}}
it can use all the parameters that {{cite encyclopedia}} can use, but as documented below some of them are filled in automatically and there are also some additional parameters. As can be seen below in the example section using this template saves the editor time (as many of the parameters are filled in automatically) and as those parameters are not displayed in edit mode it reduces clutter editors see when editing which is particularly useful if the full citation appears in an inline citation within a ref...tag pair.
Usage
[edit]Parameters that are filled in by this template
[edit]Parameters that are filled in by this template:
first
= Johnlast
= Marshallauthor-link
= RJohn Marshall (biographer)encyclopedia
= Royal Naval Biographylocation
= Londonpublisher
= Longman and company
Non-standard parameters
[edit]Non-standard parameters:
part
see the explanation see date, volume and part belowwstitle
= RNB article name as it appears on Wikisource — the template adds in the rest of the link automaticallydisplay
= name — overrides the display to the screen ofwstitle
ortitle
. This is sometimes desirable for example for hiding disambiguation extensions which do not appear in the original print version of he encyclopediashort
= x (or any other value) — it hides the display ofeditor-first, editor-last , editor-link, location, publisher
this is typically used when this template appears in the External links section to remove clutter
Date, volume and part
[edit]Date, volume and part: The Royal Naval Biography was not only a multi-volume publication some of the volumes were published in several parts over a number of years:
Year | Volume | Part 1 | Part 2 | Part 3 | Part 4 |
---|---|---|---|---|---|
1823 | 1 | 1 | 2 | ||
1824 | 2 | 1 | |||
1825 | 2 | 2 | |||
1827 | sup | 1 | |||
1828 | sup | 2 | |||
1829 | sup | 3 | |||
1830 | sup | 4 | |||
1831 | 3 | 1 | |||
1832 | 3 | 2 | |||
1833 | 4 | 1 | |||
1835 | 4 | 2 |
The date
is set automatically by setting the parameters volume
and part
. For example:
- if
volume
=1 andpart
=1 thendate
=1823 - if
volume
=4 andpart
=2 thendate
=1834 - if
volume
=sup andpart
=3 thendate
=1829 - If no
volume
is set thendate
=1823–1835 - if no
part
is set thendate
is set to the range dictated byvolume
. For example:- if
volume
=sup andpart
is not set thendate
= 1827–1830
- if
However there are times when it is desirable to override the automatic date by setting it manually. For example within one Wikpedia article there could be two RNB articles by Marshal with the same volume and part parameters (eg volume=1 |part=1). They will both generate long references with a date of 1823. If the long references are to be accessed by short citations it will be necessary to set one of the references to have a different date, Eg date=1823b
producing an output of Marshall, John (1823b)... (for more on this see Help:References and page numbers#Shortened footnotes)
Other considerations
[edit]Other considerations:
- If
wstitle
is not set then the standard parametertitle
must be set if neither are then a red warning printed - Unless
noicon
is set an icon is displayed before first character displayed by the template. The icon displayed varies depending on whetherwstitle
is set.
Examples
[edit]Only three variable are required to access the article on Wikisource and set the correct volume part[a] and date (page should also be set):
{{cite RNB1823 |wstitle=John Jervis, Earl of St Vincent |volume=1 |part=1 |pages=12–32}}
- Marshall, John (1823). . Royal Naval Biography. Vol. 1, part 1. London: Longman and company. pp. 12–32.
{{cite RNB1823 |wstitle=Aldham, George |volume=2 |part=2 |pages=911}}
- Marshall, John (1825). . Royal Naval Biography. Vol. 2, part 2. London: Longman and company. p. 911.
{{cite RNB1823 |wstitle=Abdy, Anthony |volume=sup |part=2 |pages=720 |ref=none}}
- Marshall, John (1828). . Royal Naval Biography. Vol. sup, part 2. London: Longman and company. p. 720.
To change the title displayed:
{{cite RNB1823 |wstitle=John Jervis, Earl of St Vincent|volume=1 |part=1 |pages=12–32 |display=John, Earl of St Vincent}}
- Marshall, John (1823). . Royal Naval Biography. Vol. 1, part 1. London: Longman and company. pp. 12–32.
To shorten the display:
{{cite RNB1823 |wstitle=John Jervis, Earl of St Vincent|volume=1 |part=1 |pages=12–32 |short=x}}
- . Royal Naval Biography. Vol. 1, part 1. 1823. pp. 12–32.
To remove the icon from the display:
{{cite RNB1823 |wstitle=John Jervis, Earl of St Vincent|volume=1 |part=1 |pages=12–32 |short=x |noicon=x}}
- "John Jervis, Earl of St Vincent". Royal Naval Biography. Vol. 1, part 1. 1823. pp. 12–32.
It may be that an article has yet to be ported to Wikisouce article space and a url is required (the url parameter is ignored if wstitle is set):
{{cite RNB1823 |title=John, Earl of St Vincent |volume=1 |part=1 |pages=12–32 |url=https://archive.org/details/royalnavalbiopt101marsuoft/page/12/mode/1up}}
- Marshall, John (1823). "John, Earl of St Vincent". Royal Naval Biography. Vol. 1, part 1. London: Longman and company. pp. 12–32.
Maintenance categories
[edit]See also
[edit]{{RNB1823}}
— takes the same parameters as this template but prepends an attribution string as required by plagiarism guideline if text is copied verbatim from the article in Royal Naval Biography (1823){{RNB1823 poster}}
— display a Royal Naval Biography Wikisource article in a top box on the right (placed in the External links section)
Notes
[edit]- ^ Currently the header of the Wikisource articles not not include volume and part. These can be found by clicking on a page number and exacting the information from the DJVU page name. For example
- s:Royal Naval Biography/Aldham, George contains page 911 which links to "...v2p2.djvu" ie v2 is the volume number and p2 is part number
- s:Royal Naval Biography/Abdy, Anthony contains page 270 which links to "...sp2.djvu" ie s is the supplement and p2 is the part number