Difference between revisions of "Template:London Gazette/doc"

From Wikispooks
Jump to navigation Jump to search
m (1 revision)
 
m (1 revision imported)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
<noinclude>{{documentation subpage}}</noinclude>
 
<noinclude>{{documentation subpage}}</noinclude>
 +
{{Lua|Module:Gazette util}}
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->__NOTOC__
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->__NOTOC__
 
This template is used to provide references to pages in the ''[[London Gazette]]'' [https://www.thegazette.co.uk/ 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]].
 
This template is used to provide references to pages in the ''[[London Gazette]]'' [https://www.thegazette.co.uk/ 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]].
Line 6: Line 7:
  
 
==Usage==
 
==Usage==
−
;Basic form using minimum parameters to link to the reference <small>(when used as an inline reference, the {{tag|ref}} tags must be added separately)</small>:
+
'''Basic form using minimum parameters to link to the reference''' <small>(when used as an inline reference, the {{tag|ref}} tags must be added separately)</small>:
−
<tt><nowiki>{{London Gazette |issue= |date= |startpage= }}</nowiki></tt>
+
* <code><nowiki>{{London Gazette |issue= |date= }}</nowiki></code> (For an entire issue)
 +
* <code><nowiki>{{London Gazette |issue= |date= |page= }}</nowiki></code> (For a single page)
  
−
;Using endpage to refer to a range of pages in the link:
+
'''Using pages to refer to a range of pages in the link:'''
−
<tt><nowiki>{{London Gazette |issue= |date= |startpage= |endpage= }}</nowiki></tt>
+
<code><nowiki>{{London Gazette |issue= |date= |pages= }}</nowiki></code>
  
−
;Using city to refer to a page in the ''Edinburgh'' or ''Belfast Gazette'' in the link:
+
'''Using city to refer to a page in the ''Edinburgh'' or ''Belfast Gazette'' in the link:'''
−
<tt><nowiki>{{London Gazette |issue= |date= |startpage= |city= }}</nowiki></tt>
+
<code><nowiki>{{London Gazette |issue= |date= |page= |city= }}</nowiki></code>
  
−
;Using supp to link to a page in a supplement to a ''Gazette'':
+
'''Using supp to link to a page in a supplement to a ''Gazette'''''
−
<tt><nowiki>{{London Gazette |issue= |date= |startpage= |endpage= |supp= }}</nowiki></tt>
+
<code><nowiki>{{London Gazette |issue= |date= |page= |supp= }}</nowiki></code>
  
−
;Using accessdate to provide a date information was retrieved:
+
'''All parameters, delete those you don't need'''
−
<tt><nowiki>{{London Gazette |issue= |date= |startpage= |endpage= |supp= |accessdate= }}</nowiki></tt>
+
<code><nowiki>{{London Gazette |issue= |date= |page= |pages= |supp= |display-supp= |city= |nolink= |postscript= |mode= |title= |ref= |quote=}}</nowiki></code>
  
−
;All parameters, delete those you don't need
+
'''All parameters, vertical format:'''
−
<tt><nowiki>{{London Gazette |issue= |date= |startpage= |endpage= |supp= |city= |nolink= |accessdate= |ps=}}</nowiki></tt>
 
−
 
 
−
;All parameters, vertical format:
 
 
{{London Gazette/doc/parameterlist}}
 
{{London Gazette/doc/parameterlist}}
  
 
===Required parameters===
 
===Required parameters===
−
*'''issue''': The issue number of the referenced ''Gazette''
+
*'''issue''': The issue number of the referenced ''Gazette'' (to find this from the date, consult [[WP:London Gazette Index]])
−
*'''startpage''': The page of the referenced ''Gazette'' on which the citation is found (or the first page of a range)
 
 
*'''date''': The publication date of the referenced ''Gazette''. This should be in the format day month year.
 
*'''date''': The publication date of the referenced ''Gazette''. This should be in the format day month year.
−
''For a link in a supplement to a ''Gazette'':''
 
−
:*'''supp''': To correctly format the URL to link to a page in a ''Gazette'' supplement, set this parameter to any value (typically, <tt>supp=yes</tt>); otherwise omit it or leave it blank.
 
  
 +
Transclusions which lack any of the required parameters are added to [[:Category:Articles missing Template:London Gazette required parameter]].
 +
 +
<br />
 
===Optional parameters===
 
===Optional parameters===
−
''For producing a date of retrieval:''
+
''For use where a single page is to be referenced:''
−
::'''accessdate''': Full date when item was accessed. ''Should not be wikilinked''.
+
::'''page''': The page of the referenced ''Gazette'' on which the citation is found (if a page range is required see '''pages''' [[#below|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:''
 +
::{{anchor|pages}}'''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'':''
 
''For a link to the ''Edinburgh'', ''Belfast Gazette'' or ''Oxford Gazette'':''
−
::'''city''': Either {{para|city|e}} for ''Edinburgh Gazette'', {{para|city|b}} for ''Belfast Gazette'' or {{para|city|o}} for the ''Oxford Gazette'' as the first 23 issues of the ''London Gazette'' were titled.
+
::'''city''': Either {{para|city|e}} for ''Edinburgh Gazette'', {{para|city|b}} for ''Belfast Gazette'' or {{para|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. {{para|city|Edinburgh}}
−
''For use where a range of pages is to be referenced:''
 
−
::'''endpage''': The last page in the range of pages.
 
 
''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):''
 
''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''': Specify this parameter with any value.
+
::'''nolink''': Set {{para|nolink|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 page numbers, dates and so on:''
+
''The punctuation used to separate elements in the rendered citation:''
−
::'''separator''': Defaults to a period (.); if the parameter is present, but blank, no separator punctuation will be used; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup. Used in conjunction with the '''ps''' parameter it can provide consistency with [[Help:Citation Style 2|Citation style 2]], as produced by {{tlx|Citation}}.
+
::'''mode''': see [[Help:Citation Style 1#Display options]]. Setting {{para|mode|cs2}} changes the style to ensure consistency with [[Help:Citation Style 2|Citation style 2]], as produced by {{tlx|Citation}}.
 
''To remove the final period, or change it to any other character:''
 
''To remove the final period, or change it to any other character:''
−
::'''ps''': Using {{para|ps}} removes the final period; suppressing the default final period (full stop) ensures consistency with [[Help:Citation Style 2|Citation style 2]], as produced by {{tlx|Citation}}.
+
::'''postscript''': Using {{para|postscript}} see [[Help:Citation Style 1#Display options]] — now semi-redundant, consider using {{para|mode}}.
 +
''Others''
 +
::'''title''': see [[Help:Citation Style 1]].
 +
::'''ref''': set by default to <code>CITEREFGazette''issue''</code> can be altered as described in [[Help:Citation Style 1#Anchors]].
 +
::'''quote''': see  [[Help:Citation Style 1#Quote]]
 +
::'''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#Title]]
  
−
===Obsolete parameters===
+
''Specifying a supplement to a ''Gazette'':''
−
*'''notarchive''': was formerly required to correctly format the URL to link to a page in a recent ''Gazette'' (in approximately the last ten years). Since a change to the url scheme in January 2009, this parameter is redundant but may be found in links created prior to the change.
+
:*'''supp''': To correctly format the [[URL]] to link to a ''Gazette'' supplement, set this parameter to <code>y</code>, 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 ({{para|supp|1}}). There are exceptions.  See '''display-supp''' and the table.
−
*'''linkeddate''': was formerly used to produce a wikilinked date. Wikilinking dates is now deprecated and the function of this parameter has been disabled. Use {{para|date}} instead.
+
:*'''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 {{para|display-supp}} with {{para|supp}} to direct the template to select the correct URL and render the correct display.  See the table.
 +
<section begin=supp_disp-supp_interaction_table />
 +
{| class="wikitable" style="margin-left: auto; margin-right: auto;"
 +
|+ interaction between <nowiki>|supp=</nowiki> and <nowiki>|display-supp=</nowiki>
 +
!row||<nowiki>|display-supp=</nowiki> !! <nowiki>|supp=</nowiki> !! condition !! displayed result !! url !! comment
 +
|-
 +
|1|| – || – || – || &lt;''no supplement display''> || <code>/page/</code> || most common non-supplement form
 +
|-
 +
|2|| – || y || – || Supplement || <code>/supplement/</code> ||  unnumbered supplement
 +
|-
 +
|3|| – || ## || – || <code>{{{supp}}}</code>&lt;''suffix''> supplement || <code>/supplement/</code> || specific numbered supplement
 +
|-
 +
|4|| – || &lt;''text''> || – || <span style="font-size:100%; font-weight:normal" class="error"><code style="color:inherit; border:inherit; padding:inherit;">invalid <code style="color:inherit; border:inherit; padding:inherit;">&#124;supp=</code></span> || <code>/page/</code> || invalid or out of range
 +
|-
 +
|5|| <code>none</code> || y || – || &lt;''no supplement display''> || <code>/supplement/</code> || when page not at <code>/page/</code> url
 +
|-
 +
|6|| y || – || – || Supplement || <code>/supplement/</code> || when unnumbered supplement not at <code>/supplement/</code> url
 +
|-
 +
|7|| ## || – ||  – || <code>{{{display-supp}}}</code>&lt;''suffix''> supplement || <code>/page/</code> || when supplement not at <code>/supplement/</code> url
 +
|-
 +
|8|| ## || y || – || <code>{{{display-supp}}}</code>&lt;''suffix''> supplement || <code>/supplement/</code> ||  specific numbered supplement (similar to 3)
 +
|-
 +
|9|| ## || ## || <code>{{{supp}}} == {{{display-supp}}}</code> || <code>{{{display-supp}}}</code>&lt;''suffix''> supplement || <code>/supplement/</code> || <nowiki>|supp=</nowiki> and <nowiki>|display-supp=</nowiki> must agree
 +
|-
 +
|10|| ## || ## ||  <code>{{{supp}}} != {{{display-supp}}}</code> || <span style="font-size:100%; font-weight:normal" class="error"><code style="color:inherit; border:inherit; padding:inherit;">invalid <code style="color:inherit; border:inherit; padding:inherit;">&#124;supp=</code></span> || <code>/supplement/</code> || ambiguous; which supplement number is correct?
 +
|-
 +
|11|| &lt;''text''> || – || – || <code>{{{display-supp}}}</code> || <code>/page/</code> || user specified text; not at <code>/supplement/</code> url
 +
|-
 +
|12|| &lt;''text''> || y || – || <code>{{{display-supp}}}</code> || <code>/supplement/</code> || user specified text
 +
|-
 +
|13|| &lt;''text''> || ## || – || <code>{{{display-supp}}}</code> || <code>/supplement/</code> || user specified text
 +
|-
 +
|14|| &lt;''text''> || &lt;''text''> || – || <span style="font-size:100%; font-weight:normal" class="error"><code style="color:inherit; border:inherit; padding:inherit;">invalid <code style="color:inherit; border:inherit; padding:inherit;">&#124;supp=</code></span> || <code>/supplement/</code> || <code>&#124;supp=</code> invalid or out of range
 +
|-
 +
! colspan="7" | key
 +
|-
 +
| colspan="2" | – || colspan="5" | parameter is empty or missing; a condition does not apply
 +
|-
 +
| colspan="2" | ## || colspan="5" | a number greater than zero and less than 100
 +
|-
 +
| colspan="2" |  &lt;''suffix''> || colspan="5" | the appropriate ordinal suffix: 1{{blue|st}}, 2{{blue|nd}}, 3{{blue|rd}}, 4{{blue|th}}, ...
 +
|-
 +
| colspan="2" |  &lt;''text''> || colspan="5" | any characters that are not ## or the letter y (or, for {{para|disp-supp}}, not the keyword <code>none</code>)
 +
|-
 +
| colspan="2" | <code>==</code> || colspan="5" | logical equality; the statement A == B is true when A and B hold the same value
 +
|-
 +
| colspan="2" | <code>!=</code> || colspan="5" | logical inequality; the statement A != B is true when A and B hold different values
 +
|}
 +
<section end=supp_disp-supp_interaction_table />
  
 
===Source of information for parameters===
 
===Source of information for parameters===
Line 69: Line 121:
  
 
==Examples==
 
==Examples==
−
;Some standard use cases
+
'''Some standard use cases'''
 
*<nowiki>{{London Gazette
 
*<nowiki>{{London Gazette
 
|issue=33000
 
|issue=33000
 
|date=9 December 1924
 
|date=9 December 1924
−
|startpage=8957
+
|page=8957
−
}}</nowiki><br/>→ <span style="background:white">{{London Gazette
+
}}</nowiki><br />→ <span style="background:white">{{London Gazette
 
|issue=33000
 
|issue=33000
 
|date=9 December 1924
 
|date=9 December 1924
−
|startpage=8957
+
|page=8957
 
}}</span>
 
}}</span>
  
Line 83: Line 135:
 
|issue=34000
 
|issue=34000
 
|date=1 December 1933
 
|date=1 December 1933
−
|startpage=7765
+
|pages=7765–7766
−
|endpage=7766
+
}}</nowiki><br />→ <span style="background:white">{{London Gazette
−
}}</nowiki><br>→ <span style="background:white">{{London Gazette
 
 
|issue=34000
 
|issue=34000
 
|date=1 December 1933
 
|date=1 December 1933
−
|startpage=7765
+
|pages=7765–7766
−
|endpage=7766
 
 
}}</span>
 
}}</span>
  
Line 95: Line 145:
 
|issue=31712
 
|issue=31712
 
|date=30 December 1919
 
|date=30 December 1919
−
|startpage=1
+
|page=1
−
|supp=x
+
|supp=4
−
}}</nowiki><br>→ <span style="background:white">{{London Gazette
+
}}</nowiki><br />→ <span style="background:white">{{London Gazette
 
|issue=31712
 
|issue=31712
 
|date=30 December 1919
 
|date=30 December 1919
−
|startpage=1
+
|page=1
−
|supp=x
+
|supp=4
 +
}}</span>
 +
 
 +
*<nowiki>{{London Gazette
 +
|issue=17039
 +
|date=11 July 1815
 +
|page=1409
 +
|display-supp=1
 +
}}</nowiki><br />→ <span style="background:white">{{London Gazette
 +
|issue=17039
 +
|date=11 July 1815
 +
|page=1409
 +
|display-supp=1
 
}}</span>
 
}}</span>
  
Line 107: Line 169:
 
|issue=34000
 
|issue=34000
 
|date=1 December 1933
 
|date=1 December 1933
−
|startpage=7765
+
|pages=7765–7766
−
|endpage=7766
+
}}</nowiki><br />→ <span style="background:white">{{London Gazette
−
|accessdate=</nowiki>{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>
 
−
}}</nowiki><br>→ <span style="background:white">{{London Gazette
 
 
|issue=34000
 
|issue=34000
 
|date=1 December 1933
 
|date=1 December 1933
−
|startpage=7765
+
|pages=7765–7766
−
|endpage=7766
 
−
|accessdate={{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}
 
 
}}</span>
 
}}</span>
  
−
;A link to a page in the Edinburgh gazette
+
'''A link to a page in the Edinburgh gazette'''
 
*<nowiki>{{London Gazette
 
*<nowiki>{{London Gazette
 
|issue=11370
 
|issue=11370
 
|date=3 January 1902
 
|date=3 January 1902
−
|startpage=1
+
|page=1
 
|city=e
 
|city=e
−
|accessdate=</nowiki>{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>
+
}}</nowiki><br />→ <span style="background:white">{{London Gazette
−
}}</nowiki><br>→ <span style="background:white">{{London Gazette
 
 
|issue=11370
 
|issue=11370
 
|date=3 January 1902
 
|date=3 January 1902
−
|startpage=1
+
|page=1
 
|city=e
 
|city=e
−
|accessdate={{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}
 
 
}}</span>
 
}}</span>
  
−
;A link to a page in the Oxford gazette
+
'''A link to a page in the Oxford gazette'''
 
*<nowiki>{{London Gazette
 
*<nowiki>{{London Gazette
 
|issue=1
 
|issue=1
 
|date=7 November 1665
 
|date=7 November 1665
−
|startpage=1
+
|page=1
 
|city=o
 
|city=o
−
|accessdate=</nowiki>{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>
+
}}</nowiki><br />→ <span style="background:white">{{London Gazette
−
}}</nowiki><br>→ <span style="background:white">{{London Gazette
 
 
|issue=1
 
|issue=1
 
|date=7 November 1665
 
|date=7 November 1665
−
|startpage=1
+
|page=1
 
|city=o
 
|city=o
−
|accessdate={{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}
 
 
}}</span>
 
}}</span>
  
−
;No parameters (error)
+
'''No parameters (error)'''
 
*<nowiki>{{London Gazette}}</nowiki><br/>→
 
*<nowiki>{{London Gazette}}</nowiki><br/>→
 
{{London Gazette}}
 
{{London Gazette}}
  
 +
==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:
 +
*<span style="font-size:100%; font-weight:normal" class="error">invalid <code style="color:inherit; border:inherit; padding:inherit;">|supp=</code></span> – {{para|supp}} accepts a limited range of parameter values.  The values are:
 +
*:the single letter <code>y</code>
 +
*:one or two digit numbers in the range of 1 to 99 inclusive
 +
*<span style="font-size:100%; font-weight:normal" class="error">more than one of <code style="color:inherit; border:inherit; padding:inherit;">|page=</code> and <code style="color:inherit; border:inherit; padding:inherit;">|pages=</code></span> – simultaneous use of these is not permitted; choose the appropriate parameter
 +
*<span style="font-size:100%; font-weight:normal" class="error">London Gazette uses unsupported parameters</span> – these parameters no longer supported:
 +
*:{{para|ps}} – use {{para|postscript}}
 +
*:{{para|separator}} – use {{para|mode}}
 +
*:{{para|startpage}} – use {{para|page}} or {{para|pages}}
 +
*:{{para|endpage}} – use {{para|page}} or {{para|pages}}
 +
*:{{para|accessdate}} – remove
 +
*:{{para|access-date}} – remove
 +
 +
==Template Data==
 +
{{TemplateData header}}
 +
<templatedata>
 +
{
 +
"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-supppement",
 +
                        "description":  "Some supplements are accessed without an alteration to the standard ULR 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. <code>issue</code>"
 +
                },
 +
"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 <code>issue</code>"
 +
                },
 +
                "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 <code>mode</code> 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 of the Edinburgh Gazette online archives and to Belfast Gazette online archives.",
 +
"paramOrder": [
 +
"issue",
 +
"date",
 +
"page",
 +
"pages",
 +
"supp",
 +
                "display-supp",
 +
"nolink",
 +
"city",
 +
                "title",
 +
                "quote",
 +
                "ref",
 +
                "mode",
 +
"postscript",
 +
],
 +
"format": "block"
 +
}
 +
</templatedata>
 +
 +
==Maintenance categories==
 +
* [[:Category:Pages containing London Gazette template with deprecated parameters]]
 +
* [[:Category:Pages containing London Gazette template with parameter supp set to y]]
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
 
| <!-- ADD CATEGORIES BELOW THIS LINE, PLEASE: -->
 
| <!-- ADD CATEGORIES BELOW THIS LINE, PLEASE: -->

Latest revision as of 08:54, 13 October 2017

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 <ref>...</ref> tags must be added separately):

  • {{London Gazette |issue= |date= }} (For an entire issue)
  • {{London Gazette |issue= |date= |page= }} (For a single page)

Using pages to refer to a range of pages in the link: {{London Gazette |issue= |date= |pages= }}

Using city to refer to a page in the Edinburgh or Belfast Gazette in the link: {{London Gazette |issue= |date= |page= |city= }}

Using supp to link to a page in a supplement to a Gazette {{London Gazette |issue= |date= |page= |supp= }}

All parameters, delete those you don't need {{London Gazette |issue= |date= |page= |pages= |supp= |display-supp= |city= |nolink= |postscript= |mode= |title= |ref= |quote=}}

All parameters, vertical format: 

{{London Gazette
 | issue =
 | date =
 | page =
 | pages =
 | supp =
 | display-supp =
 | nolink =
 | city =
 | title =
 | quote =
 | mode =
 | ref =
 | postscript =
}}

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 Gazette. This should be in the format day month year.

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

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 |nolink=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#Display options. Setting |mode=cs2 changes the style to ensure consistency with Citation style 2, as produced by {{Citation}}.

To remove the final period, or change it to any other character:

postscript: Using |postscript= see Help:Citation Style 1#Display options — now semi-redundant, consider using |mode=.

Others

title: see Help:Citation Style 1.
ref: set by default to CITEREFGazetteissue can be altered as described in Help:Citation Style 1#Anchors.
quote: see Help:Citation Style 1#Quote
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#Title

Specifying a supplement to a Gazette:

  • supp: To correctly format the URL to link to a Gazette supplement, set this parameter to y, 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 (|supp=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.

interaction between |supp= and |display-supp=
row |display-supp= |supp= condition displayed result url comment
1 – – – <no supplement display> /page/ most common non-supplement form
2 – y – Supplement /supplement/ unnumbered supplement
3 – ## – {{{supp}}}<suffix> supplement /supplement/ specific numbered supplement
4 – <text> – supp= /page/ invalid or out of range
5 none y – <no supplement display> /supplement/ when page not at /page/ url
6 y – – Supplement /supplement/ when unnumbered supplement not at /supplement/ url
7 ## – – {{{display-supp}}}<suffix> supplement /page/ when supplement not at /supplement/ url
8 ## y – {{{display-supp}}}<suffix> supplement /supplement/ specific numbered supplement (similar to 3)
9 ## ## {{{supp}}} == {{{display-supp}}} {{{display-supp}}}<suffix> supplement /supplement/ |supp= and |display-supp= must agree
10 ## ## {{{supp}}} != {{{display-supp}}} supp= /supplement/ ambiguous; which supplement number is correct?
11 <text> – – {{{display-supp}}} /page/ user specified text; not at /supplement/ url
12 <text> y – {{{display-supp}}} /supplement/ user specified text
13 <text> ## – {{{display-supp}}} /supplement/ user specified text
14 <text> <text> – supp= /supplement/ supp= invalid or out of range
key
– parameter is empty or missing; a condition does not apply
## a number greater than zero and less than 100
<suffix> the appropriate ordinal suffix: 1st, 2nd, 3rd, 4th, ...
<text> any characters that are not ## or the letter y (or, for |disp-supp=, not the keyword none)
== logical equality; the statement A == B is true when A and B hold the same value
!= logical inequality; the statement A != B is true when A and B hold different values

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:
    1. The issue number. This may be up to five digits and also appear in the URL after ".../issue/".
    2. The page number. This may be up to five digits and also appears as the last group of characters in the URL.
    3. The publication date
  4. If the reference needs to refer to a range of pages, find the last relevant page and note the page number as before.
  5. Check if the page is part of an issue or a supplement
    1. If from a standard gazette issue, the following will be included in the URL, ".../page/..." and no action is required.
    2. 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.
  6. When referencing the Belfast or Edinburgh Gazettes, use |city=b or |city=e. When referencing the first 23 issues of the London Gazette (published as the Oxford Gazette) use |city=o. Setting |city=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.
  7. Add each of these to the template
  8. 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)

  • {{London Gazette}}
    →

You must specify issue= and date= when using {{London Gazette}}.

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= – |supp= accepts a limited range of parameter values. The values are:
    the single letter y
    one or two digit numbers in the range of 1 to 99 inclusive
  • more than one of |page= and |pages= – 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

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for London Gazette

<templatedata> { "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-supppement",
                       "description":  "Some supplements are accessed without an alteration to the standard ULR 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. issue"
               },

"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 issue"
               },
               "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 mode 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 of the Edinburgh Gazette online archives and to Belfast Gazette online archives.", "paramOrder": [ "issue", "date", "page", "pages", "supp", 

               "display-supp",

"nolink", "city", 

               "title",
               "quote",
               "ref",
               "mode",

"postscript", ], "format": "block" } </templatedata>

Maintenance categories

Retrieved from "https://wikispooks.com/w/index.php?title=Template:London_Gazette/doc&oldid=123518"