Template:Singlechart/doc

This template is used to cite sources in Wikipedia. It is specifically for recorded musical single releases: singles. A similar template for use when citing sources for musical albums, EPs, or other releases has not yet been developed.

In general, the template expands to produce a table row with the information country, record chart, reference, and peak position for the given single on the particular chart. Tables of such information are commonly used in Wikipedia articles on singles, albums, discographies and artists.

This template does not verify any positions or chart appearances. It primarily provides a reference URL believed to be associated with a reliable source for a recognised chart. The reference URL itself is also not checked. Entering an incorrect or alternative spelling of a song title can produce a bad link, for example. Individual editors will need to follow the URLs generated by the template to verify their usefulness before walking away from an edited article.

Usage

This template outputs data suitable for inclusion within a record chart table. It will produce a referenced chart name and a position. It can be used as a part of a larger table, or a series of calls can be used to create a chart. This template does not create the surrounding table markup.

All field names used must be in lowercase.

You can copy a blank version to use. Remember to use the "|" (pipe) character between each field. Please delete any unused fields to avoid clutter in the edit window.

The template has the following syntax:

Full version (copy and paste text below and delete parameters you don't need)

{{singlechart |Chart identifier|peak|song= |songid= |artist= |artistid= |url= |urltitle= |date= |year= |week= |note= |publishdate= |accessdate= |refname= |rowheader=}} It is a good practice to always include "song=" and "artist=", even though some uses of the template do not require them. This makes it easier to modify the template in the future if there is a change in the archives referenced by the template. In addition, the artist parameter is used by default to name references for reuse elsewhere in the article. rowheader defaults to false. If set to true, the chart name will be output as a header, as indicated by WP:ACCESS#Data tables.

Fields

The parameters publishdate, accessdate, and refname are optional. Whether the other parameters are required or not depend on the chart being referenced. See the tables in the Support section below.

• chart (or first parameter, without name): Chart identifier. Must be one of the options listed under Chart ID in the tables of the Support section below. Often named as a country or nationality (e.g., Spain or Spanish), but sometimes named for a specific chart (e.g., Billboardjapanhot100). Some charts allow more than one identifier; the results produced are identical.

• peak (or second parameter, without name): The number you found to be the peak position achieved by the single on the specific chart to date. If the song has not appeared on the chart (due to low popularity or lack of release in a country), you can enter a dash (–, not a hyphen -). Usually, it's better to omit the template completely.

• song: Title of the single. Made-up words, slang, "hip" spellings, tricky punctuation, etc., can make this parameter difficult to correctly determine. Make sure to check the resulting reference URL (Preview) before saving the definitive version of the article.
• songid: Numeric identifier used by some chart listings (see UKchartstats below). Determined by performing a search at the chart listings' website for the single (or performer or album, then following a link through to the single's page). The songid can be found in the Web address (URL) by inspection. For example, the page for "Genie In A Bottle" at www.chartstats.com has the URL http://www.chartstats.com/songinfo.php?id=27705, so the songid to use is 27705.
• artist: Name of the single's performer. As for the song parameter, odd spellings and clever stylings (e.g., Ke$ha) can make this parameter difficult to correctly determine. The German chart, for example, typically requires names in lastname,firstname format. Make sure to check the resulting reference URL (Preview) before saving the definitive version of the article. Also note that this parameter is required for all charts where you are reusing the references using the default naming (see Output section below). If you use the refname parameter, however, artist may not be absolutely necessary.
• artistid: Numeric identifier used by some chart listings (see Billboard charts). Determined by performing a search at the chart listings' website for the artist (or single or album, then following a link through to the performer's page). The artistid can be found in the Web address (URL) by inspection. For example, the page for Eric Clapton at www.billboard.com has the URL http://www.billboard.com/#/artist/eric-clapton/50403, so the artistid to use is 50403.
• url: The URL of the reference where you found the song's peak position for the chart. Used only for particular charts (see Support tables) where there is no indexing system, not necessary (or even used) for others.
• urltitle: The title of the page for the reference where you found the song's peak position for the chart. Used in combination with the url parameter, and only for particular charts (see Support tables) where there is no indexing system, not necessary (or even used) for others.
• date: Date of the chart in the format YYYYMMDD, an 8-digit number indicating year (Y), month (M) and day (D). Used only for certain charts (see Frenchdigital below); not necessary (or even used) for others. This date is used solely to create the reference URL to the download chart, and is not displayed textually in the references list. For general citation of any chart's publication date, use the optional publishdate parameter.
• year: Four-digit year indicating the year being reported by the chart. Used in combination with the week parameter and only for certain charts; not necessary (or even used) for others. Not necessarily the same as the publication date referred to by publishdate.
• week: Two-digit week indicating the week being reported by the chart. Week is a number from 01 to 53, with a leading 0 for weeks 01-09 (some charts do not require the leading zero; consult Support tables below). Used in combination with the year parameter and only for certain charts; not necessary (or even used) for others. Not necessarily related to the publication date referred to by publishdate.
• note: For adding a note about a particular version of a song, e.g., note=extended dance mix, or {{singlechart|Australia|1|song=I'm the Urban Spaceman|artist=The Bonzo Dog Doo Dah Band|note=uncensored version}}.
• publishdate: Date of publication of the reference generated by the template, in the same format as other dates in citations in the same article. Optional parameter.
• accessdate: Date that the reference generated by the template was retrieved to determine peak position. Should be in the same format as other dates in citations in the same article. Optional parameter.
• refname: Enables you to specify a name for the reference generated by the template. If no value is provided for refname the default reference name (in the form sc_Chartid_artist, see Output below) will be used. A reference with a name can be reused for claims elsewhere in the article. Optional parameter.

Output

The template's expansion results in two output items:

• a row of output for a two-cell table row, and
• a reference

The output row includes the piping character to divide the left cell from the right cell. The left cell includes the country and/or chart name, with wikilinks to the chart article(s), as well as the reference note^[n] as if it were enclosed in <ref></ref> tags. Any note included with the note parameter is shown in the left cell as well. The right cell contains the peak position number, including the code to horizontally center the number in the table cell.

The citation generated by this template will appear in the list in place of <References/> or the {{reflist}} template, like any other references. The reference produced will be given a name in the form "sc_Chartid_artist" by default, i.e., if the article uses

{{singlechart|Australia|1|song=I'm the Urban Spaceman|artist=Bonzo Dog Doo Dah Band|note=album version}}

then the citation could be used to support other statements on the page using a reference as in

...some fact supported by the same source.<ref name="sc_Australia_Bonzo Dog Doo Dah Band"/>

Alternatively, the name can be overridden using the refname parameter, i.e.,

{{singlechart|Australia|1|song=I'm the Urban Spaceman|artist=Bonzo Dog Doo Dah Band|refname=bonzosinoz}}

which could then be used as a citation to support other statements on the page using a reference as in

...some fact supported by the same source.<ref name=bonzosinoz/>

Note that the refname parameter does not require the use of quotation marks, but names with spaces in them will necessitate quotation marks in the name parameter of <ref> (for example, you would need to use <ref name="bonzos in oz"/> if you used spaces in the name).

Brief examples of output with different parameters

A few quick examples of template usage and the corresponding output are shown here. More detailed examples with surrounding table code are in the Examples with table layout section below.

Example no.	Coding (assumed inside a table row)	Output (assumed with <references/> added)
Example 1	{{singlechart |Australia |18 |artist=Shakira |song=She Wolf}}	Australia (ARIA) 18
Example 2	{{singlechart |Billboardcanadianhot100 |5 |artist=Shakira |artistid=147604}}	Canada (Canadian Hot 100) 5
Example 3	{{singlechart |Frenchdigital |4 |artist=Shakira |song=She Wolf |date=20091017}}	France (SNEP) Download Chart 4
Example 4	{{singlechart |Italy |3 |artist=Shakira |song=Loba |note="Loba" (Spanish version)}} |- {{singlechart |Italy |11 |artist=Shakira |song=She Wolf |note="She Wolf" (English version)}}	Italy (FIMI) "Loba" (Spanish version) 3 Italy (FIMI) "She Wolf" (English version) 11
Example 5	{| class="wikitable sortable" border="1" |- ! Chart (2009) ! Peak<br />position |- {{singlechart |Flanders|16 |artist=Shakira |song=She Wolf}} |- {{singlechart |Wallonia|5 |artist=Shakira |song=She Wolf}} |- |[[Billboard Brazil| Brazil ''Billboard'' Hot 100 Airplay]]<ref> "Brazil Hot 100 Airplay" (in Portuguese). Billboard Brasil (Brazil: bpp) (2): 79. November 2009. ISSN 977-217605400-2</ref> | style="text-align:center;"|1 |- {{singlechart |Hungary|5|year=2009|week=14}} |- {{singlechart |Ireland|2 |year=2009 |week=40}} |- {{singlechart |Billboardjapanhot100|9 |artist=Shakira |artistid=147604}} |- {{singlechart |UKchartstats|4 |artist=Shakira|song=She Wolf|songid=34525}} |}	Chart (2009) Peak position Belgium (Ultratop 50 Flanders) 16 Belgium (Ultratop 40 Wallonia) 5 Brazil Billboard Hot 100 Airplay 1 Hungary (Rádiós Top 40) 5 Ireland (IRMA) 2 Japan (Japan Hot 100) 9 UK Singles (The Official Charts Company) 4

Error messages

As an aid to template users, certain checks are made to verify that the necessary parameters have been entered. (The actual references are not checked for whether they correctly support the peak position claimed or even if the link is functional, but some parameter entries are checked for appropriateness.) When a check determines that a required parameter is missing, an error message is generated in red. For example, if you forget the week or year value for the Hungary chart, the result in the article will look like:

Hungary (Rádiós Top 40)YEAR AND WEEK MANDATORY FIELDS FOR HUNGARIAN CHARTS

19

This is an (additional) incentive to preview the article page before saving your edits. Check the charts table as well as the references section for (typically red) error messages.

Support

The large number of charts published by Billboard allows for some uniformity in how one accesses their information. However, the other charts and archives used as references on Wikipedia, produced by a multitude of publishers, call for a varied approach when looking up chart positions. Below are two tables, the first for non-Billboard charts, the second for Billboard charts, currently supported by the {{singlechart}} template. The parameters necessary to generate reference citations are shown in both tables for each supported chart.

Non-Billboard charts

Chart ID	Actual chart name	Website used as archive	Required parameters	Notes
Australia Australian	ARIA	www.australian-charts.com	artist song
Australiapandora	ARIA	pandora.nla.gov.au	url urltitle artist*	This forces the use of the National Library of Australia archive for an Australian chart position. This is the only method of retrieving archived positions above 50.
Australiaurban	ARIA	pandora.nla.gov.au	url urltitle artist*	This forces the use of the National Library of Australia archive for an Australian chart position. This is the only archive for the Australian Urban chart.
Austria Austrian	Ö3 Austria Top 40	www.austriancharts.at	artist song
Belgium (Wallonia) Wallonia	Ultratop 40	www.ultratop.be	artist song	Adding "Tip" after chart name (e.g., "Wallonia Tip") forces Ultratip reference.
Belgium (Flanders) Belgium (Vlanders) Flanders Vlanders	Ultratop 50	www.ultratop.be	artist song	Adding "Tip" after chart name forces Ultratip reference.
Bulgaria Bulgarian	IFPI at bamp-br.org	www.bamp-br.org	url urltitle artist*	The url parameter is validated to point at bamp-br.org. The urltitle parameter should match the title from the page at that url. Unfortunately, the Bulgarian chart cannot be indexed automatically.
Czech Republic	IFPI at www.ifpicr.cz	www.ifpicr.cz	year week artist*	Year and week indicate the referenced chart. Week is a number from 01 to 53, with a leading 0 for weeks 01-09. A comment is generated in the reference to show what should be entered in the search table to produce the correct chart.
Danish Denmark	Hitlisten	www.danishcharts.com	artist song	When year and week are not present, this form (requiring artist and song) will provide a reference pointing to www.danishcharts.com, which may vary from official positions for older songs. Avoid using this form for chart positions before November 2007.
		www.hitlisten.nu	artist song week year	Official Danish single charts (including prior to November 2007).
Denmark 2007	Hitlisten	www.hitlisten.nu	artist song week year	Official Danish single charts (including prior to November 2007).
Danish Airplay Denmark Airplay	Hitlisten	www.hitlisten.nu	artist song week year	Official Danish airplay Top 20 charts.
Dutch100	Mega Single Top 100	www.dutchcharts.nl	artist song	Note that the table row for this Chart ID will expand as "Netherlands" and may appear incorrectly placed if you position it under "D" in an alphabetically sorted table.
Dutch40	Dutch Top 40	www.top40.nl	artist song	When year and week are not present, this form (requiring artist and song) will provide a reference pointing to a search results page without positions. Note that the table row for this Chart ID will expand as "Netherlands" and may appear incorrectly placed if you position it under "D" in an alphabetically sorted table.
			year week artist*	Year and week indicate the referenced chart. Week is a number from 1 to 53, without a leading 0 for weeks 1-9. Note that the table row for this Chart ID will expand as "Netherlands" and may appear incorrectly placed if you position it under "D" in an alphabetically sorted table.
Finnish Finland	YLE	www.finnishcharts.com	artist song
French France	SNEP	www.lescharts.com	artist song
Frenchdigital	SNEP	www.lescharts.com	artist song date	This forces a reference to the download chart, which is not returned in the summary results. date is an 8 digit number, YYYYMMDD
German Germany	Media Control Charts	www.musicline.de	artist song	For artist use Last,First format. For song sometimes an unexpected naming is required, e.g., "Bad Romance (2-track)" instead of simply "Bad Romance".
Hungary Hungarian	Mahasz (Rádiós Top 40)	www.mahasz.hu	artist song year week	This is the main, fully indexable Top 40 Radio airplay chart. A link is generated to the individual chart.
Hungarytop10	Mahasz (Single Top 10)	www.mahasz.hu	artist song year week	A link is generated to the individual chart.
Hungarydance	Mahasz (Dance Top 40)	www.mahasz.hu	artist song year week	A link is generated to the individual chart.
Ireland Irish	IRMA	www.chart-track.co.uk	year week artist*	Allowable values for week range from 1 to 53. Single-digit values do not need to be preceded with a 0.
Italian Italy	FIMI	www.italiancharts.com	artist song
New Zealand	RIANZ	www.charts.org.nz	artist song
Norwegian Norway	VG-lista	www.norwegiancharts.com	artist song	When year and week are not present, this form (requiring artist and song) will provide a reference pointing to www.norwegiancharts.com.
		lista.vg.no/	artist song week year	When year and week are present, this form will provide a reference pointing to lista.vg.no/.
Scotland	Official Charts Company	www.officialchartcompany.com	date artist song	Date is formatted yyyy-mm-dd
Slovakia Slovakian	IFPI at www.ifpicr.cz	www.ifpicr.cz	year week artist*	Year and week indicate the referenced chart. Week is a number from 01 to 53, with a leading 0 for weeks 01-09. A comment is generated in the reference to show what should be entered in the search table to produce the correct chart.
Spain Spanish	PROMUSICAE	www.spanishcharts.com	artist song
Sweden Swedish	Sverigetopplistan	www.swedishcharts.com	artist song
Swiss Switzerland	Media Control Charts	www.swisscharts.com	artist song
UK United Kingdom	Official Charts Company Main singles chart	www.officialchartcompany.com	date artist song	Date is formatted yyyy-mm-dd. Due to technical limitations of URL formatting in Wikimedia, the "artist search" facility is not used, and a direct link to the chart is provided. This means that only positions 1-40 can be referenced with this template. For positions 41-100, UKchartstats should be used. This limitation is expected to be removed during 2010.
UKchartstats	Official Charts Company Main singles chart	www.chartstats.com	artist song songid	Different archives archive different ranges. For positions 41-100, this archive is generally recommended.
UKdance	Official Charts Company Dance singles chart	www.officialchartcompany.com	date artist song	Date is formatted yyyy-mm-dd
UKdownload	Official Charts Company Download chart	www.officialchartcompany.com	date artist song	Date is formatted yyyy-mm-dd
UKindependent UKindie	Official Charts Company Independent singles chart	www.officialchartcompany.com	date artist song	Date is formatted yyyy-mm-dd
UKrandb	Official Charts Company R&B chart	www.officialchartcompany.com	date artist song	Date is formatted yyyy-mm-dd
Other non-Billboard charts are not currently supported by {{singlechart}} and their use will need to be formatted and referenced manually (see the Brazil listing in Example 5 above). Be sure, however, not to use one of the deprecated charts. * These charts require the artist parameter solely for the purposes of internal reference naming using the default format (see Output above). If you are using the refname parameter to override the default naming, or you are sure that the references are not being reused in the article, you omit artist for the marked charts. The use of song and title are recommended for all charts, however.

Billboard charts

Billboard charts all require the artist name and an id number. This can be found by looking up the artist on www.billboard.com. For example, searching for Katy Perry on www.billboard.com will lead to http://www.billboard.com/#/artist/katy-perry/958673 . 958673 is the id number for Katy Perry. This is passed through the artistid parameter. For example,

• {{singlechart|Billboardhot100|1|artist=Katy Perry|artistid=958673}}

is the syntax for citing a number 1 position on the Billboard Hot 100 for Katy Perry.

Chart ID	Actual chart name	Website used as archive	Required parameters	Notes
Billboardcanadianhot100 Canada	Canadian Hot 100	www.billboard.com	artist artistid
Billboardeuropeanhot100	European Hot 100 Singles	www.billboard.com	artist artistid
Billboardjapanhot100	Japan Hot 100	www.billboard.com	artist artistid
Billboardadultcontemporary	Adult Contemporary	www.billboard.com	artist artistid
Billboardalternativesongs	Alternative Songs	www.billboard.com	artist artistid
Billboardhot100	Billboard Hot 100	www.billboard.com	artist artistid
Billboardadultpopsongs	Adult Top 40	www.billboard.com	artist artistid
Billboardcountrysongs	Hot Country Songs	www.billboard.com	artist artistid
Billboarddanceclubplay	Hot Dance Club Songs	www.billboard.com	artist artistid
Billboarddigitalsongs	Hot 100 Digital (Digital Songs)	www.billboard.com	artist artistid
Billboardlatinpopsongs	Latin Pop Airplay	www.billboard.com	artist artistid
Billboardregionalmexican	Latin Regional Mexican Airplay	www.billboard.com	artist artistid
Billboardlatintropical Billboardtropicalsongs	Latin Tropical Airplay	www.billboard.com	artist artistid	Charts prior to August 2009 are not available on the website. Use Allmusic instead.
Billboardlatinsongs	Hot Latin Songs	www.billboard.com	artist artistid
Billboardpopsongs	Mainstream Top 40 (Pop Songs)	www.billboard.com	artist artistid
Billboardrandbhiphop	Hot R&B/Hip-Hop Songs	www.billboard.com	artist artistid
Billboardradiosongs	Hot 100 Airplay (Radio Songs)	www.billboard.com	artist artistid
Billboardrapsongs	Rap Songs	www.billboard.com	artist artistid
Other Billboard charts are not currently supported by {{singlechart}} and their use will need to be formatted and referenced manually (see the Brazil listing in Example 5 above). Be sure, however, not to use one of the deprecated charts.

Examples with table layout

Example with dummy data

Since this template produces only individual rows within a table, you will need to add (or already have) the table's framework in the article. Here is a sample table with its corresponding output:

{| class="wikitable sortable" border="1"
|-
! Chart
! Peak position
|-
| row 1, cell 1
| row 1, cell 2
|-
| row 2, cell 1
| row 2, cell 2
|-
 {{singlechart|Australia|6|song=I'm the Urban Spaceman|artist=Bonzo Dog Doo Dah Band|note=Happy Meal edition}}
|-
 {{singlechart|Belgium (Wallonia)|4|song=I'm the Urban Spaceman|artist=Bonzo Dog Doo Dah Band}}
|}

<references/>

expands into:

Chart	Peak position
row 1, cell 1	row 1, cell 2
row 2, cell 1	row 2, cell 2
Australia (ARIA) Happy Meal edition	6
Belgium (Ultratop 40 Wallonia)	4

Example with realistic data

This example is excerpted from actual usage at Doesn't Mean Anything, with a couple of minor additions.

{|class="wikitable sortable" border="1"
|-
!Chart (2009)
!Peak<br />position
|-
{{singlechart|Australia|96|artist=Alicia Keys|song=Doesn't Mean Anything}}
|-
{{singlechart|Billboardcanadianhot100|66|artist=Alicia Keys|artistid=433721}}
|-
{{singlechart|Czech Republic|31|artist=Alicia Keys|song=Doesn't Mean Anything|year=2010|week=01}}
|-
{{singlechart|Billboardeuropeanhot100|10|artist=Alicia Keys|artistid=433721}}
|-
{{singlechart|Germany|8|artist=Keys,Alicia|song=Doesn't Mean Anything|note=Angela Merkel rap edition}}
|-
{{singlechart|Billboardjapanhot100|3|artist=Alicia Keys|artistid=433721}}
|-
{{singlechart|Dutch100|43|artist=Alicia Keys|song=Doesn't Mean Anything|accessdate=2010-02-28}}
|-
{{singlechart|New Zealand|22|artist=Alicia Keys|song=Doesn't Mean Anything}}
|-
{{singlechart|Slovakia|31|artist=Alicia Keys|song=Doesn't Mean Anything|week=52|year=2009}}
|-
{{singlechart|UKchartstats|8|artist=Alicia Keys|song=Doesn't Mean Anything|songid=34669}}
|-
{{singlechart|Billboardhot100|60|artist=Alicia Keys|artistid=433721}}
|-
{{singlechart|Billboardrandbhiphop|14|artist=Alicia Keys|artistid=433721}}
|}

<references/>

expands into:

Chart (2009)	Peak position
Australia (ARIA)	96
Canada (Canadian Hot 100)	66
Czech Republic (IFPI)	31
European Hot 100 Singles	10
Germany (Media Control AG) Angela Merkel rap edition	8
Japan (Japan Hot 100)	3
Netherlands (Mega Single Top 100)	43
New Zealand (RIANZ)	22
Slovakia (IFPI)	31
UK Singles (The Official Charts Company)	8
US Billboard Hot 100	60
US Hot R&B/Hip-Hop Songs (Billboard)	14

Maintenance categories

To help maintain music articles, this template will automatically categorize articles that call it based on the parameters used in the reference.

Singlechart category

1. REDIRECT Template:Category link

• From a page move: This is a redirect from a page that has been moved (renamed). This page was kept as a redirect to avoid breaking links, both internal and external, that may have been made to the old page name.

contains all articles that make use of the template.

Singlechart used with missing parameters

Category:Singlechart used with missing parameters contains a list of articles that have failed error checking because of missing parameters.

Singlechart usages for chartname

This set of categories lists the calls for each possible chart name, i.e. Category:singlechart usages for Billboardhot100 contains all articles that have used the template to build a reference for the Billboard Hot 100. Note that alternate names are not handled gracefully: Category:singlechart usages for Denmark and Category:singlechart usages for Danish are separate categories.