Template:Cite certification/doc

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

This template is used on approximately 38,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Check for unknown parameters (sandbox)

Usage

This template creates a {{cite web}} citation for music sales certification data from different regions. The citation created is as accurate as possible using the parameters given. Remember to check the output (e.g., for red error messages, broken links) when using this template; as an editor it is your responsibility to check your additions.

Fields

|region= – region in which the certification was awarded
|title= – title of work
|artist= – performing artist or group
|type= – <syntaxhighlight lang="text" class="" style="" inline="1">album</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">single</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">video</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">jazz</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">compilation</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">videosingle</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">ringtone</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">EP</syntaxhighlight> (see support below)
|award= – <syntaxhighlight lang="text" class="" style="" inline="1">Diamond</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">Platinum</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">Gold</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">Silver</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">Million</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">Billion</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">Diamond+Platinum</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">Diamond+Gold</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">Platinum+Gold</syntaxhighlight>/<syntaxhighlight lang="text" class="" style="" inline="1">Diamond+Platinum+Gold</syntaxhighlight>

|access-date= – date on which the data was accessed for verification
|date= – certification date
|number= – number of awards given
|certyear= – year in which certification was awarded, used for linking in some cases
|certmonth= – month in which certification was awarded, used for linking in some cases
|certweek= – week in which certification was awarded, used for linking in some cases
|id= – documented where relevant
|position= – chart position of work at time of certification, can used in some cases to ease navigation
|source= – determines the source of the certification, documented where relevant
|digital= – set to <syntaxhighlight lang="text" class="" style="" inline="1">true</syntaxhighlight> for digital download certifications, see support below
|streaming= – set to <syntaxhighlight lang="text" class="" style="" inline="1">true</syntaxhighlight> for streaming certifications, see support below
|domestic= – set to <syntaxhighlight lang="text" class="" style="" inline="1">true</syntaxhighlight>, documented where relevant
|Spanish= – set to <syntaxhighlight lang="text" class="" style="" inline="1">true</syntaxhighlight> for Spanish/Latin certifications, see support below
|best= – specific usage, see support below
|archiveurl= – specifies URL of archived info; used for old Portugal certifications only
|archivedate= – specifies date info was archived; used for old Portugal certifications only

Usage examples

To list all Linkin Park titles winning certification in Germany

<syntaxhighlight lang="wikitext"> "Gold-/Platin-Datenbank (Linkin Park)" (in German). Bundesverband Musikindustrie.{{cite web}}: CS1 maint: unrecognized language (link) </syntaxhighlight>

produces

"Gold-/Platin-Datenbank (Linkin Park)" (in German). Bundesverband Musikindustrie.{{cite web}}: CS1 maint: unrecognized language (link)

To list certifications in the United States for Coldplay's A Rush of Blood to the Head (also using access-date)

<syntaxhighlight lang="wikitext"> "American certifications – Coldplay – A Rush of Blood to the Head". Recording Industry Association of America. Retrieved 2010-10-29. </syntaxhighlight>

produces

"American certifications – Coldplay – A Rush of Blood to the Head". Recording Industry Association of America. Retrieved 2010-10-29.

To list Australian certifications for U2's album Achtung Baby, note that although the album was released in 1991 the last certification (to date) was in 1998

<syntaxhighlight lang="wikitext"> "ARIA Charts – Accreditations – 1998 Albums" (PDF). Australian Recording Industry Association. </syntaxhighlight>

produces

"ARIA Charts – Accreditations – 1998 Albums" (PDF). Australian Recording Industry Association.

Supported regions

