Template:London Gazette/doc

This template is used to provide references to pages in the London Gazette online archive website. The London Gazette is the official newspaper of the British government for England and Wales in which all official notices are published. The template is provided to simplify the entering of addresses. An index by number/date (i.e. if you know the number or date you can find the document) is at WP:London Gazette Index.

The template may also be used to provide references to pages in the of the Edinburgh Gazette online archives and to Belfast Gazette online archives.

Usage
Basic form using minimum parameters to link to the reference (when used as an inline reference, the  tags must be added separately) :
 * (For an entire issue)
 * (For a single page)

Using pages to refer to a range of pages in the link:

Using city to refer to a page in the Edinburgh or Belfast Gazette in the link:

Using supp to link to a page in a supplement to a Gazette

All parameters, delete those you don't need

All parameters, vertical format:

Required parameters

 * issue: The issue number of the referenced Gazette (to find this from the date, consult WP:London Gazette Index)
 * date: The publication date of the referenced issue of the Gazette (typically found under the title block on the first page and at the top of each succeeding page).

Transclusions which lack any of the required parameters are added to Category:Articles missing Template:London Gazette required parameter.

Optional parameters
For use where a single page is to be referenced:
 * page: The page of the referenced Gazette on which the citation is found (if a page range is required see pages below)—also use this option when citing a whole issue, for example for the Birthday Honours List.

For use where a range of pages is to be referenced:
 * pages: first and last pages of a page range separated with an en dash: 1–12; or, comma separated list of page numbers: 1, 12; or a mix of both: 1–3, 6, 8.

For a link to the Edinburgh, Belfast Gazette or Oxford Gazette:
 * city: Either e for Edinburgh Gazette, b for Belfast Gazette or o for the Oxford Gazette as the first 23 issues of the London Gazette were titled. The city names may also be spelt out in full if you prefer, e.g. Edinburgh

To display the name of the Gazette without a wikilink (e.g. if there are multiple uses of the template, allow the link on the first but disable the rest):
 * nolink: Set y to display the name of the Gazette without a wikilink (e.g. if there are multiple uses of the template on the same page)

The punctuation used to separate elements in the rendered citation:
 * mode: see Help:Citation Style 1. Setting cs2 changes the style to ensure consistency with Citation style 2, as produced by.

To remove the final period, or change it to any other character:
 * postscript: Using postscript see Help:Citation Style 1 — now semi-redundant, consider using mode.

Others
 * title: see Help:Citation Style 1.
 * ref: set by default to  can be altered as described in Help:Citation Style 1.
 * quote: see Help:Citation Style 1
 * title: defaults to "No. issue", but can be overwritten with any title (in which case "No. issue" displays elsewhere in the template). See also Help:Citation Style 1

Specifying a supplement to a Gazette:
 * supp: To correctly format the URL to link to a Gazette supplement, set this parameter to, or the one or two digit number of the supplement—numbers 1 to 99 are supported. Usually this will be to an unnumbered or first supplement (1). There are exceptions.  See display-supp and the table.
 * display-supp: Sometimes issues and supplements at the London Gazette website aren't where they would be expected. Sometimes issues are located at a supplement URL and sometimes supplements are located at an issue URL.  When this is the case, use display-supp with supp to direct the template to select the correct URL and render the correct display.  See the table.

 

Source of information for parameters
To find the information to put into the parameters:
 * 1) Visit the Gazette website search page: The Gazette
 * 2) Enter search terms into the search fields including a date range and a choice of Gazette edition(s)
 * 3) When the list of matching Gazette issues is displayed, click on a link and the site will open a window with a PDF image of a page of the gazette. From the heading above the page image note:
 * 4) The issue number. This may be up to five digits and also appear in the URL after ".../issue/".
 * 5) The page number. This may be up to five digits and also appears as the last group of characters in the URL.
 * 6) The publication date
 * 7) If the reference needs to refer to a range of pages, find the last relevant page and note the page number as before.
 * 8) Check if the page is part of an issue or a supplement
 * 9) If from a standard gazette issue, the following will be included in the URL, ".../page/..." and no action is required.
 * 10) If the page is part of a supplement to an issue, the following will be included in the URL, ".../supplement/...", the parameter supp must be added to the template. Any character may follow, as long as it is not left blank.
 * 11) When referencing the Belfast or Edinburgh Gazettes, use b or e. When referencing the first 23 issues of the London Gazette (published as the Oxford Gazette) use o. Setting l explicitly refers to the London Gazette. Omitting, leaving the parameter blank, or specifying any other value but b, e, l, or o, will cause the template to default to the London Gazette.
 * 12) Add each of these to the template
 * 13) Add the Retrieval date

