View source for Template:Single chart/sandbox

<includeonly>{{#invoke:Music chart/sandbox|main|type=single}}</includeonly><noinclude>{{Documentation subpage}}
{{#switch: {{ROOTPAGENAME}}
| Single chart | Album chart = {{High-use}}
}}
{{Lua|Module:Music chart}}

This template [[Wikipedia:Citing sources|cites sources]] for {{#switch: {{ROOTPAGENAME}}
| Single chart = [[Single (music)|singles]]
| Album chart = [[album]]s
| Year-end single chart = year-end [[Single (music)|single]] charts
| Year-end album chart = year-end [[album]] charts
}}. Related: {{#switch: {{ROOTPAGENAME}}
| Single chart = {{tl|Album chart}}, {{tl|Year-end single chart}}.
| Album chart = {{tl|Single chart}}, {{tl|Year-end album chart}}.
| Year-end single chart = {{tl|Single chart}}, {{tl|Year-end album chart}}.
| Year-end album chart = {{tl|Album chart}}, {{tl|Year-end single chart}}.
}}

The template produces a table row with chart name, reference, and {{#ifeq: {{#invoke:String|sub|{{ROOTPAGENAME}}|1|8}} | Year-end | year-end | peak }} position for inclusion ''within'' a table. It does ''not'' create surrounding table markup.

This template does not verify positions. It provides a reference URL believed to be associated with a [[Wikipedia:Reliable sources|reliable source]]. ''The reference URL itself is not checked'' — incorrect spellings can produce bad links. '''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.

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

It is a good practice to ''always'' include {{#switch: {{ROOTPAGENAME}} | Single chart = <code>song</code> and <code>artist</code> | Album chart = <code>album</code> and <code>artist</code> | #default = <code>year</code> }}, 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</code> defaults to <code>false</code>. If set to <code>true</code>, the chart name will be output as a header, as indicated by [[WP:ACCESS#Data tables]]. In most cases, it should be true.
|}

== Output ==
The template produces:
* A table row: left cell with chart name (with wikilinks) and reference, right cell with centered position
* A named reference for reuse elsewhere

'''Example'''
{{#switch: {{ROOTPAGENAME}}
| Single chart =
<syntaxhighlight lang="wikitext">{{Single chart|Australia|1|artist=Beyoncé|song=Halo|access-date=January 1, 2025|rowheader=true}}</syntaxhighlight>
| Album chart =
<syntaxhighlight lang="wikitext">{{Album chart|Billboard200|1|artist=Taylor Swift|album=1989|access-date=January 1, 2025|rowheader=true}}</syntaxhighlight>
| Year-end single chart =
<syntaxhighlight lang="wikitext">{{Year-end single chart|Billboardhot100|1|year=2024|access-date=January 1, 2025|rowheader=true}}</syntaxhighlight>
| Year-end album chart =
<syntaxhighlight lang="wikitext">{{Year-end album chart|Billboard200|1|year=2024|access-date=January 1, 2025|rowheader=true}}</syntaxhighlight>
}}
Produces:
{| class="wikitable"
|-
{{#switch: {{ROOTPAGENAME}}
| Single chart = {{Single chart|Australia|1|artist=Example|song=Example|rowheader=true}}
| Album chart = {{Album chart|Australia|1|artist=Example|album=Example|rowheader=true}}
| Year-end single chart = {{Year-end single chart|Australia|1|year=2024|rowheader=true}}
| Year-end album chart = {{Year-end album chart|Australia|1|year=2024|rowheader=true}}
}}
|}
<references />

''' Reference naming '''

References are auto-named in format <code>{{#switch: {{ROOTPAGENAME}} | Single chart = sc | Album chart = ac | Year-end single chart | Year-end album chart = ye }}_{ChartID}_{{#switch: {{ROOTPAGENAME}} | Single chart | Album chart = {artist} | Year-end single chart | Year-end album chart = {year} }}</code>. To reuse:
{{#switch: {{ROOTPAGENAME}}
| Single chart = <syntaxhighlight lang="wikitext">...some fact.<ref name="sc_Australia_Beyoncé"/></syntaxhighlight>
| Album chart = <syntaxhighlight lang="wikitext">...some fact.<ref name="ac_Billboard200_Taylor Swift"/></syntaxhighlight>
| Year-end single chart = <syntaxhighlight lang="wikitext">...some fact.<ref name="ye_Australia_2024"/></syntaxhighlight>
| Year-end album chart = <syntaxhighlight lang="wikitext">...some fact.<ref name="ye_Billboard200_2024"/></syntaxhighlight>
}}

Override with <code>refname=customname</code>. Note: if <code>refname</code> contains spaces, you must use quotes: <code><nowiki><ref name="custom name"/></nowiki></code>.

== Parameters ==
{| class="wikitable"
! Parameter !! Description
|-
| <code>1</code> || '''Required.''' Chart identifier. Must match one of the [[#Supported charts|supported charts]]. Often named as country (e.g., <code>Australia</code>) or specific chart (e.g., <code>Billboardhot100</code>). Some charts have aliases producing identical results.
|-
| <code>2</code> || '''Required.''' {{#ifeq: {{#invoke:String|sub|{{ROOTPAGENAME}}|1|8}} | Year-end | Year-end | Peak }} position. If {{#switch: {{ROOTPAGENAME}} | Single chart | Year-end single chart = song | Album chart | Year-end album chart = album }} hasn't charted, use en-dash (–), not hyphen (-). Usually better to omit the template entirely.
{{#ifeq: {{#invoke:String|sub|{{ROOTPAGENAME}}|1|8}} | Year-end |
{{!}}-
{{!}} <code>year</code> {{!}}{{!}} '''Required.''' Four-digit year of the chart.
{{!}}-
{{!}} <code>artist</code> {{!}}{{!}} Artist name. Used for some charts and for default reference naming.
{{!}}-
{{!}} <code>{{#ifeq: {{ROOTPAGENAME}} | Year-end album chart | album | song }}</code> {{!}}{{!}} {{#ifeq: {{ROOTPAGENAME}} | Year-end album chart | Album | Song }} title. Used for some charts.
|
{{!}}-
{{!}} <code>artist</code> {{!}}{{!}} Artist name as listed on chart. Odd spellings (e.g., Ke$ha) and stylizations can be tricky. German charts typically require <code>lastname,firstname</code> format. Always preview the resulting URL. Also used for default reference naming.
{{!}}-
{{!}} <code>{{#switch: {{ROOTPAGENAME}} | Single chart = song | Album chart = album }}</code> {{!}}{{!}} {{#switch: {{ROOTPAGENAME}} | Single chart = Song | Album chart = Album }} title. Made-up words, slang, tricky punctuation can produce bad URLs — always preview.
{{!}}-
{{!}} <code>artistid</code> {{!}}{{!}} Numeric artist identifier from chart website URL. Example: Madonna at officialcharts.com has URL <code>.../artist/28948/madonna/</code>, so <code>artistid=28948</code>.
{{!}}-
{{!}} <code>songid</code> {{!}}{{!}} Numeric {{#switch: {{ROOTPAGENAME}} | Single chart = song | Album chart = album | #default = song }} identifier from chart website URL. Example: "In My Mind" at tophit.com has URL <code>tophit.com/tracks/88003</code>, so <code>songid=88003</code>.
{{!}}-
{{!}} <code>chartid</code>, <code>id</code> {{!}}{{!}} Numeric chart/archive identifier from URL. Example: Poland ZPAV chart has URL <code>zpav.pl/rankingi/listy/nielsen/top5.php?lang=2&idlisty=532</code>, so <code>chartid=532</code>.
{{!}}-
{{!}} <code>year</code> {{!}}{{!}} Four-digit year indicating the year being reported by the chart. Used in combination with <code>week</code> for some charts.
{{!}}-
{{!}} <code>week</code> {{!}}{{!}} Week number (01–53) indicating the week being reported by the chart. Used in combination with <code>year</code>. Some charts require leading zero for weeks 01–09, others do not — always preview the resulting URL.
{{!}}-
{{!}} <code>date</code> {{!}}{{!}} Date of the chart in the format YYYYMMDD or another format specified, indicating year (Y), month (M) and day (D). Used solely to create the reference URL, not displayed in references. For display date, use <code>publish-date</code>.
{{!}}-
{{!}} <code>url</code> {{!}}{{!}} User-provided URL for charts without automatic indexing. Some charts validate URL for required domain.
}}
|-
| <code>publish-date</code> || Publication date of the chart (free-format, for display in reference). Not the same as <code>date</code> which is used for URL construction.
|-
| <code>access-date</code> || Date when source was verified by editor.
|-
| <code>archive-url</code> || URL of archived version of the source.
|-
| <code>archive-date</code> || Date when the source was archived.
|-
| <code>rowheader</code> || Set to <code>true</code> to output chart name as row header per [[MOS:DTAB]]. Should be true in most cases.
|-
| <code>refname</code> || Custom reference name. Default: <code>{{#switch: {{ROOTPAGENAME}} | Single chart = sc | Album chart = ac | Year-end single chart | Year-end album chart = ye }}_{Chart}_{{#switch: {{ROOTPAGENAME}} | Single chart | Album chart = {artist} | Year-end single chart | Year-end album chart = {year} }}</code>. Names with spaces require quotes in <code><nowiki><ref name="..."/></nowiki></code>.
|-
| <code>refgroup</code> || Reference group name.
|-
| <code>note</code> || Note displayed after chart name (e.g., <code>note=remix version</code>, <code>note=deluxe edition</code>). Useful for distinguishing versions or noting renamed charts.
|}

{{#switch: {{ROOTPAGENAME}}
| Single chart =
''' Chart-specific parameters '''
{{{!}} class="wikitable"
! Parameter !! Description
{{!}}-
{{!}} <code>page</code> {{!}}{{!}} Page number for book sources. Used only with AustraliaKent ({{tl|cite Kent}}).
{{!}}}
| Album chart =
''' Chart-specific parameters '''
{{{!}} class="wikitable"
! Parameter !! Description
{{!}}-
{{!}} <code>dvd</code> {{!}}{{!}} DVD title. For Music DVD charts, use instead of <code>album</code>.
{{!}}-
{{!}} <code>startdate</code>, <code>enddate</code> {{!}}{{!}} (''deprecated'') Date range for chart week. Used only in reference link text for FlandersMV, WalloniaMV, and ItalyMV.
{{!}}}
}}

== Examples ==
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. For more on table formatting, see [[WP:TAB]].

{{#switch: {{ROOTPAGENAME}}
| Single chart =
<syntaxhighlight lang="wikitext">{| class="wikitable sortable plainrowheaders"
|+Chart performance for "Example Song"
! scope="col"| Chart (2024)
! scope="col"| Peak<br>position
|-
{{Single chart|Australia|6|song=Example Song|artist=Example Artist|rowheader=true}}
|-
! scope="row"| [[Billboard Brasil|Brazil ''Billboard'' Hot 100]]<ref>"Brazil Hot 100". ''Billboard Brasil''. November 2024.</ref>
| style="text-align:center;"| 1
|-
{{Single chart|Hungary|5|year=2024|week=14|rowheader=true}}
|-
{{Single chart|Italy|3|artist=Example Artist|song=Example Song|note=remix version|rowheader=true}}
|-
{{Single chart|UK|3|date=20240115|rowheader=true}}
|}
</syntaxhighlight>

Expands into:

{{{!}} class="wikitable sortable plainrowheaders"
{{!}}+Chart performance for "Example Song"
! scope="col"{{!}} Chart (2024)
! scope="col"{{!}} Peak<br>position
{{!}}-
{{Single chart|Australia|6|song=Example Song|artist=Example Artist|rowheader=true}}
{{!}}-
! scope="row"{{!}} [[Billboard Brasil{{!}}Brazil ''Billboard'' Hot 100]]<ref>"Brazil Hot 100". ''Billboard Brasil''. November 2024.</ref>
{{!}} style="text-align:center;"{{!}} 1
{{!}}-
{{Single chart|Hungary|5|year=2024|week=14|rowheader=true}}
{{!}}-
{{Single chart|Italy|3|artist=Example Artist|song=Example Song|note=remix version|rowheader=true}}
{{!}}-
{{Single chart|UK|3|date=20240115|rowheader=true}}
{{!}}}
<references />

| Album chart =
<syntaxhighlight lang="wikitext">{| class="wikitable sortable plainrowheaders"
|+Chart performance for ''Example Album''
! scope="col"| Chart (2024)
! scope="col"| Peak<br>position
|-
{{Album chart|Australia|6|album=Example Album|artist=Example Artist|rowheader=true}}
|-
! scope="row"| [[Oricon|Japan Oricon Albums]]<ref>"Oricon Weekly Album Chart". ''Oricon''. January 2024.</ref>
| style="text-align:center;"| 1
|-
{{Album chart|Hungary|5|year=2024|week=14|rowheader=true}}
|-
{{Album chart|Italy|3|artist=Example Artist|album=Example Album|note=deluxe edition|rowheader=true}}
|-
{{Album chart|UK|3|artist=Example Artist|date=20240115|rowheader=true}}
|}
</syntaxhighlight>

Expands into:

{{{!}} class="wikitable sortable plainrowheaders"
{{!}}+Chart performance for ''Example Album''
! scope="col"{{!}} Chart (2024)
! scope="col"{{!}} Peak<br>position
{{!}}-
{{Album chart|Australia|6|album=Example Album|artist=Example Artist|rowheader=true}}
{{!}}-
! scope="row"{{!}} [[Oricon{{!}}Japan Oricon Albums]]<ref>"Oricon Weekly Album Chart". ''Oricon''. January 2024.</ref>
{{!}} style="text-align:center;"{{!}} 1
{{!}}-
{{Album chart|Hungary|5|year=2024|week=14|rowheader=true}}
{{!}}-
{{Album chart|Italy|3|artist=Example Artist|album=Example Album|note=deluxe edition|rowheader=true}}
{{!}}-
{{Album chart|UK|3|artist=Example Artist|date=20240115|rowheader=true}}
{{!}}}
<references />

| Year-end single chart =
<syntaxhighlight lang="wikitext">{| class="wikitable sortable plainrowheaders"
|+Year-end chart performance for "Example Song"
! scope="col"| Chart (2024)
! scope="col"| Position
|-
{{Year-end single chart|Australia|6|year=2024|rowheader=true}}
|-
! scope="row"| [[Billboard Brasil|Brazil ''Billboard'' Hot 100]]<ref>"Year-end Brazil Hot 100". ''Billboard Brasil''. December 2024.</ref>
| style="text-align:center;"| 1
|-
{{Year-end single chart|Italy|3|year=2024|note=combined versions|rowheader=true}}
|-
{{Year-end single chart|UK|3|year=2024|rowheader=true}}
|}
</syntaxhighlight>

Expands into:

{{{!}} class="wikitable sortable plainrowheaders"
{{!}}+Year-end chart performance for "Example Song"
! scope="col"{{!}} Chart (2024)
! scope="col"{{!}} Position
{{!}}-
{{Year-end single chart|Australia|6|year=2024|rowheader=true}}
{{!}}-
! scope="row"{{!}} [[Billboard Brasil{{!}}Brazil ''Billboard'' Hot 100]]<ref>"Year-end Brazil Hot 100". ''Billboard Brasil''. December 2024.</ref>
{{!}} style="text-align:center;"{{!}} 1
{{!}}-
{{Year-end single chart|Italy|3|year=2024|note=combined versions|rowheader=true}}
{{!}}-
{{Year-end single chart|UK|3|year=2024|rowheader=true}}
{{!}}}
<references />

| Year-end album chart =
<syntaxhighlight lang="wikitext">{| class="wikitable sortable plainrowheaders"
|+Year-end chart performance for ''Example Album''
! scope="col"| Chart (2024)
! scope="col"| Position
|-
{{Year-end album chart|Australia|6|year=2024|rowheader=true}}
|-
! scope="row"| [[Oricon|Japan Oricon Albums]]<ref>"Year-end Oricon Albums". ''Oricon''. December 2024.</ref>
| style="text-align:center;"| 1
|-
{{Year-end album chart|Italy|3|year=2024|note=deluxe edition|rowheader=true}}
|-
{{Year-end album chart|UK|3|year=2024|rowheader=true}}
|}
</syntaxhighlight>

Expands into:

{{{!}} class="wikitable sortable plainrowheaders"
{{!}}+Year-end chart performance for ''Example Album''
! scope="col"{{!}} Chart (2024)
! scope="col"{{!}} Position
{{!}}-
{{Year-end album chart|Australia|6|year=2024|rowheader=true}}
{{!}}-
! scope="row"{{!}} [[Oricon{{!}}Japan Oricon Albums]]<ref>"Year-end Oricon Albums". ''Oricon''. December 2024.</ref>
{{!}} style="text-align:center;"{{!}} 1
{{!}}-
{{Year-end album chart|Italy|3|year=2024|note=deluxe edition|rowheader=true}}
{{!}}-
{{Year-end album chart|UK|3|year=2024|rowheader=true}}
{{!}}}
<references />
}}

== Manual reference mode ==
Use when:
* {{#switch: {{ROOTPAGENAME}} | Single chart | Year-end single chart = Song | Album chart | Year-end album chart = Album }} name contains special characters producing URL errors
* Using alternative reliable source (''Billboard'' Chart Beat, Allmusic, etc.)

'''To activate manual referencing''', write <code>M</code> as the third parameter, after the chart identifier and position:
{| class="wikitable"
|+Template syntax for manual reference mode
! Full version (copy and paste text below and delete parameters you don't need)
|-
| {{#switch: {{ROOTPAGENAME}}
  | Single chart = :{{code|<nowiki>{{Single chart |(Chart identifier) |(Peak position) |M |url= |title= |work= |publisher= |location= |date= |archive-url= |archive-date= |url-status= |publish-date= |access-date= |refname= |refgroup= |rowheader= }}</nowiki>}}
  | Album chart = :{{code|<nowiki>{{Album chart |(Chart identifier) |(Peak position) |M |url= |title= |work= |publisher= |location= |date= |archive-url= |archive-date= |url-status= |publish-date= |access-date= |refname= |refgroup= |rowheader= }}</nowiki>}}
  | Year-end single chart = :{{code|<nowiki>{{Year-end single chart |(Chart identifier) |(Year-end position) |M |url= |title= |work= |publisher= |location= |date= |archive-url= |archive-date= |url-status= |publish-date= |access-date= |refname= |refgroup= |rowheader= }}</nowiki>}}
  | Year-end album chart = :{{code|<nowiki>{{Year-end album chart |(Chart identifier) |(Year-end position) |M |url= |title= |work= |publisher= |location= |date= |archive-url= |archive-date= |url-status= |publish-date= |access-date= |refname= |refgroup= |rowheader= }}</nowiki>}}
  }}
|}

When manual referencing is activated, you ''must'' provide <code>url</code> and <code>title</code>, and may additionally provide <code>work</code>, <code>publisher</code>, <code>location</code>, <code>date</code>, <code>archive-url</code>, <code>archive-date</code>, and <code>url-status</code>.

When <code>|3=M</code> is set, manual mode takes full priority — chart-specific parameters (<code>date</code>, <code>year</code>, <code>week</code>, etc.) are not used for URL construction. However, <code>artist</code> is still used for default reference naming{{#ifeq: {{#invoke:String|sub|{{ROOTPAGENAME}}|1|8}} | Year-end | , and <code>year</code> for year-end charts}}.

== Supported charts ==
Different charts require different parameters depending on their archive systems. Always preview the resulting URL before saving.

The table below is auto-generated from JSON data and lists all currently supported charts. New charts can be added to the JSON data, but avoid adding [[Wikipedia:Record charts#Deprecated charts|deprecated charts]]. For details on adding charts, see [[Module:Music chart|module documentation]]; a brief schema reference is at the top of [[Module:Music chart/single.json|single.json]].

{{#invoke:Music chart|showCharts
|type={{#switch: {{ROOTPAGENAME}}
  | Single chart = single
  | Album chart = album
  | Year-end single chart = year-end-single
  | Year-end album chart = year-end-album
}}
|notes=1
|splitdvd={{#ifeq:{{ROOTPAGENAME}}|Album chart|yes}}
}}

== Error handling ==
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 position claimed or even if the link is functional, but some parameter entries are checked for appropriateness.

=== Error messages ===
When a check determines that a required parameter is missing or invalid, an error message is generated in red. For example, if you forget the ''week'' or ''year'' value for the Hungary chart, the result will look like:

{| class="wikitable"
|-
{{#switch: {{ROOTPAGENAME}}
| Single chart = {{Single chart|Hungary|19}}
| Album chart = {{Album chart|Hungary|19}}
| Year-end single chart = {{Year-end single chart|Hungary|19}}
| Year-end album chart = {{Year-end album chart|Hungary|19}}
}}
|}
<references />

Common error messages: unknown chart, missing chart parameter, missing required parameters, invalid date format, manual mode missing url/title, URL validation failed.

=== Preview warnings ===
Shown in orange only in preview mode (not visible in saved article): unknown parameters, unused parameters, invalid date format in reference.

For example, if you provide a ''week'' parameter for a chart that doesn't use it, a warning like this appears in preview:

{| class="wikitable"
|-
| Australia ([[ARIA Charts|ARIA]])<ref>[https://australian-charts.com/showitem.asp?interpret=Example&titel=Example "Example – Example"]. [[ARIA Charts|ARIA Top 50 Singles]].</ref> <span style="color:orange;">WARNING: Unused parameters for "Australia": week.</span>
| style="text-align:center;" | 5
|}
<references />

This warning appears only when previewing — it will not be visible in the saved article, but indicates that the ''week'' parameter is ignored for this chart.

This is an incentive to [[Help:Show preview|preview]] the article page before saving your edits. Check both the chart table and the references section for error messages.

== Maintenance categories ==
=== Usage tracking ===
* {{Category link with count|{{#switch: {{ROOTPAGENAME}} | Single chart = Single | Album chart = Album | Year-end single chart = Year-end single | Year-end album chart = Year-end album }} chart usages}} – contains subcategories for each chart ID
* {{Category link with count|{{#switch: {{ROOTPAGENAME}} | Single chart = Single | Album chart = Album | Year-end single chart = Year-end single | Year-end album chart = Year-end album }} chart making named ref}} – template created a named reference
* {{Category link with count|{{#switch: {{ROOTPAGENAME}} | Single chart = Single | Album chart = Album | Year-end single chart = Year-end single | Year-end album chart = Year-end album }} chart used with defunct chart}} – chart marked as no longer active
* {{Category link with count|{{#switch: {{ROOTPAGENAME}} | Single chart = Single | Album chart = Album | Year-end single chart = Year-end single | Year-end album chart = Year-end album }} chart called without artist}} – artist parameter not provided
{{#switch: {{ROOTPAGENAME}}
| Single chart = * {{Category link with count|Single chart called without song}} – song parameter not provided
| Album chart = * {{Category link with count|Album chart called without album}} – album parameter not provided
}}
{{#ifeq: {{#invoke:String|sub|{{ROOTPAGENAME}}|1|8}} | Year-end ||
* {{Category link with count|{{#switch: {{ROOTPAGENAME}} | Single chart = Single | Album chart = Album }} chart using manual ref mode}} – manual reference mode (M) used
}}

=== Error tracking ===
* {{Category link with count|{{#switch: {{ROOTPAGENAME}} | Single chart = Single | Album chart = Album | Year-end single chart = Year-end single | Year-end album chart = Year-end album }} chart used with unknown chart}} – unrecognized chart ID
* {{Category link with count|{{#switch: {{ROOTPAGENAME}} | Single chart = Single | Album chart = Album | Year-end single chart = Year-end single | Year-end album chart = Year-end album }} chart used with missing parameters}} – required parameters not provided
* {{Category link with count|{{#switch: {{ROOTPAGENAME}} | Single chart = Single | Album chart = Album | Year-end single chart = Year-end single | Year-end album chart = Year-end album }} chart with invalid position}} – position is not a valid number (1–200) or dash
* {{Category link with count|Pages using {{#switch: {{ROOTPAGENAME}} | Single chart = single | Album chart = album | Year-end single chart = year-end single | Year-end album chart = year-end album }} chart with unknown parameters}} – unrecognized parameters used
* {{Category link with count|{{#switch: {{ROOTPAGENAME}} | Single chart = Single | Album chart = Album | Year-end single chart = Year-end single | Year-end album chart = Year-end album }} chart with unused parameters}} – parameters provided but not used by chart
* {{Category link with count|{{#switch: {{ROOTPAGENAME}} | Single chart = Single | Album chart = Album | Year-end single chart = Year-end single | Year-end album chart = Year-end album }} chart with unsubstituted parameters}} – raw <nowiki>{{{param}}}</nowiki> or <nowiki>{placeholder}</nowiki> detected, likely an issue in code, JSON, or helper
{{#ifeq: {{#invoke:String|sub|{{ROOTPAGENAME}}|1|8}} | Year-end ||
* {{Category link with count|Pages using {{#switch: {{ROOTPAGENAME}} | Single chart = single | Album chart = album }} chart with manual mode missing url or title}} – manual mode without required url/title
}}

== Template data ==
{{TemplateData header}}
<templatedata>
{
	"description": "Creates a table row for a music chart with reference",
	"params": {
		"1": {
			"label": "Chart",
			"description": "Chart identifier. Must match one of the supported charts (e.g., Australia, Billboardhot100)",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "Position",
			"description": "Peak or year-end position on the chart. Use en-dash (–) if not charted",
			"type": "number",
			"required": true
		},
		"3": {
			"label": "Manual mode",
			"description": "Set to M for manual reference mode (requires url and title)",
			"type": "string"
		},
		"artist": {
			"label": "Artist",
			"description": "Artist name as listed on chart. German charts typically require lastname,firstname format. Used for URL construction and default reference naming",
			"type": "string",
			"suggested": true
		},
		"song": {
			"label": "Song",
			"description": "Song title as listed on chart (single charts only)",
			"type": "string"
		},
		"album": {
			"label": "Album",
			"description": "Album title as listed on chart (album charts only)",
			"type": "string"
		},
		"dvd": {
			"label": "DVD",
			"description": "DVD title for Music DVD charts. Use instead of album parameter",
			"type": "string"
		},
		"year": {
			"label": "Year",
			"description": "Four-digit year. Required for year-end charts; used with week parameter for some weekly charts",
			"type": "number"
		},
		"week": {
			"label": "Week",
			"description": "Week number 01–53. Some charts require leading zero, others do not",
			"type": "string"
		},
		"date": {
			"label": "Date",
			"description": "Chart date for URL construction. Format varies by chart (YYYYMMDD, YYYY-MM-DD, etc.). Not displayed in reference",
			"type": "string"
		},
		"artistid": {
			"label": "Artist ID",
			"description": "Numeric artist identifier from chart website URL",
			"type": "number"
		},
		"songid": {
			"label": "Song ID",
			"description": "Numeric song/album identifier from chart website URL",
			"type": "number"
		},
		"chartid": {
			"label": "Chart ID",
			"description": "Numeric chart/archive identifier from URL",
			"type": "number"
		},
		"id": {
			"label": "ID",
			"description": "Alias for chartid",
			"type": "number"
		},
		"url": {
			"label": "URL",
			"description": "User-provided URL for charts without automatic indexing, or for manual mode",
			"type": "url"
		},
		"title": {
			"label": "Title",
			"description": "Source title (required for manual mode)",
			"type": "string"
		},
		"work": {
			"label": "Work",
			"description": "Publication name (manual mode only)",
			"type": "string"
		},
		"publisher": {
			"label": "Publisher",
			"description": "Publisher name (manual mode only)",
			"type": "string"
		},
		"location": {
			"label": "Location",
			"description": "Publication location (manual mode only)",
			"type": "string"
		},
		"page": {
			"label": "Page",
			"description": "Page number for book sources. Used only with AustraliaKent",
			"type": "number"
		},
		"startdate": {
			"label": "Start date",
			"description": "Chart week start date. Used only for FlandersMV, WalloniaMV, ItalyMV",
			"type": "string",
			"deprecated": "Only used in URL title text, redundant"
		},
		"enddate": {
			"label": "End date",
			"description": "Chart week end date. Used only for FlandersMV, WalloniaMV, ItalyMV",
			"type": "string",
			"deprecated": "Only used in URL title text, redundant"
		},
		"publish-date": {
			"label": "Publish date",
			"description": "Chart publication date for display in reference. Used for year-end charts",
			"type": "date",
			"aliases": [
				"publishdate"
			]
		},
		"access-date": {
			"label": "Access date",
			"description": "Date when source was verified by editor",
			"type": "date",
			"suggested": true,
			"aliases": [
				"accessdate"
			]
		},
		"archive-url": {
			"label": "Archive URL",
			"description": "URL of archived version of the source",
			"type": "url",
			"aliases": [
				"archiveurl"
			]
		},
		"archive-date": {
			"label": "Archive date",
			"description": "Date when the source was archived",
			"type": "date",
			"aliases": [
				"archivedate"
			]
		},
		"url-status": {
			"label": "URL status",
			"description": "Status of the URL: live or dead (manual mode only)",
			"type": "string"
		},
		"refname": {
			"label": "Ref name",
			"description": "Custom reference name. Default format: sc_Chart_artist or year-end_Chart_year",
			"type": "string"
		},
		"refgroup": {
			"label": "Ref group",
			"description": "Reference group name",
			"type": "string"
		},
		"rowheader": {
			"label": "Row header",
			"description": "Set to true to output chart name as row header (recommended for accessibility)",
			"type": "boolean",
			"default": "false",
			"suggested": true
		},
		"note": {
			"label": "Note",
			"description": "Note displayed after chart name (e.g., remix version, deluxe edition, then called X)",
			"type": "string"
		}
	},
	"paramOrder": [
		"1",
		"2",
		"3",
		"artist",
		"song",
		"album",
		"dvd",
		"artistid",
		"songid",
		"chartid",
		"id",
		"year",
		"week",
		"date",
		"startdate",
		"enddate",
		"url",
		"title",
		"work",
		"publisher",
		"location",
		"page",
		"publish-date",
		"access-date",
		"archive-url",
		"archive-date",
		"url-status",
		"refname",
		"refgroup",
		"rowheader",
		"note"
	],
	"format": "inline"
}
</templatedata>

== See also ==
* {{tl|Single chart}}, {{tl|Album chart}} — weekly charts
* {{tl|Year-end single chart}}, {{tl|Year-end album chart}} — year-end charts
* [[Module:Music chart]] — module documentation

<includeonly>{{Sandbox other||
[[Category:Templates that generate named references]]
[[Category:Record chart templates]]
}}</includeonly>
</noinclude>