Regions supported by template, with relevant parameters
Region	Fields	Notes
Argentina	title artist type=album/video	Information for old singles and compilation albums as well as new digital downloads is unavailable
Australia	certyear type=album/single/video source id	Use `\|certyear=` to cite the yearly archives from 1990 to 2022 To cite ARIA Top 50 charts (from July 2019), set `\|id=` to YYYY-MM-DD, e.g. `\|id=2019-07-22`. To cite the Australian artist Top 20, set `\|domestic=true` To cite ARIA Top 50 yearly charts (from 1988) set `\|source=yearchart` Can also set `\|source=book` to use Ryan, Gavin (2011). Australia's Music Charts 1988–2010 (PDF ed.). Mt Martha, Victoria, Australia: Moonlight Publishing. and `\|id=` is the page number.
Austria	title artist type
Belgium	certyear type
Brazil	artist type
Canada	title artist type certmonth certyear digital	`certmonth` and `certyear` are only used as backward compatibility if both `title` and `artist` are not supplied, in which case the old database is used (only valid from 2001) Set `\|digital=true` for digital downloads or `\|type=ringtone` for ringtones
Central America
Denmark	certyear source id type	Use `\|source=chart` to use weekly charts, which is required before 2004. `\|certyear=` is the chart year and `\|id=` is the chart week. Otherwise, if <syntaxhighlight lang="text" class="" style="" inline="1">id</syntaxhighlight> is specified, will use the node number (accessible from the URL after search). Otherwise will use the default location http://www.ifpi.dk/certificeringer-0
Europe	certyear	Albums only. Only up to 2014.
Finland	artist domestic	Will use domestic certifications if `\|domestic=true`
France	artist title type=album/single/video/compilation source certyear award number	Use `\|source=archive` to use SNEP archives as source, requires `\|certyear=`, `\|award=` and `\|number=` for multiple awards. Use `\|source=infodisc` for unofficial www.infodisc.fr tables (Manual search required)
GCC	certyear	From 2009 to 2011 only.
Germany	title artist type=album/single/video best=yes*/no	In cases where the best certification does not show up (known bug), set `\|best=no` to show the entire certification history
Greece	id type certyear certweek domestic	Referenced from wayback machine archive, e.g. here. `id` is the full 14 digit timestamp, e.g. 20070114174502. Use `\|certyear=` and `\|certweek=` for correct titles. Supports `\|domestic=true` where relevant (albums before 2011 and singles from 2021)
Hong Kong	certyear	Albums only. Only up to 2008.
Hungary	certyear
Ireland	award number certyear	From 2005 to 2013 only.
Italy	id	From 2009 only. Use `\|id=` for referencing the individual page (found at the end of the URL after clicking "Richiedi Targhetta"). Otherwise, manual search required.
Japan	certmonth certyear digital streaming type	Set `\|digital=true` or `\|type=ringtone` for digital download certifications Set `\|streaming=true` uses the streaming certifications
Mexico	artist title type	Manual search required
Netherlands	artist type	Manual search required
New Zealand	type=album/single/compilation id source domestic	Supports three sources: If `\|source=archive`, uses Radioscope certifications archive which only go April 2007 to July 2011. If `\|source=book`, uses Scapolo, Dean (2007). The Complete New Zealand Music Charts: 1966 – 2006. Wellington: Maurienne House. ISBN 978-1877443-00-8. and `\|id=` is the page number. Otherwise uses the new website at nztop40.co.nz which has charts from 1975. In this case `\|id=` is the number of the chart and setting `\|domestic=true` will use the domestic charts.
Norway	artist certyear
Philippines
Poland	type=album/single/video/jazz award certyear	Uses ZPAV source with annual certlists if <syntaxhighlight lang="text" class="" style="" inline="1">1995<=certyear<=2023</syntaxhighlight>, where <syntaxhighlight lang="text" class="" style="" inline="1">award</syntaxhighlight> is mandatory to identify the section (Gold, Platinum and Diamond). Otherwise, can be used OLiS source, with manual search required.
Portugal	certyear id source archiveurl archivedate	Supports three sources. The first is working and the latter two are obsolete and used only for backward compatibility: audiogest: Used if <syntaxhighlight lang="text" class="" style="" inline="1">certyear>=2018</syntaxhighlight>. Requires `\|id=FILENAME`, where filename is according to the stored URL <syntaxhighlight lang="text" class="" style="" inline="1">http://www.audiogest.pt/uploads/files/FILENAME</syntaxhighlight>. Obsolete 1 afp: Used if `\|source=archive`. Works correctly only for <syntaxhighlight lang="text" class="" style="" inline="1">2007<=certyear<=2010</syntaxhighlight>. Uses an archived version. Obsolete 2 artistas-espectaculos: Used in all other cases. Requires `\|id=XXXXYY` where XXXX is the year and YY is the week in which the title charted. Requires `\|archiveurl=` and `\|archivedate=`, but will provide a helper link if they are not supplied. Works correctly only for <syntaxhighlight lang="text" class="" style="" inline="1">2004<=certyear<=2010</syntaxhighlight>.
Russia	certyear	Albums only
Singapore		Albums only. From 2019 only
South Africa	artist title
South Korea	type streaming	From April 2018 only
Spain	certyear certweek id type streaming digital artist title	If `\|id=` is set, will use the El portal de Música entry to reach the specific title. In this case, <syntaxhighlight lang="text" class="" style="" inline="1">id</syntaxhighlight> should be set to the end of the url for that title, e.g. for citing "Viva La Vida", the url is https://www.elportaldemusica.es/single/coldplay-viva-la-vida-2 and one needs to set `\|id=coldplay-viva-la-vida-2`. Also `\|type=` is mandatory in this case. Otherwise, if `\|certweek=` is used, `\|certyear=` is the year for the certification and `\|certweek=` is the week number on which the PDF is available from the dropdown available under the week tab. This option supports `\|streaming=true`, `\|digital=true` and `\|type=ringtone`, relevant only for 2008 certifications. Otherwise, `\|artist=` and/or `\|title=` are used to search the El portal de Música certification database.
Sweden	certyear certweek position type=single/album artist source	Use `\|source=artist` to cite by `\|artist=`. Use `\|source=chart` to cite by `\|certyear=` and `\|certweek=` from a chart, where `\|position=` can be used to ease navigation. Otherwise, can use `\|certyear=` for an archived citation but only until 2011.
Switzerland	artist title certyear	Will use `title` if available, `artist` as a second option, and `certyear` as last option.
Taiwan
Turkey	certyear	From 2004 to 2009 only
United Kingdom	id	Manual search required if <syntaxhighlight lang="text" class="" style="" inline="1">id</syntaxhighlight> not specified
United States	title artist type=album/single/video/videosingle/ringtone/EP Spanish	Set `\|Spanish=true` for Latin certifications
Uruguay	certyear

