Template:National Historic Assets of Wales/doc

This is a documentation subpage for Template:National Historic Assets of Wales.
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.

Shortcuts

{{Cadw}}
{{NHAW}}

This template is used to provide a link to the Cadw — National Historic Assets of Wales (NHAW) database (https://cadw.gov.wales/historicenvironment/recordsv1/cof-cymru/?lang=en) for a designated historic asset or site in Wales.

The database contains the following designated historic assets or sites in Wales:

Listed buildings
Protected wrecks (PW)
Historic Parks and Gardens (HPG)
Registered historic landscapes (RHL)
Scheduled monuments (SM)
World Heritage Sites (WHS)

The database records all those in Wales, and is updated as changes to entries are made, and new listings are added. As of October 2021^[update] the database contains : Listed buildings (around 30,000), Historic Parks and Gardens (around 400), Protected wrecks (6), Registered historic landscapes (58), Scheduled monuments (around 4200) and World Heritage Sites (12).

Usage

Most commonly used parameters in horizontal format
`{{National Historic Assets of Wales\|num= \|desc= \|grade= \|access-date=24 November 2024}}` : for Listed Buildings `{{National Historic Assets of Wales\|num= \|desc= \|class= \|access-date=24 November 2024}}` : for Protected Wrecks `{{National Historic Assets of Wales\|num= \|desc= \|class= \|uid= \|access-date=24 November 2024}}` : for Historic Parks and Gardens, Registered Heritage Landscapes, Scheduled Monuments and World Heritage Sites

Required parameter for all types

num: the 'list entry number' from the database.

Required parameters for historic assets other than listed buildings

class: to adjust the URL based on the type of asset. Do not use for listed buildings. Accepted values are:
- PW = Protected wreck
- HPG = Historic Parks and Gardens
- RHL = Registered historic landscape
- SM = Scheduled monument
- WHS = World Heritage site
uid: The id extracted from the URL, for example: http://cadwpublic-api.azurewebsites.net/reports/historiclandscape/FullReport?lang=en&id=HLW%20(Gw)%205. For historic parks and gardens, registered historic landscapes, scheduled monuments and World Heritage sites this is different from the 'num', which is also a required. Do not use for protected wrecks or listed buildings.

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 online database' will be displayed instead.
grade: to display the Grade of a listed building; enter as II, II* or I. Only appears if |desc= is also used. Only use for listed buildings
author: defaults to Cadw, but can be changed to another name if desired
author-link: defaults to Cadw, but is not set by default if author is set to something other than Cadw
date: the date provided by Cadw; can be a full or partial date
year: the year provided by Cadw; use of |date= is recommended, see Template:Cite web/doc#Date for proper usage
orig-year: the year information was first provided by Cadw; only appears if |date= or |year= is also used
access-date: the date a Wikipedia editor retrieved information from the Cadw 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
ref: defaults to author (Cadw) and the National Historic Assets of Wales 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

{{National Historic Assets of Wales|num=26689}} displays as:

Cadw. "Details from online database (26689)". National Historic Assets of Wales.

{{National Historic Assets of Wales|num=26689|short=yes}} displays as:

26689

{{National Historic Assets of Wales|num=26689|desc=Cardiff Bridge}} displays as:

Cadw. "Cardiff Bridge (26689)". National Historic Assets of Wales.

{{National Historic Assets of Wales|num=26689|desc=Cardiff Bridge|grade=II|access-date=24 November 2024}} displays as:

Cadw. "Cardiff Bridge (Grade II) (26689)". National Historic Assets of Wales. Retrieved 24 November 2024.

{{National Historic Assets of Wales|num=26689|desc=Cardiff Bridge|access-date=24 November 2024|mode=cs2}} displays as:

Cadw, "Cardiff Bridge (26689)", National Historic Assets of Wales, retrieved 24 November 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|CADW|Historic Assets of Wales list entry number}} will link the short reference to the long one. For example, {{harv|Cadw|26689}} produces (Cadw & 26689) that links to the 'Cardiff Bridge' 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:
{{National Historic Assets of Wales|num=13690|desc=Statue of Third Marquess of Bute}}
{{National Historic Assets of Wales|num=13799|desc=Statue of Second Marquess of Bute|fewer-links=yes}} displays as:

Cadw. "Statue of Third Marquess of Bute (13690)". National Historic Assets of Wales.

Cadw. "Statue of Second Marquess of Bute (13799)". National Historic Assets of Wales.

Examples for historic assets other than listed buildings

{{National Historic Assets of Wales|class=PW|desc=Resurgam|num=DW5}} displays as:

Cadw. "Resurgam (DW5)". National Historic Assets of Wales.

{{National Historic Assets of Wales|num=PGW(Gm)17(CAE)|desc=Ruperra Castle|class=HPG|uid=209}} displays as:

Cadw. "Ruperra Castle (PGW(Gm)17(CAE))". National Historic Assets of Wales.

{{National Historic Assets of Wales|num=HLW (Gw) 5|desc=Creuddyn and Conwy|class=RHL|uid=HLW%20(Gw)%205}} displays as:

Cadw. "Creuddyn and Conwy (HLW (Gw) 5)". National Historic Assets of Wales.

{{National Historic Assets of Wales|num=CN079|desc=Caernarfon Castle|class=SM|uid=3417|mode=cs2|fewer-links=yes|access-date=24 November 2024}} displays as:

Cadw, "Caernarfon Castle (CN079)", National Historic Assets of Wales, retrieved 24 November 2024

{{National Historic Assets of Wales|class=WHS|num=347|uid=2|short=yes}} displays as:

347

Template data

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

TemplateData for National Historic Assets of Wales

Provides an external link to an entry on Cadw's National Historic Assets of Wales (NHAW) database of heritage assets

Template parameters
Parameter		Description	Type	Status
num	`num`	the 'list entry number' from the database	Number	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 listed building database' will be displayed instead. Default Details from online database	String	suggested
class	`class`	to change the URL based on type of historic asset if not a listed building: enter as 'PW', 'RHL', 'SM' or 'WHS'	String	optional
uid	`uid`	the id extracted from the URL, required for registered heritage landscapes, scheduled monuments and world heritage sites	String	optional
grade	`grade`	to display the Grade of a listed building: enter as 'II', 'II*' or 'I', only appears if desc is also used	String	optional
author	`author`	defaults to 'Cadw', but can be changed to another name if desired Default Cadw	String	optional
author-link	`author-link`	defaults to 'Cadw', but is not set by default if author is set to something other than Cadw Default Cadw	String	optional
date	`date`	the date provided by Cadw; can be a full or partial date	String	optional
year	`year`	the year provided by Cadw; use of date parameter is recommended	String	optional
orig-year	`orig-year` `origyear`	the year information was first provided by Cadw; only appears if date or year parameter is also used	String	optional
access-date	`access-date` `accessdate`	the date a Wikipedia editor retrieved and/or verified information from the Cadw list 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 'Cadw' and 'National Historic Assets of Wales', where the template is used more than once in an article	String	optional
ref	`ref`	defaults to author and the Cadw list 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

Tracking categories

Category:Cadw citations needing attention (0)
This tracks pages which have an empty |num= field.