Template:Historic Environment Scotland/doc

This template is used to provide a link to the Historic Environment Scotland — database (http://portal.historicenvironment.scot/) for a specified listed building or object in Scotland.

The database contains around 56,000 records for the following types of registered historic locations or sites in Scotland:

• Battlefield (BTL)
• Garden and Designated Landscape (GDL)
• Historic Marine Protected Area (HMPA)
• Listed building (LB)
• Scheduled monument (SM)

Usage

Most commonly used parameters in horizontal format

{{Historic Environment Scotland|num= |desc= |cat= |access-date= }}

Required parameter

• num: the 'reference number' from the database in full. (including letters denoting type: BTL, GDL, HMPA, LB or SM)

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 database' will be displayed instead.
• cat: to display the Category of a listed building. Only appears if |desc= is also used. Accepted values are:
  • A = Category A Listed Building
  • B = Category B Listed Building
  • C = Category C Listed Building
  • BTL = Battlefield
  • GDL = Garden and Designated Landscape
  • HMPA = Historic Marine Protected Area
  • LB = Listed building
  • SM = Scheduled Monument
• author: defaults to Historic Environment Scotland, but can be changed to another name if desired
• author-link: defaults to Historic Environment Scotland, but is not set by default if author is set to something other than Historic Environment Scotland
• date: the date provided by Historic Environment Scotland; can be a full or partial date
• year: the year provided by Historic Environment Scotland; use of |date= is recommended, see Template:Cite web/doc#Date for proper usage
• access-date: the date a Wikipedia editor retrieved information from the Historic Environment Scotland 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, or if similar templates with the same links are used (e.g. {{Canmore}})
• ref: defaults to author (Historic Environment Scotland) and the Historic Environment Scotland reference 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

Note that these examples may not display here properly as "Historic Environment Scotland" should be a wikilink in all except the final example (which uses fewer-links).

{{Historic Environment Scotland|num=LB12310}} displays as:

Historic Environment Scotland. "Details from database (LB12310)".

{{Historic Environment Scotland|num=LB12310|short=yes}} displays as:

LB12310

{{Historic Environment Scotland|num=LB12310|desc=IONA ABBEY}} displays as:

Historic Environment Scotland. "IONA ABBEY (LB12310)".

{{Historic Environment Scotland|num=LB12310|desc=IONA ABBEY|cat=A|access-date=3 December 2024}} displays as:

Historic Environment Scotland. "IONA ABBEY (Category A Listed Building) (LB12310)". Retrieved 3 December 2024.

{{Historic Environment Scotland|num=LB12310|desc=IONA ABBEY|access-date=3 December 2024|mode=cs2}} displays as:

Historic Environment Scotland, "IONA ABBEY (LB12310)", retrieved 3 December 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 Environment Scotland|designation list reference number}} will link the short reference to the long one. For example, {{harv|Historic Environment Scotland|LB12310}} produces (Historic Environment Scotland & LB12310) that links to the 'IONA ABBEY' example above. This is different from the standard use of the {{harv}} that links using the parameters 'author' and 'date' or 'year'.

Some articles may have multiple entries. |fewer-links=yes can be used to remove the repeated internal wikilinks from any additional and subsequent instances of the template:
{{Historic Environment Scotland|num=LB12310|desc=IONA ABBEY}}
{{Historic Environment Scotland|num=LB14873|desc=SPEYMOUTH RAILWAY VIADUCT|fewer-links=yes}} displays as:

Historic Environment Scotland. "IONA ABBEY (LB12310)".

Historic Environment Scotland. "SPEYMOUTH RAILWAY VIADUCT (LB14873)".

Template data

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

TemplateData for Historic Environment Scotland

Provides an external link to an entry on Historic Environment Scotland's database of heritage assets

Template parameters

Parameter		Description	Type	Status
num	num	the reference number from the database in full, including letters	String	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 database' will be displayed instead. Default Details from database	String	suggested
cat	cat	to display the Category of a listed building: enter as 'A', 'B' or 'C', only appears if desc is also used	String	optional
author	author	defaults to 'Historic Environment Scotland', but can be changed to another name if desired Default Historic Environment Scotland	String	optional
author-link	author-link	defaults to 'Historic Environment Scotland', but is not set by default if author is set to something other than Historic Environment Scotland Default Historic Environment Scotland	String	optional
date	date	the date provided by Historic Environment Scotland; can be a full or partial date	String	optional
year	year	the year provided by Historic Environment Scotland; use of date parameter is recommended	String	optional
access-date	access-date accessdate	the date a Wikipedia editor retrieved and/or verified information from the Historic Environment Scotland database Auto value {{subst:CURRENTDAY}} {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}	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 Environment Scotland', where the template is used more than once in an article	String	optional
ref	ref	defaults to author and the Historic Environment Scotland designation 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

See also

• {{Canmore}} — provides a link to the Canmore database, also maintained by Historic Environment Scotland

For equivalent organisations in other parts of the UK:

• {{National Heritage List for England}} — provides a link to items on Historic England's National Heritage List for England
• {{National Historic Assets of Wales}} — provides a link to a Cadw National Historic Assets of Wales list entry.