View source for Template:Canmore/doc

{{Documentation subpage}}
{{cs1 wrapper|base=cite web}}
__NOTOC__

<!-- Categories and interwikis go at the bottom of this page. -->
This template is used to provide a link to the [[Canmore (database)|Canmore]] online database of Scotland's National Record of the Historic Environment (http://canmore.org.uk/) for a specified monument record in Scotland. Formerly maintained by [[RCAHMS]], since 2015 it is maintained by [[Historic Environment Scotland]].

The database record contains nearly 320,000 records on buildings, archaeological, industrial and maritime sites across Scotland.

==Usage==
===Required parameter===
*'''num''': The monument, collection or event number from the database.

===Optional parameters===
*'''class''': to link to the 'collection', 'event' and 'gallery' pages of the website, for example: <code><nowiki>https://canmore.org.uk/</nowiki>{{highlight|collection}}/######</code>. '''Do not use''' for 'site' which is the default url. Accepted values are:
**C = collection
**E = event
**G = gallery
*'''desc''': The name of the database entry. If this parameter is not used default text "Monument No." will be displayed instead. (or if using 'class' the default text will be "Collection No.", "Event ID." or "Gallery")
*'''access-date''': The date information was retrieved from the database. Alias: '''accessdate'''
*'''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 to 'Historic Environment Scotland' where the template is used more than once in an article, or if similar templates with the same links are used (e.g. {{tl|Historic Environment Scotland}})
 

==Examples==
<code><nowiki>{{Canmore |num=4121}}</nowiki></code> gives:
:{{Canmore |num=4121}}

<code><nowiki>{{Canmore |num=383697 |class=C}}</nowiki></code> gives:
:{{Canmore |num=383697 |class=C}}

<code><nowiki>{{Canmore |num=4121 |desc=Lewis, Dun Carloway}}</nowiki></code> gives:
:{{Canmore |num=4121 |desc=Lewis, Dun Carloway}}

<code><nowiki>{{Canmore |num=4121 |desc=Lewis, Dun Carloway |access-date=</nowiki>{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}</code> gives:
:{{Canmore |num=4121 |desc=Lewis, Dun Carloway |access-date={{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}

<code><nowiki>{{Canmore |num=4121 |desc=Lewis, Dun Carloway |access-date=</nowiki>{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}} |fewer-links=yes}}</code> gives:
:{{Canmore |num=4121 |desc=Lewis, Dun Carloway |access-date={{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}} |fewer-links=yes}}

<code><nowiki>{{Canmore |num=904119 |class=E |desc=J. S. Lees Grocers (Former) |mode=cs2 |access-date=</nowiki>{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}</code> gives:
:{{Canmore |num=904119 |class=E |desc=J. S. Lees Grocers (Former) |mode=cs2 |access-date={{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}


==Template data==
{{TemplateDataHeader}}
<templatedata>
{
	"description": "Provides an external link to an entry on the Canmore database",
	"params": {
		"num": {
			"label": "num",
			"description": "the Canmore ID number from the database",
			"required": true,
			"type": "string"
		},
		"class": {
			"label": "class",
			"description": "to change the URL for sections of the database other than 'site': enter as 'C', 'E' or 'G'.",
			"required": false,
			"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 'Monument No.' will be displayed instead.",
			"required": false,
			"suggested": true,
                        "default": "Monument No.",
			"type": "string"
		},
		"access-date": {
			"label": "access-date",
			"description": "The date a Wikipedia editor retrieved information from the Canmore 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,
			"default": ".",
			"type": "string"
		},
		"fewer-links": {
			"label": "fewer-links",
			"description": "Set to 'yes' to remove repeated links where the template is used more than once in an article.",
			"required": false,
			"default": "yes",
			"type": "string"
		}
	}
}
</templatedata>

== See also ==
*{{tl|Historic England research records}} — provides a link to the Historic England research records available through the Heritage Gateway (which replaced PastScape), formerly known as the ''[[National Monuments Record]]'' (NMR)
*{{tl|Historic Environment Scotland}}  — provides a link to the [[Historic Environment Scotland]] database (formerly maintained by Historic Scotland)

<includeonly>{{Sandbox other||
<!-- Categories and interwikis go here: -->
[[Category:Heritage citation templates|{{PAGENAME}}]]
[[Category:Specific-source templates]]
}}</includeonly>