TemplateData

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

TemplateData for Cite certification

No description.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
region	`region`	no description	Unknown	required
title	`title`	no description	Unknown	required
artist	`artist`	no description	Unknown	required
type	`type`	no description Suggested values `album` `single` `video` `jazz` `compilation` `videosingle` `ringtone` `EP`	Unknown	required
award	`award`	no description Suggested values `Diamond` `Platinum` `Gold` `Silver` `Million` `Billion` `Diamond+Platinum` `Diamond+Gold` `Platinum+Gold` `Diamond+Platinum+Gold`	Unknown	optional
access-date	`access-date` `accessdate`	no description	Unknown	optional
date	`date`	no description	Unknown	optional
number	`number`	no description	Unknown	optional
certyear	`certyear`	no description	Unknown	optional
certmonth	`certmonth`	no description	Unknown	optional
certweek	`certweek`	no description	Unknown	optional
id	`id`	no description	Unknown	optional
position	`position`	no description	Unknown	optional
source	`source`	no description	Unknown	optional
digital	`digital`	no description Auto value `true`	Boolean	optional
streaming	`streaming`	no description Auto value `true`	Boolean	optional
Spanish	`Spanish`	no description Auto value `true`	Boolean	optional
domestic	`domestic`	no description	Unknown	optional
best	`best`	no description	Unknown	optional
archive-url	`archive-url` `archiveurl`	no description	Unknown	optional
archive-date	`archive-date` `archivedate`	no description	Unknown	optional

Tracking categories