Template:Coflein/doc

From Wikipedia, the free encyclopedia


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[edit]

Most commonly used parameters in horizontal format

{{Coflein|num= |desc= |access-date= }}

Required parameter[edit]

  • num: the NPRN (National Primary Record Number) from the database.

Optional parameters[edit]

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[edit]

{{Coflein|num=24145}} displays as:

"Details from Coflein database (24145)". Coflein. RCAHMW.

{{Coflein|num=24145|short=yes}} displays as:

24145

{{Coflein|num=24145|desc=Pontypridd Old Bridge, Pontypridd}} displays as:

"Pontypridd Old Bridge, Pontypridd (24145)". Coflein. RCAHMW.

{{Coflein|num=24145|desc=Pontypridd Old Bridge, Pontypridd|access-date=9 May 2024}} displays as:

"Pontypridd Old Bridge, Pontypridd (24145)". Coflein. RCAHMW. Retrieved 9 May 2024.

{{Coflein|num=24145|desc=Pontypridd Old Bridge, Pontypridd|access-date=9 May 2024|mode=cs2}} displays as:

"Pontypridd Old Bridge, Pontypridd (24145)", Coflein, RCAHMW, retrieved 9 May 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[edit]

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

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)

Template parameters

ParameterDescriptionTypeStatus
numnum

the NPRN (National Primary Record Number) from the database

Numberrequired
descdesc

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.

Default
Details from Coflein database
Stringsuggested
access-dateaccess-date accessdate

the date a Wikipedia editor retrieved and/or verified information from the Coflein database

Auto value
{{subst:CURRENTDAY}} {{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}
Stringsuggested
modemode

defaults to 'cs1'; set to 'cs2' to provide consistency with Citation style 2, as produced by {{citation}}

Stringoptional
postscriptpostscript

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

Stringoptional
fewer-linksfewer-links

set to 'yes' to remove repeated wikilinks to 'RCAHMW', where the template is used more than once in an article

Stringoptional
refref

defaults to author and the NPRN, but can be set to any value

Stringoptional
shortshort

use 'yes' with just the num parameter to produce an external link with just the list number shown; suppresses the display of other parameters

Stringoptional

Tracking categories[edit]

See also[edit]