Template:Historic England research records/doc

This template is used to provide a link to Historic England research records available on the Heritage Gateway website (https://www.heritagegateway.org.uk/). This replaced the PastScape website at the end of 2020.

The information, historically known as the National Monument Record (NMR), contains approximately 400,000 records on the natural historic environment database, including archaeological, architectural and maritime sites.

Required parameter

 * num: The monument number from the database. Alias: mnumber

To obtain the value for this parameter:
 * 1) Search for and open the required record on the Heritage Gateway site, for example "East Farleigh Bridge", at the Heritage Gateway search page (Note:A filter is available to only display research records in the Resources tab of the More Detailed Search)
 * 2) The monument number is located in the "Hob Uid:" field which in this example is 415833. Should this value be unavailable the "uid=" part of the URL can also be used. The URL for East Farleigh Bridge is:

Optional parameters

 * desc: The name of the database entry. If this parameter is not used default text "Monument No." will be displayed instead. Alias: mname
 * 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 for proper usage.
 * orig-year: The date information was first provided by Historic England. Only appears if date or year is also used.
 * access-date: The date information was retrieved from the database. Alias: accessdate
 * separator: (deprecated) Defaults to a period ; if the parameter is present, but blank, no separator punctuation will be used; do not use an asterisk, colon or hash  as they will be interpreted as wikimarkup. Used in conjunction with the postscript parameter it can provide consistency with Citation style 2, as produced by . Use mode
 * 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 links where the template is used more than once in an article.
 * ref: Defaults to author (Historic England) and the National Monument Record Number, but can be reset to any value.

Examples
gives:

gives:

gives:

gives:

gives:

If a short citation is required 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 "Wades Causway" example above. This is different from the standard use of the that links using the parameters "author" and "date" or "year".

Template data
{	"description": "Provides an external link to an entry on Historic England's National Monument Record PastScape database", "params": { "num": { "label": "num", "description": "the National Monument Record number from the database", "required": true, "aliases": ["mnumber"], "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, "aliases": ["mname"], "suggested": true, "default": "Monument No.", "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 date information was first provided by Historic England. Only appears if date or year parameter is also used.", "required": false, "type": "string" },		"access-date": { "label": "access-date", "description": "The date a Wikipedia editor retrieved information from the Historic England PastScape 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, "default": "cs1", "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" },		"ref": { "label": "ref", "description": "Defaults to author and the Historic England List Number, but can be set to any value.", "required": false, "type": "string" },		"separator": { "label": "separator", "description": "Separator in reference. Deprecated use 'mode'.", "required": false, "deprecated": true, "type": "string" }	} }

Tracking categories

 * This tracks pages which have an empty num or mnumber field.
 * This tracks pages which have an empty num or mnumber field.