Examples
Some standard use cases →

→

→

→

→

A link to a page in the Edinburgh gazette →

A link to a page in the Oxford gazette →

No parameters (error)

Error messages
Certain combinations of parameters are invalid or inappropriate. The template attempts to make sense of all parameter values. When that is not possible, it emits error messages. These messages are:
 * invalid – supp accepts a limited range of parameter values.  The values are:
 * the single letter
 * one or two digit numbers in the range of 1 to 99 inclusive
 * more than one of  and  – simultaneous use of these is not permitted; choose the appropriate parameter
 * London Gazette uses unsupported parameters – these parameters no longer supported:
 * ps – use postscript
 * separator – use mode
 * startpage – use page or pages
 * endpage – use page or pages
 * accessdate – remove
 * access-date – remove

Template Data
{	"params": { "issue": { "label": "Issue", "description": "The issue number of the referenced Gazette (to find this from the date, consult WP:London Gazette Index)", "example": "33000", "type": "number", "required": true },		"date": { "label": "Date", "description": "The publication date of the referenced Gazette. This should be in the format day month year.", "example": "9 December 1924", "type": "date", "required": true },		"page": { "label": "Page", "description": "The page of the referenced Gazette on which the citation is found - Except when citing a whole issue, for example for the Birthday Honours List.", "example": "123", "type": "wiki-page-name" },		"pages": { "label": "Pages", "description": "The page range of the reference Gazette in the form number–number where the two page numbers are separated by a ndash", "example": "123–124", "type": "wiki-page-name" },		"supp": { "label": "Supplement", "description": "For a link in a supplement to a Gazette - To correctly format the URL to link to a page in a Gazette supplement, set this parameter to the number of the supplement (typically, supp=1); otherwise omit it.", "example": "1", "type": "number" },		"display-supp": { "label": "Display-supplement", "description": "Some supplements are accessed without an alteration to the standard URL in which case use this parameter and not the supp parameter.", "example": "1", "type": "number" },		"nolink": { "description": "To display the name of the Gazette without a wikilink (e.g. if there are multiple uses of the template on the same page, allow the link on the first but disable the rest)", "example": "y", "type": "string" },		"city": { "label": "City", "description": "Either |city=e for Edinburgh Gazette, |city=b for Belfast Gazette or |city=o for the Oxford Gazette as the first 23 issues of the London Gazette were titled. The city names may also be spelt out in full if you prefer, e.g. |city=Edinburgh", "example": "e", "type": "string", "default": "London", "autovalue": "" },		"title": { "label": "Title", "description": "Sets a title", "type": "string", "default": "No. " },		"quote": { "label": "Quote", "description": "Appends a quote to the end of the template.", "type": "string" },		"ref": { "label": "Ref", "description": "Used in conjunction with the harv template. It can be altered to any value", "default": "Gazette " },		"mode": { "label": "Mode", "description": "Setting mode=cs2 changes the style to ensure consistency with Citation style 2, as produced by the Citation template", "type": "string", "default": "cs1" },		"postscript": { "label": "Postscript", "description": "To remove the final period, or change it to any other character — now semi-redundant use the  parameter  instead.", "type": "string", "default": "." }	},	"description": "This template is used to provide references to pages in the London Gazette online archive website. The London Gazette is the official newspaper of the British government for England and Wales in which all official notices are published. The template is provided to simplify the entering of addresses. An index by number/date (i.e. if you know the number or date you can find the document) is at WP:London Gazette Index.\n\nThe template may also be used to provide references to pages in the Edinburgh Gazette online archives and to the Belfast Gazette online archives.", "paramOrder": [ "issue", "date", "page", "pages", "supp", "display-supp", "nolink", "city", "title", "quote", "ref", "mode", "postscript" ],	"format": "block" }