Template:Coflein/doc
This is a documentation subpage for Template:Coflein. It contains 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 Royal Commission on the Ancient and Historical Monuments of Wales (RCAHMW) — Coflein database (https://coflein.gov.uk/en/)
containing details of over 110,000 buildings, archaeological, industrial and maritime sites throughout Wales.
Usage
|
Required parameter
- num: the NPRN (National Primary Record Number) from the database.
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 Coflein database' will be displayed instead.
- access-date: the date a Wikipedia editor retrieved information from the Coflein 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 (RCAHMW) and the NPRN, 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
{{Coflein|num=24145}}
displays as:
- "Details from Coflein database (24145)". Coflein. RCAHMW.
{{Coflein|num=24145|short=yes}}
displays as:
{{Coflein|num=24145|desc=Pontypridd Old Bridge, Pontypridd}}
displays as:
{{Coflein|num=24145|desc=Pontypridd Old Bridge, Pontypridd|access-date=3 October 2024}}
displays as:
- "Pontypridd Old Bridge, Pontypridd (24145)". Coflein. RCAHMW. Retrieved 3 October 2024.
{{Coflein|num=24145|desc=Pontypridd Old Bridge, Pontypridd|access-date=3 October 2024|mode=cs2}}
displays as:
- "Pontypridd Old Bridge, Pontypridd (24145)", Coflein, RCAHMW, retrieved 3 October 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|RCAHMW|NPRN}}
will link the short reference to the long one. For example, {{harv|RCAHMW|24145}}
produces (RCAHMW & 24145) that links to the 'Pontypridd Old Bridge, Pontypridd' 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:
{{Coflein|num=24145|desc=Pontypridd Old Bridge, Pontypridd}}
{{Coflein|num=275874|desc=Great Western Colliery: Hetty Pit, Pontypridd|fewer-links=yes}}
displays as:
- "Pontypridd Old Bridge, Pontypridd (24145)". Coflein. RCAHMW.
- "Great Western Colliery: Hetty Pit, Pontypridd (275874)". Coflein. RCAHMW.
Template data
TemplateData for Coflein
Provides an external link to an entry on Coflein, the Royal Commission on the Ancient and Historical Monuments of Wales (RCAHMW) database for the National Monuments Record of Wales (NMRW)
Parameter | Description | Type | Status | |
---|---|---|---|---|
num | num | the NPRN (National Primary Record 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 Coflein database' will be displayed instead.
| String | suggested |
access-date | access-date accessdate | the date a Wikipedia editor retrieved and/or verified information from the Coflein database
| 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 'RCAHMW', where the template is used more than once in an article | String | optional |
ref | ref | defaults to author and the NPRN, 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:Coflein citations needing attention (0)
- This tracks pages which have an empty
|num=
field.
- This tracks pages which have an empty
See also
- {{National Historic Assets of Wales}} – provides a link to items on the Cadw database.
- {{National Heritage List for England}} — provides a link to items on Historic England's National Heritage List for England
- {{Historic Environment Scotland}} – provides a link to items on the Historic Environment Scotland database.