Template:Cite RNB1823/doc

This template is wrapper around 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.

Parameters that are filled in by this template
Parameters that are filled in by this template:
 * = John
 * = Marshall
 * = RJohn Marshall (biographer)
 * = Royal Naval Biography
 * = London
 * = Longman and company

Non-standard parameters
Non-standard parameters:
 * see the explanation see date, volume and part below
 * = RNB article name as it appears on Wikisource — the template adds in the rest of the link automatically
 * = name — overrides the display to the screen of  or  . This is sometimes desirable for example for hiding disambiguation extensions which do not appear in the original print version of he encyclopedia
 * = x (or any other value) — it hides the display of    this is typically used when this template appears in the External links section to remove clutter

Date, volume and part
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:

The  is set automatically by setting the parameters   and. For example:
 * if =1 and  =1 then  =1823
 * if =4 and  =2 then  =1834
 * if =sup and  =3 then  =1829
 * If no  is set then  =1823–1835
 * if no  is set then   is set to the range dictated by  . For example:
 * if =sup and   is not set then   = 1827–1830

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  producing an output of  (for more on this see Help:References and page numbers)

Other considerations
Other considerations:
 * If  is not set then the standard parameter   must be set if neither are then a red warning printed
 * Unless  is set an icon is displayed before first character displayed by the template. The icon displayed varies depending on whether   is set.

Examples
Only three variable are required to access the article on Wikisource and set the correct volume part and date (page should also be set):





To change the title displayed:

To shorten the display:

To remove the icon from the display:

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

Maintenance categories

 * Category:Wikipedia articles incorporating a citation from the Royal Naval Biography (1823)
 * Category:Wikipedia articles incorporating a citation from the RNB (1823) with no article parameter
 * Category:Wikipedia articles incorporating a citation from the RNB (1823) without Wikisource reference
 * Category:Wikipedia articles incorporating a citation from the RNB (1823) with Wikisource reference