Template:National Heritage List for England/doc: Difference between revisions
meta>Fayenatic london (re-cat) |
(Updated SSL https URLs from Historic England, other corrections to comply exactly with HE display text) |
||
Line 3: | Line 3: | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
{{Template shortcut|NHLE}} | {{Template shortcut|NHLE}} | ||
This template is used to provide a link to the [[Historic England]] — National Heritage List for England database ( | This template is used to provide a link to the [[Historic England]] — [[National Heritage List for England]] database <tt>(https://HistoricEngland.org.uk/listing/the-list/)</tt> for a specified listed building or object in [[England]]. | ||
For listed | For [[listed building]]s, the database records ''all'' those in England, and is updated as changes to entries are made and new listings are added. The similar [[Images of England]] (IoE) list records a snapshot of those listed at the turn of the millennium, and provides a photograph, but uses a ''different index number'', and is not updated with list changes since it was created. | ||
The database also contains the following registered historic locations or sites in England: | The database also contains the following registered historic locations or sites in England: | ||
Line 16: | Line 16: | ||
==Usage== | ==Usage== | ||
===Required parameter=== | ===Required parameter=== | ||
*'''num''': the | *'''num''': the 'list entry number' from the database (''not the same as the IoE Number used by Images of England''). | ||
===Optional parameters=== | ===Optional parameters=== | ||
Additional information for the title: | Additional information for the title: | ||
*'''desc''': | *'''desc''': additional text description such as the name of the building or site. Useful if there are several listed objects in an article. If this parameter is not used default text "Details from listed building database" will be displayed instead. | ||
*'''grade''': | *'''grade''': to identify the Grade of a listed building. Enter as II, II* or I. Only appears if {{para|desc}} is also used. | ||
*'''author''': | *'''author''': defaults to 'Historic England' but can be changed to another name if desired. | ||
*'''author-link''': | *'''author-link''': defaults to "Historic England" but is not set by default if author is set to something other than Historic England. | ||
*'''date''': | *'''date''': the date provided by Historic England. Can be a full or partial date. | ||
*'''year''': | *'''year''': the year provided by Historic England. Use of {{para|date}} is recommended; see [[Template:Cite web/doc#Date]] for proper usage. | ||
*'''orig-date''': | *'''orig-date''': the date information was first provided by Historic England. Only appears if {{para|date}} or {{para|year}} is also used. | ||
*''' | *'''accessdate''': the date a Wikipedia editor retrieved information from the Historic England list database. | ||
*'''mode''': | *'''mode''': defaults to {{para|mode|cs1}}; set to {{para|mode|cs2}} to provide consistency with [[Help:Citation Style 2|Citation style 2]], as produced by {{tlx|Citation}}. | ||
*'''postscript''': | *'''postscript''': controls the closing punctuation for the citation. Defaults to a period (<code>.</code>); for no terminating punctuation set to {{para|postscript|none}}, however using {{para|mode|cs2}} does this automatically. | ||
*'''fewer-links''': | *'''fewer-links''': use {{para|fewer-links|yes}} to remove repeated links where the template is used more than once in an article. | ||
*'''ref''': | *'''ref''': defaults to author (Historic England) and the Historic England List Number, but can be reset to any value. | ||
*'''short''': | *'''short''': use {{para|short|yes}} with {{para|num}} to produce an external link with just the list number shown. {{para|short|yes}} suppresses the display of other parameters. | ||
===Examples=== | ===Examples=== | ||
<code><nowiki>{{National Heritage List for England |num=1188692}}</nowiki></code> displays as: | <code><nowiki>{{National Heritage List for England|num=1188692}}</nowiki></code> displays as: | ||
:{{National Heritage List for England |num=1188692|ref=none}} | :{{National Heritage List for England|num=1188692|ref=none}} | ||
<code><nowiki>{{National Heritage List for England |num=1188692|short=yes }}</nowiki></code> displays as: | <code><nowiki>{{National Heritage List for England|num=1188692|short=yes}}</nowiki></code> displays as: | ||
:{{National Heritage List for England |num=1188692|short=yes }} | :{{National Heritage List for England|num=1188692|short=yes}} | ||
<code><nowiki>{{National Heritage List for England |num=1188692 |desc=Southgate Underground station}}</nowiki></code> displays as: | <code><nowiki>{{National Heritage List for England|num=1188692|desc=Southgate Underground station}}</nowiki></code> displays as: | ||
:{{National Heritage List for England |num=1188692 |desc=Southgate Underground station|ref=none}} | :{{National Heritage List for England|num=1188692|desc=Southgate Underground station|ref=none}} | ||
<code><nowiki>{{National Heritage List for England |num=1188692 |desc=Southgate Underground station |grade=II* | | <code><nowiki>{{National Heritage List for England|num=1188692|desc=Southgate Underground station|grade=II*|accessdate=</nowiki>{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code> displays as: | ||
:{{National Heritage List for England |num=1188692 |desc=Southgate Underground station |grade=II* |ref=none | | :{{National Heritage List for England|num=1188692|desc=Southgate Underground station|grade=II*|ref=none|accessdate={{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} | ||
<code><nowiki>{{National Heritage List for England |num=1162800 |desc=Church of St Michael and All Angels, Ashton-under-Lyne | | <code><nowiki>{{National Heritage List for England|num=1162800|desc=Church of St Michael and All Angels, Ashton-under-Lyne|accessdate=</nowiki>{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>|mode=cs2}}</nowiki></code> displays as: | ||
:{{National Heritage List for England |num=1162800 |desc=Church of St Michael and All Angels, Ashton-under-Lyne | | :{{National Heritage List for England|num=1162800|desc=Church of St Michael and All Angels, Ashton-under-Lyne|accessdate={{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}|mode=cs2}} | ||
If a short citation is required (not to be confused with {{para|short}}) and one of the {{tl|harv}} templates or {{tl|sfn}} is used then <code><nowiki>{{</nowiki>harv|Historic England|''Historic England | If a short citation is required (not to be confused with {{para|short}}) and one of the {{tl|harv}} templates or {{tl|sfn}} is used then <code><nowiki>{{</nowiki>harv|Historic England|''Historic England list entry number''}}</code> will link the short reference to the long one. For example, <code><nowiki>{{</nowiki>harv|Historic England|1162800}}</code> produces {{harv|Historic England|1162800}} that links to the 'Church of St Michael and All Angels' example above. This is different from the standard use of the {{template|harv}} that links using the parameters 'author' and 'date' or 'year'. | ||
Some articles (e.g. [[Kingston upon Hull]]) have multiple entries. {{para|fewer-links|yes}} can be used to remove the repeated internal links from second and later instances of the template:<br | Some articles (e.g. [[Kingston upon Hull]]) have multiple entries. {{para|fewer-links|yes}} can be used to remove the repeated internal links from second and later instances of the template:<br> | ||
<code><nowiki>{{</nowiki>National Heritage List for England |num=1001519 |desc=East Park, Hull}}</code><br | <code><nowiki>{{</nowiki>National Heritage List for England|num=1001519|desc=East Park, Hull}}</code><br> | ||
<code><nowiki>{{</nowiki>National Heritage List for England |num=1001520 |desc=Pearson Park |fewer-links=yes}}</code> displays as: | <code><nowiki>{{</nowiki>National Heritage List for England|num=1001520|desc=Pearson Park|fewer-links=yes}}</code> displays as: | ||
:{{National Heritage List for England |num=1001519 |desc=East Park, Hull|ref=none}}<br | :{{National Heritage List for England|num=1001519|desc=East Park, Hull|ref=none}}<br> | ||
:{{National Heritage List for England |num=1001520 |desc=Pearson Park |fewer-links=yes|ref=none}} | :{{National Heritage List for England|num=1001520|desc=Pearson Park|fewer-links=yes|ref=none}} | ||
==Template data== | ==Template data== | ||
Line 66: | Line 66: | ||
"num": { | "num": { | ||
"label": "num", | "label": "num", | ||
"description": "the | "description": "the 'list entry number' from the database", | ||
"required": true, | "required": true, | ||
"type": "string" | "type": "string" | ||
Line 72: | Line 72: | ||
"desc": { | "desc": { | ||
"label": "desc", | "label": "desc", | ||
"description": "Additional text description such as the name of the building or site. Useful if there are several listed objects in an article. If this parameter is not used default text 'Details from listed building database' will be displayed instead.", | "description": "Additional text description such as the name of the building or site. Useful if there are several listed objects in an article. If this parameter is not used default text 'Details from listed building database' will be displayed instead.", | ||
"required": false, | "required": false, | ||
"suggested": true, | "suggested": true, | ||
Line 80: | Line 80: | ||
"grade": { | "grade": { | ||
"label": "grade", | "label": "grade", | ||
"description": "To identify the grade of a listed building. Enter as 'II', 'II*' or 'I'. Only appears if desc is also used", | "description": "To identify the grade of a listed building. Enter as 'II', 'II*' or 'I'. Only appears if desc is also used", | ||
"required": false, | "required": false, | ||
"type": "string", | "type": "string", | ||
Line 100: | Line 100: | ||
"date": { | "date": { | ||
"label": "date", | "label": "date", | ||
"description": "The date provided by Historic England. Can be a full or partial date.", | "description": "The date provided by Historic England. Can be a full or partial date.", | ||
"required": false, | "required": false, | ||
"type": "string" | "type": "string" | ||
Line 106: | Line 106: | ||
"year": { | "year": { | ||
"label": "year", | "label": "year", | ||
"description": "The year provided by Historic England. Use of date parameter is recommended.", | "description": "The year provided by Historic England. Use of date parameter is recommended.", | ||
"required": false, | "required": false, | ||
"type": "string" | "type": "string" | ||
Line 112: | Line 112: | ||
"orig-date": { | "orig-date": { | ||
"label": "orig-date", | "label": "orig-date", | ||
"description": "The date information was first provided by Historic England. Only appears if date or year parameter is also used.", | "description": "The date information was first provided by Historic England. Only appears if date or year parameter is also used.", | ||
"required": false, | "required": false, | ||
"type": "string", | "type": "string", | ||
Line 118: | Line 118: | ||
"access-date": { | "access-date": { | ||
"label": "access-date", | "label": "access-date", | ||
"description": "The date a Wikipedia editor retrieved information from the Historic England | "description": "The date a Wikipedia editor retrieved information from the Historic England list database.", | ||
"required": false, | "required": false, | ||
"suggested": true, | "suggested": true, | ||
Line 134: | Line 134: | ||
"postscript": { | "postscript": { | ||
"label": "postscript", | "label": "postscript", | ||
"description": "Controls the closing punctuation for the citation. Defaults to a period (.); for no terminating punctuation set to none, however using mode=cs2 does this automatically.", | "description": "Controls the closing punctuation for the citation. Defaults to a period (.); for no terminating punctuation set to none, however using mode=cs2 does this automatically.", | ||
"required": false, | "required": false, | ||
"default": ".", | "default": ".", | ||
Line 141: | Line 141: | ||
"fewer-links": { | "fewer-links": { | ||
"label": "fewer-links", | "label": "fewer-links", | ||
"description": "Set to 'yes' to remove repeated | "description": "Set to 'yes' to remove repeated wikilinks to Historic England, where the template is used more than once in an article.", | ||
"required": false, | "required": false, | ||
"default": "yes", | "default": "yes", | ||
Line 148: | Line 148: | ||
"ref": { | "ref": { | ||
"label": "ref", | "label": "ref", | ||
"description": "Defaults to author and the Historic England | "description": "Defaults to author and the Historic England list number, but can be set to any value.", | ||
"required": false, | "required": false, | ||
"type": "number" | "type": "number" | ||
Line 154: | Line 154: | ||
"short": { | "short": { | ||
"label": "short", | "label": "short", | ||
"description": " Use 'yes' with just the num parameter to produce an external link with just the list number shown. Suppresses the display of other parameters.", | "description": " Use 'yes' with just the num parameter to produce an external link with just the list number shown. Suppresses the display of other parameters.", | ||
"required": false, | "required": false, | ||
"default": "yes", | "default": "yes", | ||
Line 163: | Line 163: | ||
</templatedata> | </templatedata> | ||
== See also == | ==See also== | ||
*{{tl|PastScape}} — | *{{tl|PastScape}} — provides a link to the Historic England, ''[[National Monument Record]]'' ([[PastScape]]) | ||
*{{tl|Images of England}} — provides a link to the Historic England, ''Images of England'' site | *{{tl|Images of England}} — provides a link to the Historic England, ''[[Images of England]]'' site | ||
<includeonly> | <includeonly> |
Revision as of 22:33, 27 February 2017
This is a documentation subpage for Template:National Heritage List for England. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used to provide a link to the Historic England — National Heritage List for England database (https://HistoricEngland.org.uk/listing/the-list/) for a specified listed building or object in England.
For listed buildings, the database records all those in England, and is updated as changes to entries are made and new listings are added. The similar Images of England (IoE) list records a snapshot of those listed at the turn of the millennium, and provides a photograph, but uses a different index number, and is not updated with list changes since it was created.
The database also contains the following registered historic locations or sites in England:
- Historic Parks and Gardens
- Scheduled monuments
- Protected wrecks
- Historic battlefields
- World Heritage sites
Usage
Required parameter
- num: the 'list entry number' from the database (not the same as the IoE Number used by Images of England).
Optional parameters
Additional information for the title:
- desc: additional text description such as the name of the building or site. Useful if there are several listed objects in an article. If this parameter is not used default text "Details from listed building database" will be displayed instead.
- grade: to identify the Grade of a listed building. Enter as II, II* or I. Only appears if
|desc=
is also used. - author: defaults to 'Historic England' but can be changed to another name if desired.
- author-link: defaults to "Historic England" but is not set by default if author is set to something other than Historic England.
- date: the date provided by Historic England. Can be a full or partial date.
- year: the year provided by Historic England. Use of
|date=
is recommended; see Template:Cite web/doc#Date for proper usage. - orig-date: the date information was first provided by Historic England. Only appears if
|date=
or|year=
is also used. - accessdate: the date a Wikipedia editor retrieved information from the Historic England list database.
- mode: defaults to
|mode=cs1
; set to|mode=cs2
to provide consistency with Citation style 2, as produced by{{Citation}}
. - postscript: controls the closing punctuation for the citation. Defaults to a period (
.
); for no terminating punctuation set to|postscript=none
, however using|mode=cs2
does this automatically. - fewer-links: use
|fewer-links=yes
to remove repeated links where the template is used more than once in an article. - ref: defaults to author (Historic England) and the Historic England List Number, but can be reset to any value.
- short: use
|short=yes
with|num=
to produce an external link with just the list number shown.|short=yes
suppresses the display of other parameters.
Examples
{{National Heritage List for England|num=1188692}}
displays as:
- Historic England. "Details from listed building database (1188692)". National Heritage List for England.
{{National Heritage List for England|num=1188692|short=yes}}
displays as:
{{National Heritage List for England|num=1188692|desc=Southgate Underground station}}
displays as:
{{National Heritage List for England|num=1188692|desc=Southgate Underground station|grade=II*|accessdate=3 June 2024}}
displays as:
- Historic England. "Southgate Underground station (Grade II*) (1188692)". National Heritage List for England. Retrieved 3 June 2024.
{{National Heritage List for England|num=1162800|desc=Church of St Michael and All Angels, Ashton-under-Lyne|accessdate=3 June 2024|mode=cs2}}
displays as:
- Historic England, "Church of St Michael and All Angels, Ashton-under-Lyne (1162800)", National Heritage List for England, retrieved 3 June 2024
If a short citation is required (not to be confused with |short=
) and one of the {{harv}} templates or {{sfn}} is used then {{harv|Historic England|Historic England list entry number}}
will link the short reference to the long one. For example, {{harv|Historic England|1162800}}
produces (Historic England & 1162800) that links to the 'Church of St Michael and All Angels' example above. This is different from the standard use of the {{harv}} that links using the parameters 'author' and 'date' or 'year'.
Some articles (e.g. Kingston upon Hull) have multiple entries. |fewer-links=yes
can be used to remove the repeated internal links from second and later instances of the template:
{{National Heritage List for England|num=1001519|desc=East Park, Hull}}
{{National Heritage List for England|num=1001520|desc=Pearson Park|fewer-links=yes}}
displays as:
- Historic England. "East Park, Hull (1001519)". National Heritage List for England.
- Historic England. "Pearson Park (1001520)". National Heritage List for England.
Template data
TemplateData for National Heritage List for England
See also
- {{PastScape}} — provides a link to the Historic England, National Monument Record (PastScape)
- {{Images of England}} — provides a link to the Historic England, Images of England site