Content added Content deleted
m (1 revision imported) |
(redirect to wikipedia doc page) |
||
| Line 1: | Line 1: | ||
#REDIRECT [[w:Template:National Heritage List for England/doc]] |
|||
{{Documentation subpage}} |
|||
__NOTOC__ |
|||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> |
|||
{{Template shortcut|NHLE}} |
|||
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 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: |
|||
*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 {{para|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 {{para|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 {{para|date}} or {{para|year}} is also used. |
|||
*'''accessdate''': 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}}. |
|||
*'''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''': use {{para|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 {{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=== |
|||
<code><nowiki>{{National Heritage List for England|num=1188692}}</nowiki></code> displays as: |
|||
:{{National Heritage List for England|num=1188692|ref=none}} |
|||
<code><nowiki>{{National Heritage List for England|num=1188692|short=yes}}</nowiki></code> displays as: |
|||
:{{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: |
|||
:{{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*|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|accessdate={{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} |
|||
<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|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 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> |
|||
<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: |
|||
:{{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}} |
|||
==Template data== |
|||
{{TemplateDataHeader}} |
|||
<templatedata> |
|||
{ |
|||
"description": "Provides an external link to an entry on Historic England's National Heritage List for England (NHLE) database of heritage assets", |
|||
"params": { |
|||
"num": { |
|||
"label": "num", |
|||
"description": "the 'list entry number' from the database", |
|||
"required": true, |
|||
"type": "string" |
|||
}, |
|||
"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.", |
|||
"required": false, |
|||
"suggested": true, |
|||
"default": "Details from listed building database", |
|||
"type": "string" |
|||
}, |
|||
"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", |
|||
"required": false, |
|||
"type": "string", |
|||
}, |
|||
"author": { |
|||
"label": "author", |
|||
"description": "Defaults to 'Historic England' but can be changed to another name if desired", |
|||
"required": false, |
|||
"default": "Historic England", |
|||
"type": "string" |
|||
}, |
|||
"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", |
|||
"required": false, |
|||
"default": "Historic England", |
|||
"type": "string" |
|||
}, |
|||
"date": { |
|||
"label": "date", |
|||
"description": "The date provided by Historic England; can be a full or partial date.", |
|||
"required": false, |
|||
"type": "string" |
|||
}, |
|||
"year": { |
|||
"label": "year", |
|||
"description": "The year provided by Historic England; use of date parameter is recommended.", |
|||
"required": false, |
|||
"type": "string" |
|||
}, |
|||
"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.", |
|||
"required": false, |
|||
"type": "string", |
|||
}, |
|||
"accessdate": { |
|||
"label": "accessdate", |
|||
"description": "The date a Wikipedia editor retrieved information from the Historic England list database.", |
|||
"required": false, |
|||
"suggested": true, |
|||
"aliases": ["access-date"], |
|||
"autovalue": "{{subst:CURRENTDAY}} {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}", |
|||
"type": "string" |
|||
}, |
|||
"mode": { |
|||
"label": "mode", |
|||
"description": "Defaults to 'cs1'; set to 'cs2' to provide consistency with Citation style 2, as produced by {{Citation}}", |
|||
"required": false, |
|||
"default": "cs1", |
|||
"type": "string" |
|||
}, |
|||
"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.", |
|||
"required": false, |
|||
"default": ".", |
|||
"type": "string" |
|||
}, |
|||
"fewer-links": { |
|||
"label": "fewer-links", |
|||
"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, |
|||
"default": "yes", |
|||
"type": "string" |
|||
}, |
|||
"ref": { |
|||
"label": "ref", |
|||
"description": "Defaults to author and the Historic England list number, but can be set to any value.", |
|||
"required": false, |
|||
"type": "number" |
|||
}, |
|||
"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.", |
|||
"required": false, |
|||
"default": "yes", |
|||
"type": "string" |
|||
} |
|||
} |
|||
} |
|||
</templatedata> |
|||
==See also== |
|||
*{{tl|PastScape}} — provides a link to the PastScape section of the [[Historic England Archive]], ''[[National Monuments Record]]'' |
|||
*{{tl|Images of England}} — provides a link to the Historic England, ''[[Images of England]]'' site |
|||
<includeonly> |
|||
<!-- CATEGORIES HERE, THANKS --> |
|||
[[Category:Heritage citation templates]] |
|||
</includeonly> |
|||