Template:National Heritage List for England/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
VisualWikitext
meta>Jenks24
m (Jenks24 moved page Template:National Heritage List for England entry/doc to Template:National Heritage List for England/doc over redirect: per requested move discussion; see talk)
m (86 revisions imported)
 
(28 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{cs1 wrapper|base=cite web}}
__NOTOC__
__NOTOC__
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- PLEASE ADD CATEGORIES 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 (http://www.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.
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===
Additional information for the title:
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.
*'''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.
*'''grade''': to display 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''': 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.
*'''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.
*'''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-date''': The date information was first provided by Historic England. Only appears if {{para|date}} or {{para|year}} is also used.
*'''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.
*'''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
*'''fewer-links''': Use {{para|fewer-links|yes}} to remove repeated links where the template is used more than once in an article.
*'''fewer-links''': use {{para|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.
*'''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===
<code><nowiki>{{National Heritage List for England entry |num=1188692}}</nowiki></code> displays as:
<code><nowiki>{{National Heritage List for England|num=1188692}}</nowiki></code> displays as:
:{{National Heritage List for England entry |num=1188692}}
:{{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 entry |num=1188692|short=yes }}</nowiki></code> displays as:
<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 entry |num=1188692|short=yes }}
:{{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 entry |num=1188692 |desc=Southgate Underground station}}</nowiki></code> displays as:
<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 entry |num=1188692 |desc=Southgate Underground station}}
:{{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}}


<code><nowiki>{{National Heritage List for England entry |num=1188692 |desc=Southgate Underground station |grade=II* |access-date=</nowiki>{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code> displays as:
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'.
:{{National Heritage List for England entry |num=1188692 |desc=Southgate Underground station |grade=II* |access-date={{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}


<code><nowiki>{{National Heritage List for England entry |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:
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 />
:{{National Heritage List for England entry |num=1162800 |desc=Church of St Michael and All Angels, Ashton-under-Lyne |access-date={{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}} |mode=cs2}}
<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}}


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".
==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": "number"
},
"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 display 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-year": {
"label": "orig-year",
"description": "the year information was first provided by Historic England; only appears if date or year parameter is also used",
"required": false,
                        "aliases": ["origyear"],
"type": "string"
},
"access-date": {
"label": "access-date",
"description": "the date a Wikipedia editor retrieved and/or verified information from the Historic England list database",
"required": false,
"suggested": true,
"aliases": ["accessdate"],
"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,
"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,
"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,
"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": "string"
},
"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,
"type": "string"
}
}
}
</templatedata>


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 />
==Tracking categories==
<code><nowiki>{{</nowiki>National Heritage List for England entry |num=1001519 |desc=East Park, Hull}}</code><br/>
* {{clc|Historic England citations needing attention}}
<code><nowiki>{{</nowiki>National Heritage List for England entry |num=1001520 |desc=Pearson Park |fewer-links=yes}}</code> displays as:
*:This tracks pages which have an empty {{para|num}} field.
:{{National Heritage List for England |num=1001519 |desc=East Park, Hull}}<br />
:{{National Heritage List for England |num=1001520 |desc=Pearson Park |fewer-links=yes}}


== See also ==
==See also==
*{{tl|Cite PastScape}} — provides a link to the Historic England, ''National Monument Record'' (PastScape)
*{{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'' 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>
<includeonly>{{sandbox other||
<!-- CATEGORIES HERE, THANKS -->
<!-- CATEGORIES HERE, THANKS -->
[[Category:Heritage templates]]
[[Category:Heritage citation templates]]
</includeonly>
[[Category:Templates that add a tracking category]]
}}</includeonly>

Latest revision as of 13:28, 3 September 2020

Shortcut

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:

1188692

{{National Heritage List for England|num=1188692|desc=Southgate Underground station}} displays as:

Historic England. "Southgate Underground station (1188692)". National Heritage List for England.

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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

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

Template parameters

ParameterDescriptionTypeStatus
numnum

the 'list entry number' from the database

Numberrequired
descdesc

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.

Default
Details from listed building database
Stringsuggested
gradegrade

to display the Grade of a listed building: enter as 'II', 'II*' or 'I', only appears if desc is also used

Stringoptional
authorauthor

defaults to 'Historic England', but can be changed to another name if desired

Default
Historic England
Stringoptional
author-linkauthor-link

defaults to 'Historic England', but is not set by default if author is set to something other than Historic England

Default
Historic England
Stringoptional
datedate

the date provided by Historic England; can be a full or partial date

Stringoptional
yearyear

the year provided by Historic England; use of date parameter is recommended

Stringoptional
orig-yearorig-year origyear

the year information was first provided by Historic England; only appears if date or year parameter is also used

Stringoptional
access-dateaccess-date accessdate

the date a Wikipedia editor retrieved and/or verified information from the Historic England list database

Auto value
{{subst:CURRENTDAY}} {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}
Stringsuggested
modemode

defaults to 'cs1'; set to 'cs2' to provide consistency with Citation style 2, as produced by {{citation}}

Stringoptional
postscriptpostscript

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

Stringoptional
fewer-linksfewer-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

Stringoptional
refref

defaults to author and the Historic England list number, but can be set to any value

Stringoptional
shortshort

use 'yes' with just the num parameter to produce an external link with just the list number shown; suppresses the display of other parameters

Stringoptional

Tracking categories

See also


Retrieved from "https://zoophilia.wiki/index.php?title=Template:National_Heritage_List_for_England/doc&oldid=86481"