Template:Canmore/doc

This is a documentation subpage for Template:Canmore.
It may contain usage information, categories and other content that is not part of the original template page.

This template is a Citation Style 1 wrapper template based on {{Cite web}}. For centralised Citation Style 1 discussions, see Help talk:Citation Style 1.

This template is used to provide a link to the 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: https://canmore.org.uk/collection/######. 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 |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 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. {{Historic Environment Scotland}})

Examples

{{Canmore |num=4121}} gives:

Historic Environment Scotland. "Monument No. 4121". Canmore.

{{Canmore |num=383697 |class=C}} gives:

Historic Environment Scotland. "Collection No. 383697". Canmore.

{{Canmore |num=4121 |desc=Lewis, Dun Carloway}} gives:

Historic Environment Scotland. "Lewis, Dun Carloway (4121)". Canmore.

{{Canmore |num=4121 |desc=Lewis, Dun Carloway |access-date=3 November 2024}} gives:

Historic Environment Scotland. "Lewis, Dun Carloway (4121)". Canmore. Retrieved 3 November 2024.

{{Canmore |num=4121 |desc=Lewis, Dun Carloway |access-date=3 November 2024 |fewer-links=yes}} gives:

Historic Environment Scotland. "Lewis, Dun Carloway (4121)". Canmore. Retrieved 3 November 2024.

{{Canmore |num=904119 |class=E |desc=J. S. Lees Grocers (Former) |mode=cs2 |access-date=3 November 2024}} gives:

Historic Environment Scotland, "J. S. Lees Grocers (Former) (904119)", Canmore, retrieved 3 November 2024

Template data

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

TemplateData for Canmore

Provides an external link to an entry on the Canmore database

Template parameters
Parameter		Description	Type	Status
num	`num`	the Canmore ID number from the database	String	required
class	`class`	to change the URL for sections of the database other than 'site': enter as 'C', 'E' or 'G'.	String	optional
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 'Monument No.' will be displayed instead. Default Monument No.	String	suggested
access-date	`access-date` `accessdate`	The date a Wikipedia editor retrieved information from the Canmore 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 Default .	String	optional
fewer-links	`fewer-links`	Set to 'yes' to remove repeated links where the template is used more than once in an article. Default yes	String	optional