View source for Template:Single chart/doc

{{Documentation subpage}}
{{High-use|22000}}
{{Lua|Module:WLink|Module:String|Module:Check for unknown parameters}}
<!-- Categories go where indicated at the bottom of this page please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->

This template is used to [[WP:CITE|cite sources]] in Wikipedia. It is specifically for recorded musical single releases: [[Single (music)|singles]]. A similar template for use when citing sources for musical [[album]]s can be found at [[Template:Album chart]]; however, for [[Extended play|EPs]] or other releases, it 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.<!-- although actually, it seems that this template won't be very useful for album articles, where several songs' performance on several charts are typically shown -->

This template does not verify any positions or chart appearances. It primarily provides a reference URL believed to be associated with a [[WP:RS|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 cells 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:

{| class="wikitable"
|+Template syntax for Template:Single chart
! Full version (copy and paste text below and delete parameters you don't need)
|-
|
:{{code|<nowiki>{{single chart |(Chart identifier) |(Peak position) |song= |songid= |artist= |chartid= |artistid= |url= |urltitle= |date= |year= |week= |note= |publish-date= |access-date= |refname= |refgroup= |rowheader= }}</nowiki>}}

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.

{{code|rowheader}} defaults to {{code|false}}. If set to {{code|true}}, the chart name will be output as a header, as indicated by [[WP:ACCESS#Data tables]]. In most cases, it should be true.
|}

== Fields ==
The parameters ''publish-date'', ''access-date'', and ''refname'' are optional. Whether the other parameters are required or not depend on the chart being referenced. See the tables in the [[#Support|Support]] section below.
* '''(Chart identifier)''' (or first parameter, without name): Chart identifier. Must be one of the options listed under Chart ID in the tables of the [[#Support|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 position)''' (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 CIS below). Determined by performing a search at the chart listings' website for the single, The {{code|songid}} can be found in the Web address (URL) by inspection. For example, the page for "In My Mind" at tophit.ru has the URL https://tophit.ru/ru/tracks/88003/, so the {{code|songid}} to use is 88003.
* '''id''': Obsolete. Used in some cases in the same manner {{code|songid}} is used
* '''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|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 UKsinglesbyname below). Determined by performing a search at the chart listings' website for the artist, The ''artistid'' can be found in the Web address (URL) by inspection. For example, the page for Madonna at www.officialcharts.com has the URL https://www.officialcharts.com/artist/28948/madonna/, so the ''artistid'' to use is 28948.
* '''chartid''': Numeric identifier used by some chart listings (see [[Polish music charts]]). Determined by performing a search at the chart listings' website for archive chart. The ''chartid'' can be found in the Web address (URL) by inspection. For example, Polish Airplay Chart of 12 November 2011 at www.zpav.pl has the URL http://www.zpav.pl/rankingi/listy/nielsen/top5.php?lang=2&idlisty=532, so the ''chartid'' to use is 532.
* '''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 or another format specified, indicating year (Y), month (M) and day (D). Used only for certain charts; 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 ''publish-date'' 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 ''publish-date''.
* '''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|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 ''publish-date''.
* '''note''': For adding a note about a particular version of a song, e.g., <code>note=extended dance mix</code>, or <code><nowiki>{{single chart|Australia|1|song=I'm the Urban Spaceman|artist=The Bonzo Dog Doo Dah Band|note=uncensored version}}</nowiki></code>.
* '''publish-date''': Date of publication of the reference generated by the template, in the same format as other [[WP:DATES#Dates|dates]] in citations in the same article. Optional parameter.
* '''access-date''': 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|Output]] below) will be used. A reference with a name can be [[WP:NAMEDREFS|reused]] for claims elsewhere in the article. Optional parameter.
* '''refgroup''': Enables you to specify a name for the reference group. Optional parameter.
* '''page''': Used when referencing a book, see below where needed.

== Template data ==
{{TemplateData header}}
<templatedata>
{
 "description": "Creates a table row for a recognized single chart ",
 "params":
   {
    "1":
     {
      "label": "Chart identifier",
      "description": "Chart name: recognized values are listed at Template:Single chart/doc",
      "type": "string",
      "required": true
     },
    "2":
     {
      "label": "Chart position",
      "description": "Peak position on the chart",
      "type": "number",
      "required": true
     },
    "artist":
     {
      "label": "artist",
      "description": "Artist name as listed on the source chart",
      "type": "string",
      "required": true
     },
    "song":
     {
      "label": "song",
      "description": "Song title as listed on the source chart",
      "type": "string",
      "required": true
     },
    "refname":
     {
      "label": "reference name",
      "description": "Names the reference created by the template so that it may be used elsewhere in the article",
      "type": "string",
      "required": true
     },
    "chartnote":
     {
      "label": "Notes",
      "description": "Any special notes about this version here. Typically used to distinguish versions , i.e. 'reggae mix' vs. 'dubsteb version'",
      "type": "string",
      "required": false
     },
    "year":
     {
      "label": "year",
      "description": "Year in which the chart position occurred; format: yyyy; required for Czech Republic, all Hungarian charts, all Romanian charts, Ireland, Israeliairplay",
      "type": "number",
      "required": false
     },
    "week":
     {
      "label": "week",
      "description": "Week number (1–53); required for Czech Republic, all Hungarian charts, all Romanian charts, Ireland, Israeliairplay",
      "type": "number",
      "required": false
     },
    "url":
     {
      "label": "URL",
      "description": "Required for Bulgarian charts (must be from www.bamp-bg.org), and for Australiapandora (must be from pandora.nla.gov.au)",
      "type": "number",
      "required": false
     },
   "publish-date":
     {
      "label": "date of publishing",
      "description": "Date of chart, as used in prose. Free-format date (using a format acceptable at MOS:DATE) indicating when the chart was released",
      "type": "string",
      "required": false,
      "aliases": [ "publishdate" ]
     },
   "date":
     {
      "label": "date",
      "description": "Date of chart, as used in a URL string. Required for Frenchdigital (format yyyymmdd with no spaces) or any UK chart (format yyyy-mm-dd )",
      "type": "number",
      "required": false
     },
   "access-date":
     {
      "label": "access date",
      "description": "Free-format date (using a format acceptable at MOS:DATE) showing when this information was verified by an editor",
      "type": "string",
      "required": false,
      "aliases": [ "accessdate" ]
     },
   "rowheader":
     {
      "label": "Row header control",
      "description": "When set to true, the chart name will be treated as a row header",
      "type": "string",
      "required": false
     }

   }
}
</templatedata>

==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<sup style="color:blue;">[n]</sup> as if it were enclosed in <code><nowiki><ref></ref></nowiki></code> 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 <code><nowiki><references /></nowiki></code> or the {{tlc|reflist}} template, like any other references. The reference produced will be given a name in the form <nowiki>"sc_Chartid_artist"</nowiki> by default, ''i.e.'', if the article uses
::{{tlc|single chart|Australia|1|4=song=I'm the Urban Spaceman|5=artist=Bonzo Dog Doo Dah Band|6=note=album version}}

then the citation could be used to support other statements on the page using a reference as in
::<code><nowiki>...some fact supported by the same source.<ref name="sc_Australia_Bonzo Dog Doo Dah Band"/></nowiki></code>

Alternatively, the name can be overridden using the ''refname'' parameter, ''i.e.'',
::{{tlc|single chart|Australia|1|4=song=I'm the Urban Spaceman|5=artist=Bonzo Dog Doo Dah Band|6=refname=bonzosinoz}}

which could then be used as a citation to support other statements on the page using a reference as in
::<code><nowiki>...some fact supported by the same source.<ref name=bonzosinoz/></nowiki></code>
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 <nowiki><ref></nowiki> (for example, you would need to use <code><nowiki><ref name="bonzos in oz"/></nowiki></code> 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|Examples with table layout]] section below.

{| class="wikitable"
|+Usage examples of Template:Single chart
!scope="col"| Example no.
!scope="col"| Coding (assumed inside a table row)
!scope="col"| Output (assumed with <nowiki><references /></nowiki> added)
|-
!scope="row"| Example 1
| style="width: 40%; vertical-align: top;" |
<code><pre><nowiki>{{single chart
  |Australia
  |18
  |artist=Shakira
  |song=She Wolf
  |rowheader=true}}</nowiki></pre></code>
| style="width: 50%; vertical-align: top;" |
{| class="wikitable" <!-- single-cell table to hold expansion of template with piping | cell divider -->
|-
 {{single chart |Australia|18 |artist=Shakira |song=She Wolf |rowheader=true}}
|}
<references />

|-
!scope="row"| Example 2
| style="vertical-align: top;" |<code><pre><nowiki> {{single chart
  |Billboardcanadianhot100
  |5
  |artist=Shakira
  |rowheader=true}}</nowiki></pre></code>
| style="vertical-align: top;" |
{| class="wikitable" <!-- single-cell table to hold expansion of template with piping | cell divider -->
|-
 {{single chart |Billboardcanadianhot100|5 |artist=Shakira|rowheader=true}}
|}
<references />

|-
!scope="row"| Example 3
| style="vertical-align: top;" |<code><pre><nowiki> {{single chart
  |Frenchdigital
  |4
  |artist=Shakira
  |song=She Wolf
  |date=20091017
  |rowheader=true}}</nowiki></pre></code>
| style="vertical-align: top;" |
{| class="wikitable" <!-- single-cell table to hold expansion of template with piping | cell divider -->
|-
 {{single chart|Frenchdigital|4|artist=Shakira|song=She Wolf|date=20091017|rowheader=true}}
|}
<references />

|-
!scope="row"| Example 4
| style="vertical-align: top;" |<code><pre><nowiki> {{single chart
  |Italy
  |3
  |artist=Shakira
  |song=Loba
  |note="Loba" (Spanish version)
  |refname=Italy1
  |rowheader=true}}
|-
{{single chart
  |Italy
  |11
  |artist=Shakira
  |song=She Wolf
  |note="She Wolf" (English version)
  |refname=Italy2
  |rowheader=true}}</nowiki></pre></code>
| style="vertical-align: top;" |
Note the use of the <code>refname</code> parameter to avoid causing a duplicate reference definition.
{| class="wikitable" <!-- single-cell table to hold expansion of template with piping | cell divider -->
|-
{{single chart|Italy|3|artist=Shakira|song=Loba|note="Loba" (Spanish version)|refname=Italy1|rowheader=true}}
|-
{{single chart|Italy|11|artist=Shakira|song=She Wolf|note="She Wolf" (English version)|refname=Italy2|rowheader=true}}
|}
<references />

|-
!scope="row"| Example 5
| style="vertical-align: top;" |<code><pre><nowiki>
{| class="wikitable sortable"
|+Chart performance for "She Wolf"
|-
!scope="col"| Chart (2009)
!scope="col"| Peak<br />position
|-
{{single chart |Flanders|16
  |artist=Shakira |song=She Wolf|rowheader=true}}
|-
{{single chart |Wallonia|5
  |artist=Shakira |song=She Wolf|rowheader=true}}
|-
!scope="row"|[[Billboard Brasil|
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
|-
{{single chart |Hungary|5|year=2009|week=14|rowheader=true}}
|-
{{single chart |Ireland|2 |year=2009 |week=40|rowheader=true}}
|-
{{single chart |Billboardjapanhot100|9
  |artist=Shakira|rowheader=true}}
|-
{{single chart|Poland|2|year=2013|chartid=532|rowheader=true}}
|}</nowiki></pre></code>
| style="vertical-align: top;" |
{| class="wikitable sortable"
|+Chart performance for "She Wolf"
|-
!scope="col"| Chart (2009)
!scope="col"| Peak<br />position
|-
{{single chart |Flanders|16
  |artist=Shakira |song=She Wolf|rowheader=true}}
|-
{{single chart |Wallonia|5
  |artist=Shakira |song=She Wolf|rowheader=true}}
|-
!scope="row"|[[Billboard Brasil|
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
|-
{{single chart |Hungary|5|year=2009|week=14|rowheader=true}}
|-
{{single chart |Ireland|2 |year=2009 |week=40|rowheader=true}}
|-
{{single chart |Billboardjapanhot100|9
  |artist=Shakira|rowheader=true}}
|-
{{single chart|Poland|2|year=2013|chartid=532|rowheader=true}}
|}
<references />
|}

===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:
::{| class="wikitable"
|-
{{single chart|Hungary|19}}
|}

This is an (additional) incentive to [[Help:Show preview|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 (magazine)|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 {{tlc|single chart}} template. The parameters necessary to generate reference citations are shown in both tables for each supported chart.

===Non-''Billboard'' charts===

{| class="wikitable"
|+Non-''Billboard'' charts used in Template:Single chart
!scope="col"| Chart ID
!scope="col"| Actual chart name
!scope="col"| Website used as archive
!scope="col"| Required parameters
!scope="col"| Notes
|-
!scope="row"|Australia<br />Australian
|[[ARIA Charts|ARIA]]
|www.australian-charts.com
|artist<br />song
|
|-
!scope="row"|Australiapandora
|[[ARIA Charts|ARIA]]
|pandora.nla.gov.au
|url<br />urltitle<br />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.
|-
!scope="row"|Australiaurban
|[[ARIA Charts|ARIA]]
|pandora.nla.gov.au
|url<br />urltitle<br />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.
|-
!scope="row"|AustraliaKent
|[[Kent Music Report]]
|none
|page
|Uses {{cite Kent}} as the source
|-
!scope="row"|Austria<br />Austrian
|[[Ö3 Austria Top 40]]
|www.austriancharts.at
|artist<br />song
|
|-
!scope="row"|Belgium&nbsp;(Wallonia)<br />Wallonia
|[[Ultratop 50]]
|www.ultratop.be
|artist<br />song
|Adding "Tip" after chart name (e.g., "Wallonia Tip") forces Ultratip reference.
|-
!scope="row"|Belgium&nbsp;(Flanders)<br />Flanders
|[[Ultratop 50]]
|www.ultratop.be
|artist<br />song
|Adding "Tip" after chart name forces Ultratip reference.
|-
!scope="row"|Bulgaria<br />Bulgarian
|[[IFPI]] at bamp-bg.org
|www.bamp-bg.org
|url<br />urltitle<br />artist*
|The ''url'' parameter is validated to point at bamp-bg.org. The ''urltitle'' parameter should match the title from the page at that url. Unfortunately, the Bulgarian chart cannot be indexed automatically.
|-
!scope="row"|Canadaadultcontemporary
|''[[RPM (magazine)|RPM]]'' Adult Contemporary Tracks
|www.bac-lac.gc.ca/eng/discover/films-videos-sound-recordings/rpm
|chartid
|After searching, click on the desired result, then click on the chart to display a larger image. Use the chartid from the larger image.
|-
!scope="row"|Canadacountry
|''[[RPM (magazine)|RPM]]'' Country Tracks
|www.bac-lac.gc.ca/eng/discover/films-videos-sound-recordings/rpm
|chartid
|After searching, click on the desired result, then click on the chart to display a larger image. Use the chartid from the larger image.
|-
!scope="row"|Canadadance
|''[[RPM (magazine)|RPM]]'' Dance/Urban
|www.bac-lac.gc.ca/eng/discover/films-videos-sound-recordings/rpm
|chartid
|After searching, click on the desired result, then click on the chart to display a larger image. Use the chartid from the larger image.
|-
!scope="row"|Canadarock
|''[[RPM (magazine)|RPM]]'' Rock/Alternative
|www.bac-lac.gc.ca/eng/discover/films-videos-sound-recordings/rpm
|chartid
|After searching, click on the desired result, then click on the chart to display a larger image. Use the chartid from the larger image.
|-
!scope="row"|Canadatopsingles
|''[[RPM (magazine)|RPM]]'' Top Singles
|www.bac-lac.gc.ca/eng/discover/films-videos-sound-recordings/rpm
|chartid
|After searching, click on the desired result, then click on the chart to display a larger image. Use the chartid from the larger image.
|-
!scope="row"| CIS
| [[Tophit]] Radio & YouTube Hits
| tophit.ru
| songid
|
|-
!scope="row"|Czech Republic
|[[IFPI|ČNS IFPI]] (Rádio Top 100)
|rowspan="2"|www.ifpicr.cz
|rowspan="2"|year<br />week<br />artist*
|rowspan="2"|''Year'' and ''week'' indicate the referenced chart. ''Week'' is a number from 01 to 53, with a leading 0 for weeks 01 to 09. A comment is generated in the reference to show what should be entered in the search table to produce the correct chart. Note that database includes only data since January 2006, thus data for songs released prior to January 2006 are incomplete.
|-
!scope="row"|Czechdigital
|[[IFPI|ČNS IFPI]] (Singles Digitál Top 100)
|-
!scope="row" rowspan="2"|Danish<br />Denmark
|rowspan="2"|[[Hitlisten]]
|danishcharts.dk
|artist<br />song
|When ''year'' and ''week'' are not present, this form (requiring ''artist'' and ''song'') will provide a reference pointing to danishcharts.dk, which may vary from official positions for older songs. Includes chart positions from 2001.
|-
|hitlisten.nu
|artist<br />song<br />week<br />year
|Official Danish single charts. Cannot be used for chart positions before November 2007.
|-
!scope="row"|Danish Airplay<br />Denmark Airplay
|[[Hitlisten]]
|hitlisten.nu
|artist<br />song<br />week<br />year
|Official Danish airplay top 20 chart.
|-
!scope="row"|Dutch100
|[[Single Top 100]]
|www.dutchcharts.nl
|artist<br />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.
|-
!scope="row" rowspan="2"|Dutch40
|rowspan="2"|[[Dutch Top 40]]
|rowspan="2"|www.top40.nl
|artist<br />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<br />week<br />artist*
|''Year'' and ''week'' indicate the referenced chart. ''Week'' is a number from 1 to 53, without a leading 0 for weeks 1-9.<br />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.
|-
!scope="row"|Finnish<br />Finland
|[[The Official Finnish Charts|Suomen virallinen lista]]
|www.ifpi.fi
|artist<br />song
|
|-
!scope="row"|Finnishdownload<br />latauslista
|[[The Official Finnish Charts|Suomen virallinen latauslista]]
|www.ifpi.fi
|artist
|Non-Finnish artists:
* If the release has charted on the comprehensive chart above, this chart is to be omitted.
Finnish artists:
* If the release has charted on the comprehensive chart (above) and '''not abroad''', this chart can be added.
|-
!scope="row"|Finnishairplay<br />radiosoittolista
|[[The Official Finnish Charts|Suomen virallinen radiosoittolista]]
|www.ifpi.fi
|artist
|Non-Finnish artists:
* If the release has charted on the comprehensive chart above (Finnish/Finland), this chart is to be omitted.
Finnish artists:
* If the release has charted on the comprehensive chart above (Finnish/Finland) and '''not abroad''', this chart can be added.
|-
!scope="row"|French<br />France
|[[Syndicat National de l'Édition Phonographique|SNEP]]
|www.lescharts.com
|artist<br />song
|
|-
!scope="row"|Frenchdigital
|[[Syndicat National de l'Édition Phonographique|SNEP]]
|www.lescharts.com
|artist<br />song<br />date
|This forces a reference to the download chart, which is not returned in the summary results. ''date'' is an 8 digit number, YYYYMMDD
|-
!scope="row"|German<br />Germany
|[[GfK Entertainment Charts|Official German Charts]]
|www.offiziellecharts.de
|artist<br />song<br />songid
| Use ''West Germany'' for singles peaking before [[German reunification]] (October 3, 1990).  ''songid'' is found by searching www.offiziellecharts.de for the song title, clicking on the correct (artist) version, then using the numeric part of the resulting URL.
|-
!scope="row"|West Germany
|[[GfK Entertainment Charts|Official German Charts]]
|www.offiziellecharts.de
|artist<br />song<br />songid<br />year
| For songs before [[German reunification]] – this chart identifier creates the same citation information as ''Germany'', however it is labeled "West Germany" instead of "Germany". Specify the year for singles peaking before 1978 – this adds instructions in the text of the citation so the user can see the peak position. ''songid'' is found by searching www.offiziellecharts.de for the song title, clicking on the correct (artist) version, then using the numeric part of the resulting URL.  Note that as long as a highest position (''Höchstposition'') is shown on this page, the year parameter is not needed.
|-
!scope="row"|Hungary<br />Hungarian
|[[Mahasz]]<br />(Rádiós Top&nbsp;40)
|www.mahasz.hu
|year<br />week
|This is the main, fully indexable Top 40 Radio airplay chart. A link is generated to the individual chart.
|-
!scope="row"|Hungarysingle
|[[Mahasz]]<br />(Single Top&nbsp;40)
|www.mahasz.hu
|year<br />week
|A link is generated to the individual chart.
|-
!scope="row"|Hungarydance
|[[Mahasz]]<br />(Dance Top&nbsp;40)
|www.mahasz.hu
|year<br />week
|A link is generated to the individual chart.
|-
!scope="row"|Hungarystream
|[[Mahasz]]<br />(Stream Top&nbsp;40)
|www.mahasz.hu
|year<br />week
|A link is generated to the individual chart.
|-
!scope="row"|{{strikethrough|Ireland<br />Irish}}
|[[Irish Recorded Music Association|IRMA]]
|www.chart-track.co.uk
|year<br />week<br />artist*
|Obsolete. Allowable values for ''week'' range from 1 to 53. Single-digit values do not need to be preceded with a 0.<br/>Only from 2000 to 2016
|-
!scope="row"|Ireland2
|[[Irish Recorded Music Association|IRMA]]
|irishcharts.ie
|artist ''or''<br />song
|If the ''song'' parameter is present, it provides a reference pointing to search results for the song, otherwise, it provides a URL including search results for the specified artists.
|-
!scope="row"|Ireland3
|[[Irish Recorded Music Association|IRMA]]
|www.irish-charts.com
|artist
|A link is generated to the artist's discography page.
|-
!scope="row"|Ireland4
|[[Official Charts Company]]
|www.officialcharts.com
|date<br />artist<br />song
|Date is formatted YYYYMMDD.
|-
!scope="row"|Italian<br />Italy
|[[Federation of the Italian Music Industry|FIMI]]
|www.italiancharts.com
|artist<br />song
|
|-
!scope="row"|Japan<br />Oricon
|[[Oricon]]
|https://www.oricon.co.jp
|date
|Links to the weekly single rankings. Page linked to does not contain the top position, but can be found by going to the individual song page, which can be linked directly through Japan2.
|-
!scope="row"|Japan2<br />Oricon2
|[[Oricon]]
|https://www.oricon.co.jp
|artistid songid song
|Links to the individual song page. URL structure is <code><nowiki>https://www.oricon.co.jp/prof/XXXXXX/products/XXXXXXX/1/</nowiki></code> the first number is the artistid and the second the songid. 
|-
!scope="row"|New Zealand
|[[Recorded Music NZ]]
|www.charts.nz
|artist<br />song
|
|-
!scope="row"|Norway
|[[VG-lista]]
|http://lista.vg.no/
|artist<br />song<br />week<br />year
|When ''year'' and ''week'' are present, this form will provide a reference pointing to lista.vg.no/.
|-
!scope="row"|Poland
|[[Polish music charts]]
|www.zpav.pl
|chartid<br />year
|
|-
!scope="row"|Polishdance
|[[Polish Dance Chart]]
|www.zpav.pl
|chartid|
|-
!scope="row"|Portugal
|[[Associação Fonográfica Portuguesa]]
|https://portuguesecharts.com/
|song<br />artist
|
|-
!scope="row"|Romaniaradioairplay
|[[Romanian Radio Airplay Chart]]
|rowspan="2"|mediaforest.ro
|rowspan="2"|year<br />week<br />artist*
|rowspan="2"|Year and week indicate the referenced chart. Week is a number from 01 to 53, with a leading 0 for weeks 01 to 09. To retrieve peak positions, the user may combine the "Romanian" and "International" columns by the number of broadcasts. 
|-
!scope="row"|Romaniatvairplay
|[[Romanian TV Airplay Chart]]
|-
!scope="row"|Russia
|[[Tophit]]
|tophit.ru
|date<br />artist*
|Date is formatted YYYY-MM-DD.
|-
!scope="row"|Scotland
|[[Official Charts Company]]
|www.officialcharts.com
|date<br />artist<br />song
|Date is formatted YYYYMMDD.
|-
!scope="row"|Slovakia<br />Slovakian
|[[IFPI|ČNS IFPI]] (Rádio Top 100)
|rowspan="2"|www.ifpicr.cz
|rowspan="2"|year<br />week<br />artist*
|rowspan="2"|''Year'' and ''week'' indicate the referenced chart. ''Week'' is a number from 01 to 53, with a leading 0 for weeks 01 to 09. A comment is generated in the reference to show what should be entered in the search table to produce the correct chart.<br/>[http://hitparadask.ifpicr.cz/index.php Hitparadask] contains Rádio Top 100 archives from 200635 to 201634 and Singles Digitál Top 100 archives from 201426 to 201634, while [http://hitparada.ifpicr.cz/index.php?hitp=R Hitparada] contains Rádio Top 100 and Singles Digitál Top 100 archives from 201643 onwards.
|-
!scope="row"|Slovakdigital
|[[IFPI|ČNS IFPI]] (Singles Digitál Top 100)
|-
!scope="row"|South Africa
|[[Entertainment Monitoring Africa|EMA]]
|www.sa-ema.com
|date
|Date is formatted YYYY-MM-DD
|-
!scope="row"|Spain<br />Spanish
|[[Productores de Música de España|PROMUSICAE]]
|www.spanishcharts.com
|artist<br />song
|
|-
!scope="row"|Sweden<br />Swedish
|[[Sverigetopplistan]]
|www.swedishcharts.com
|artist<br />song
|
|-
!scope="row"|Swiss<br />Switzerland
|[[Swiss Music Charts|Schweizer Hitparade]]
|www.swisscharts.com
|artist<br />song
|
|-
!scope="row"|Swiss Romandy<br />Romandy<br />Suisse romande
|[[Swiss Hitparade|Media Control]]
|lescharts.ch
|artist<br />song
|
|-
!scope="row"|UK<br />United Kingdom
|[[Official Charts Company]]<br />Main singles chart
|www.officialcharts.com
|date<br />artist<br />song
|Date is formatted YYYYMMDD.
|-
!scope="row"|UKsinglesbyname
|[[Official Charts Company]]<br />Main singles chart
|www.officialcharts.com
|artist<br />song<br />artistid
|This accesses the artist information page on officialcharts.com.
|-
!scope="row"|UKdance
|[[Official Charts Company]]<br />Dance singles chart
|www.officialcharts.com
|date<br />artist<br />song
|Date is formatted YYYYMMDD.
|-
!scope="row"|UKdownload
|[[Official Charts Company]]<br />Download chart
|www.officialcharts.com
|date<br />artist<br />song
|Date is formatted YYYYMMDD.
|-
!scope="row"|UKindependent<br />UKindie
|[[Official Charts Company]]<br /> Independent singles chart
|www.officialcharts.com
|date<br />artist<br />song
|Date is formatted YYYYMMDD.
|-
!scope="row"|UKrandb
|[[Official Charts Company]]<br /> R&B chart
|www.officialcharts.com
|date<br />artist<br />song
|Date is formatted YYYYMMDD.
|-
!scope="row"|UKrock<br />UKrockandmetal
|[[Official Charts Company]]<br /> Rock and metal chart
|www.officialcharts.com
|date<br />artist<br />song
|Date is formatted YYYYMMDD.
|-
!scope="row"|UKstreaming
|[[Official Charts Company]]<br /> Streaming chart
|www.officialcharts.com
|date<br />artist<br />song
|Date is formatted YYYYMMDD.
|-
!scope="row"|Ukraine
|[[Tophit]]
|tophit.ru
|date<br />artist*
|Date is formatted YYYY-MM-DD.
|-
|}
Other non-''Billboard'' charts are not currently supported by {{tlc|single chart}} 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 [[WP:BADCHARTS|deprecated charts]].

<nowiki>*</nowiki> These charts require the ''artist'' parameter solely for the purposes of internal reference naming using the default format (see [[#Output|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.
{| class="wikitable"
|+''Billboard'' charts used by Template:Single chart
!scope="col"| Chart ID
!scope="col"| Actual chart name
!scope="col"| Website used as archive
!scope="col"| Required parameters
!scope="col"| Notes
|-
!scope="row"|{{Deltext|Billboardbrasilhot100}}
|[[Brasil Hot 100 Airplay]]
|www.billboard.com
|artist
|defunct
|-
!scope="row"|Billboardcanadianhot100<br />Canada
|[[Canadian Hot 100]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardcanadaac
|[[Canada AC]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardcanadachrtop40
|[[Canada CHR/Top 40]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardcanadacountry
|[[Canada Country]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardcanadahotac
|[[Canada Hot AC]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardcanadarock
|[[Canada Rock]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardeurodigital
|[[Euro Digital Songs]]
|www.billboard.com/biz
|artist
|
|-
!scope="row"|{{strikethrough|Billboardeuropeanhot100}}
|[[European Hot 100 Singles]]
|www.billboard.com
|artist
|defunct
|-
!scope="row"|Billboardjapanhot100
|[[Japan Hot 100]]
|www.billboard.com
|artist
|
|-
!scope="row"|{{strikethrough|Luxembourgdigitalsongs}}
|[[Luxembourg Digital Songs]]
|www.billboard.com/biz
|artist
|defunct
|-
!scope="row"|{{deltext|Philippines}}
|[[Philippine Hot 100]]
|www.billboard.ph
|date
|defunct
|-
!scope="row"|{{strikethrough|Portugaldigitalsongs}}
|[[Portugal Digital Songs]]
|www.billboard.com/biz
|artist
|defunct
|-
!scope="row"|Billboardglobal200
|[[Billboard Global 200|''Billboard'' Global 200]]
|www.billboard.com/music
|artist
|
|-
!scope="row"|Billboardhot100
|[[Billboard Hot 100|''Billboard'' Hot 100]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardbubbling100
|[[Bubbling Under Hot 100 Singles]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboarddigitalsongs
|[[Digital Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardradiosongs
|[[Hot 100 Airplay (Radio Songs)|Radio Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardchristiansongs
|[[Hot Christian Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardcountrysongs
|[[Hot Country Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboarddanceelectronic
|[[Dance/Electronic Songs|Hot Dance/Electronic Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardlatinsongs
|[[Hot Latin Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardrandbhiphop
|[[Hot R&B/Hip-Hop Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardrapsongs
|[[Hot Rap Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardrocksongs
|[[Hot Rock & Alternative Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardadultalternativesongs
|[[Adult Alternative Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardadultcontemporary
|[[Adult Contemporary (chart)|Adult Contemporary]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardadultrandbsongs
|[[Adult R&B Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardadultpopsongs
|[[Adult Top 40]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardalternativesongs
|[[Alternative Airplay]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardchristianairplay
|[[Christian Airplay]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardcountryairplay
|[[Country Airplay]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboarddanceclubplay
|[[Dance Club Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboarddanceairplay
|[[Dance/Mix Show Airplay]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardlatinairplay
|[[Latin Airplay]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardlatinpopsongs
|[[Latin Pop Airplay]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardmainstreamrock
|[[Mainstream Rock (chart)|Mainstream Rock]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardpopsongs
|[[Mainstream Top 40]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardrandbhiphopairplay
|[[Hot R&B/Hip-Hop Airplay|R&B/Hip-Hop Airplay]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardregionalmexican
|[[Regional Mexican Airplay]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardrhythmic
|[[Rhythmic (chart)|Rhythmic]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardrockairplay
|[[Rock Airplay]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardsmoothjazzsongs
|[[Smooth Jazz Songs]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardlatintropical
|[[Latin Tropical Airplay]]
|www.billboard.com
|artist
|
|-
!scope="row"|Billboardlatinrhythm
|[[Latin Rhythm Airplay]]
|www.billboard.com
|artist
|
|-
!scope="row"|{{strikethrough|Billboardsinglessales}}
|[[Hot Singles Sales]]
|www.billboard.com
|artist
|defunct
|-
!scope="row"|{{strikethrough|Billboardbubblingrandbhiphop}}
|[[Bubbling Under R&B/Hip-Hop Songs]]
|www.billboard.com
|artist
|defunct
|-
|}
Other ''Billboard'' charts are not currently supported by {{tlc|single chart}} 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 [[WP:BADCHARTS|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:

<pre>{| class="wikitable sortable"
|+Chart performance for "I'm the Urban Spaceman"
|-
!scope="col"| Chart
!scope="col"| Peak position
|-
!scope="row"| row 1, cell 1
| row 1, cell 2
|-
!scope="row"| row 2, cell 1
| row 2, cell 2
|-
 {{single chart|Australia|6|song=I'm the Urban Spaceman|artist=Bonzo Dog Doo Dah Band|note=Happy Meal edition|rowheader=true}}
|-
 {{single chart|Belgium (Wallonia)|4|song=I'm the Urban Spaceman|artist=Bonzo Dog Doo Dah Band|rowheader=true}}
|}</pre>
<nowiki><references /></nowiki>

expands into:

{| class="wikitable sortable"
|+Chart performance for "I'm the Urban Spaceman"
|-
!scope="col"| Chart
!scope="col"| Peak position
|-
!scope="row"| row 1, cell 1
| row 1, cell 2
|-
!scope="row"| row 2, cell 1
| row 2, cell 2
|-
 {{single chart|Australia|6|song=I'm the Urban Spaceman|artist=Bonzo Dog Doo Dah Band|note=Happy Meal edition|rowheader=true}}
|-
 {{single chart|Belgium (Wallonia)|4|song=I'm the Urban Spaceman|artist=Bonzo Dog Doo Dah Band|rowheader=true}}
|}<references />

===Example with realistic data===
This example is excerpted from actual usage at "[[Doesn't Mean Anything]]", with a couple of minor additions.
<pre>{|class="wikitable sortable"
|+Chart performance for "Doesn't Mean Anything"
|-
!scope="col"|Chart (2009)
!scope="col"|Peak<br />position
|-
{{single chart|Australia|96|artist=Alicia Keys|song=Doesn't Mean Anything|rowheader=true}}
|-
{{single chart|Billboardcanadianhot100|66|artist=Alicia Keys|rowheader=true}}
|-
{{single chart|Czech Republic|31|artist=Alicia Keys|song=Doesn't Mean Anything|year=2010|week=01|rowheader=true}}
|-
{{single chart|Germany|8|artist=Keys,Alicia|song=Doesn't Mean Anything|songid=625466|note=Angela Merkel rap edition|rowheader=true}}
|-
{{single chart|Billboardjapanhot100|3|artist=Alicia Keys|rowheader=true}}
|-
{{single chart|Dutch100|43|artist=Alicia Keys|song=Doesn't Mean Anything|access-date=2010-02-28|rowheader=true}}
|-
{{single chart|New Zealand|22|artist=Alicia Keys|song=Doesn't Mean Anything|rowheader=true}}
|-
{{single chart|Slovakia|31|artist=Alicia Keys|song=Doesn't Mean Anything|week=52|year=2009|rowheader=true}}
|-
{{single chart|UKsinglesbyname |8|artist=Alicia Keys|song=Doesn't Mean Anything|artistid=10931|rowheader=true}}
|-
{{single chart|Billboardhot100|60|artist=Alicia Keys|rowheader=true}}
|-
{{single chart|Billboardrandbhiphop|14|artist=Alicia Keys|rowheader=true}}
|}</pre>

<nowiki><references /></nowiki>

expands into:

{|class="wikitable sortable"
|+Chart performance for "Doesn't Mean Anything"
|-
!scope="col"|Chart (2009)
!scope="col"|Peak<br />position
|-
{{single chart|Australia|96|artist=Alicia Keys|song=Doesn't Mean Anything|rowheader=true}}
|-
{{single chart|Billboardcanadianhot100|66|artist=Alicia Keys|rowheader=true}}
|-
{{single chart|Czech Republic|31|artist=Alicia Keys|song=Doesn't Mean Anything|year=2010|week=01|rowheader=true}}
|-
{{single chart|Germany|8|artist=Keys,Alicia|song=Doesn't Mean Anything|songid=625466|note=Angela Merkel rap edition|rowheader=true}}
|-
{{single chart|Billboardjapanhot100|3|artist=Alicia Keys|rowheader=true}}
|-
{{single chart|Dutch100|43|artist=Alicia Keys|song=Doesn't Mean Anything|access-date=2010-02-28|rowheader=true}}
|-
{{single chart|New Zealand|22|artist=Alicia Keys|song=Doesn't Mean Anything|rowheader=true}}
|-
{{single chart|Slovakia|31|artist=Alicia Keys|song=Doesn't Mean Anything|week=52|year=2009|rowheader=true}}
|-
{{single chart|UKsinglesbyname |8|artist=Alicia Keys|song=Doesn't Mean Anything|artistid=10931|rowheader=true}}
|-
{{single chart|Billboardhot100|60|artist=Alicia Keys|rowheader=true}}
|-
{{single chart|Billboardrandbhiphop|14|artist=Alicia Keys|rowheader=true}}
|}<references />

==Limitations==
Each Chart ID corresponds to only one output name — in the case of charts which have been renamed, this is usually the current/most recent name. This may be anachronistic for a given single. A workaround is to use {{para|note}} e.g. 
:<code><nowiki>{{single chart|Billboardadultcontemporary|7|song=Gentle on My Mind|artist=Patti Page|note=then called Easy Listening}}</nowiki></code>

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

===Single chart used with missing parameters===
{{Category link|Singlechart used with missing parameters}} contains a list of articles that have failed error checking because of missing parameters.

===Single chart usages for ''chartname''===
This set of categories lists the calls for each possible chart name, i.e. {{category link|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 link|singlechart usages for Denmark}} and {{category link|singlechart usages for Danish}} are separate categories.
<!--
=== Invalid artist ===
This template will automatically categorize articles with invalid artist names in [[:Category:Articles using Billboard ID with invalid artist]]. An invalid artist name is one that the template is unable to find in the {{tl|BillboardID}} subtemplate corresponding to the first letter in that artist's name. See the documentation for {{tl|BillboardID}} for instructions on how to fix this error.
-->

== See also ==
* {{tl|Album chart}}&nbsp;– counterpart of ''Single chart'' but for chart positions for music album releases.


<includeonly>{{Sandbox other||
<!-- Categories go below this line please; interwikis go to Wikidata, thank you! -->
[[Category:Templates that generate named references]]
}}</includeonly>