Template:Historic Environment Scotland/doc

This template is used to provide a link to the Historic Environment Scotland — database   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)

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 for proper usage
 * access-date: the date a Wikipedia editor retrieved information from the Historic Environment Scotland list database.
 * mode: defaults to cs1; set to cs2 to provide consistency with citation style 2, as produced by
 * postscript: controls the closing punctuation for the citation; defaults to a period ; for no terminating punctuation, set to none, however using cs2 does this automatically
 * fewer-links: use 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 yes with num to produce an external link with just the list number shown; 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).

displays as:

displays as:

displays as:

displays as:

displays as:

If a short citation is required (not to be confused with short) and one of the harv templates or sfn is used then  will link the short reference to the long one. For example,  produces  that links to the 'IONA ABBEY' example above. This is different from the standard use of the that links using the parameters 'author' and 'date' or 'year'.

Some articles may have multiple entries. yes can be used to remove the repeated internal wikilinks from any additional and subsequent instances of the template:

displays as:

Template data
{	"description": "Provides an external link to an entry on Historic Environment Scotland's database of heritage assets", "params": { "num": { "label": "num", "description": "the reference number from the database in full, including letters", "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 database' will be displayed instead.", "required": false, "suggested": true, "default": "Details from database", "type": "string" },		"cat": { "label": "cat", "description": "to display the Category of a listed building: enter as 'A', 'B' or 'C', only appears if desc is also used", "required": false, "type": "string" },		"author": { "label": "author", "description": "defaults to 'Historic Environment Scotland', but can be changed to another name if desired", "required": false, "default": "Historic Environment Scotland", "type": "string" },		"author-link": { "label": "author-link", "description": "defaults to 'Historic Environment Scotland', but is not set by default if author is set to something other than Historic Environment Scotland", "required": false, "default": "Historic Environment Scotland", "type": "string" },		"date": { "label": "date", "description": "the date provided by Historic Environment Scotland; can be a full or partial date", "required": false, "type": "string" },		"year": { "label": "year", "description": "the year provided by Historic Environment Scotland; use of date parameter is recommended", "required": false, "type": "string" },				"access-date": { "label": "access-date", "description": "the date a Wikipedia editor retrieved and/or verified information from the Historic Environment Scotland database", "required": false, "suggested": true, "aliases": ["accessdate"], "autovalue": " ", "type": "string" },		"mode": { "label": "mode", "description": "defaults to 'cs1'; set to 'cs2' to provide consistency with Citation style 2, as produced by ", "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 Environment Scotland', 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 Environment Scotland designation 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" }	} }