Template:National Heritage List for England/doc: Difference between revisions
meta>JJMC89 (fix cat) |
m (86 revisions imported) |
||
(15 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{cs1 wrapper|base=cite web}} | |||
__NOTOC__ | __NOTOC__ | ||
<!-- PLEASE ADD CATEGORIES | <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE --> | ||
{{Template shortcut|NHLE}} | {{Template shortcut|NHLE}} | ||
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. | This template is used to provide a link to the [[Historic England]] — [[National Heritage List for England]] (NHLE) database <code>(https://HistoricEngland.org.uk/listing/the-list/)</code> for a specified listed building or object in [[England]]. | ||
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 18: | ||
==Usage== | ==Usage== | ||
===Required parameter=== | ===Required parameter=== | ||
*'''num''': the 'list entry number' from the database (''not the same as the IoE number used by Images of England''). | *'''num''': the 'list entry number' from the database <!--(''not the same as the IoE number used by Images of England'')-->. | ||
===Optional parameters=== | ===Optional parameters=== | ||
Line 26: | Line 28: | ||
*'''date''': the date provided by Historic England; can be a full or partial date | *'''date''': the date provided by Historic England; can be a full or partial date | ||
*'''year''': the year provided by Historic England; use of {{para|date}} is recommended, see [[Template:Cite web/doc#Date]] for proper usage | *'''year''': the year provided by Historic England; use of {{para|date}} is recommended, see [[Template:Cite web/doc#Date]] for proper usage | ||
*'''orig- | *'''orig-year''': the year information was first provided by Historic England; only appears if {{para|date}} or {{para|year}} is also used | ||
*''' | *'''access-date''': the date a Wikipedia editor retrieved information from the Historic England list database. | ||
*'''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}} | *'''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''': 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 | *'''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 | ||
Line 33: | Line 35: | ||
*'''ref''': defaults to author (Historic England) and the Historic England List Number, but can be reset to any value | *'''ref''': defaults to author (Historic England) and the Historic England List Number, but can be reset to any value | ||
*'''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. | *'''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. | ||
All {{tl|Cite web}} parameters are available. | |||
===Examples=== | ===Examples=== | ||
Line 44: | Line 48: | ||
:{{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*|access-date=</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|access-date={{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|access-date=</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|access-date={{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 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'. | 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 wikilinks from any additional and subsequent 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 wikilinks from any additional and subsequent 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}} | ||
Line 68: | Line 72: | ||
"description": "the 'list entry number' from the database", | "description": "the 'list entry number' from the database", | ||
"required": true, | "required": true, | ||
"type": " | "type": "number" | ||
}, | }, | ||
"desc": { | "desc": { | ||
Line 75: | Line 79: | ||
"required": false, | "required": false, | ||
"suggested": true, | "suggested": true, | ||
"default": "Details from listed building database", | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
Line 82: | Line 86: | ||
"description": "to display the Grade of a listed building: enter as 'II', 'II*' or 'I', only appears if desc is also used", | "description": "to display 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" | ||
}, | }, | ||
"author": { | "author": { | ||
Line 94: | Line 98: | ||
"label": "author-link", | "label": "author-link", | ||
"description": "defaults to 'Historic England', but is not set by default if author is set to something other than Historic England", | "description": "defaults to 'Historic England', but is not set by default if author is set to something other than Historic England", | ||
"required": false, | |||
"default": "Historic England", | "default": "Historic England", | ||
"type": "string" | "type": "string" | ||
Line 110: | Line 114: | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"orig- | "orig-year": { | ||
"label": "orig- | "label": "orig-year", | ||
"description": "the | "description": "the year information was first provided by Historic England; only appears if date or year parameter is also used", | ||
"required": false, | "required": false, | ||
"type": "string" | "aliases": ["origyear"], | ||
"type": "string" | |||
}, | }, | ||
" | "access-date": { | ||
"label": " | "label": "access-date", | ||
"description": "the date a Wikipedia editor retrieved and/or verified information from the Historic England list database", | "description": "the date a Wikipedia editor retrieved and/or verified information from the Historic England list database", | ||
"required": false, | "required": false, | ||
"suggested": true, | "suggested": true, | ||
"aliases": [" | "aliases": ["accessdate"], | ||
"autovalue": "{{subst:CURRENTDAY}} {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}", | "autovalue": "{{subst:CURRENTDAY}} {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}", | ||
"type": "string" | "type": "string" | ||
Line 129: | Line 134: | ||
"description": "defaults to 'cs1'; set to 'cs2' to provide consistency with Citation style 2, as produced by {{citation}}", | "description": "defaults to 'cs1'; set to 'cs2' to provide consistency with Citation style 2, as produced by {{citation}}", | ||
"required": false, | "required": false, | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
Line 136: | Line 140: | ||
"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, | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
Line 143: | Line 146: | ||
"description": "set to 'yes' to remove repeated wikilinks to 'Historic England' and 'National Heritage List for England', where the template is used more than once in an article", | "description": "set to 'yes' to remove repeated wikilinks to 'Historic England' and 'National Heritage List for England', where the template is used more than once in an article", | ||
"required": false, | "required": false, | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
Line 150: | Line 152: | ||
"description": "defaults to author and the Historic England list number, but can be set to any value", | "description": "defaults to author and the Historic England list number, but can be set to any value", | ||
"required": false, | "required": false, | ||
"type": " | "type": "string" | ||
}, | }, | ||
"short": { | "short": { | ||
Line 156: | Line 158: | ||
"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, | ||
"type": "string" | "type": "string" | ||
} | } | ||
Line 162: | Line 163: | ||
} | } | ||
</templatedata> | </templatedata> | ||
==Tracking categories== | |||
* {{clc|Historic England citations needing attention}} | |||
*:This tracks pages which have an empty {{para|num}} field. | |||
==See also== | ==See also== | ||
*{{tl|PastScape}} — provides a link to the PastScape section of the [[Historic England Archive]] (HEA), formerly known as the ''[[National Monuments Record]]'' (NMR) | *{{tl|PastScape}} — provides a link to the PastScape section of the [[Historic England Archive]] (HEA), formerly known as the ''[[National Monuments Record]]'' (NMR) | ||
*{{tl|Images of England}} — provides a link to the Historic England, ''[[Images of England]]'' (IoE) site | <!--*{{tl|Images of England}} — provides a link to the Historic England, ''[[Images of England]]'' (IoE) site--> | ||
*{{tl|National Historic Assets of Wales}} - provides a link to a [[Cadw]] National Historic Assets of Wales list entry. | |||
*{{tl|Historic Environment Scotland}} - provides a link to items on the [[Historic Environment Scotland]] database. | |||
<includeonly>{{sandbox other|| | <includeonly>{{sandbox other|| | ||
<!-- CATEGORIES HERE, THANKS --> | <!-- CATEGORIES HERE, THANKS --> | ||
[[Category:Heritage citation templates]]}}</includeonly> | [[Category:Heritage citation templates]] | ||
[[Category:Templates that add a tracking category]] | |||
}}</includeonly> |
Latest revision as of 13:28, 3 September 2020
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 a Citation Style 1 wrapper template based on {{Cite web}}. For centralised Citation Style 1 discussions, see Help talk:Citation Style 1. |
This template is used to provide a link to the Historic England — National Heritage List for England (NHLE) 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 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 .
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 display 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-year: the year information was first provided by Historic England; only appears if
|date=
or|year=
is also used - access-date: 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 wikilinks 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.
All {{Cite web}} parameters are available.
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*|access-date=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|access-date=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 wikilinks from any additional and subsequent 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
Provides an external link to an entry on Historic England's National Heritage List for England (NHLE) database of heritage assets
Parameter | Description | Type | Status | |
---|---|---|---|---|
num | num | the 'list entry number' from the database | Number | required |
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.
| String | suggested |
grade | grade | to display the Grade of a listed building: enter as 'II', 'II*' or 'I', only appears if desc is also used | String | optional |
author | author | defaults to 'Historic England', but can be changed to another name if desired
| String | optional |
author-link | author-link | defaults to 'Historic England', but is not set by default if author is set to something other than Historic England
| String | optional |
date | date | the date provided by Historic England; can be a full or partial date | String | optional |
year | year | the year provided by Historic England; use of date parameter is recommended | String | optional |
orig-year | orig-year origyear | the year information was first provided by Historic England; only appears if date or year parameter is also used | String | optional |
access-date | access-date accessdate | the date a Wikipedia editor retrieved and/or verified information from the Historic England list database
| String | suggested |
mode | mode | defaults to 'cs1'; set to 'cs2' to provide consistency with Citation style 2, as produced by {{citation}} | String | optional |
postscript | postscript | 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 | String | optional |
fewer-links | fewer-links | set to 'yes' to remove repeated wikilinks to 'Historic England' and 'National Heritage List for England', where the template is used more than once in an article | String | optional |
ref | ref | defaults to author and the Historic England list number, but can be set to any value | String | optional |
short | short | use 'yes' with just the num parameter to produce an external link with just the list number shown; suppresses the display of other parameters | String | optional |
Tracking categories
- Category:Historic England citations needing attention (0)
- This tracks pages which have an empty
|num=
field.
- This tracks pages which have an empty
See also
- {{PastScape}} — provides a link to the PastScape section of the Historic England Archive (HEA), formerly known as the National Monuments Record (NMR)
- {{National Historic Assets of Wales}} - provides a link to a Cadw National Historic Assets of Wales list entry.
- {{Historic Environment Scotland}} - provides a link to items on the Historic Environment Scotland database.