Difference between revisions of "Template:BillboardURLbyName/doc"
imported>MSGJ m (→Usage) |
imported>Vanisaac m (→See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[</nowiki>[[Wikipedia:Wikidata]]<nowiki>]]) --> | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[</nowiki>[[Wikipedia:Wikidata]]<nowiki>]]) --> | ||
| − | |||
| − | |||
| − | + | This template returns a billboard.com URL for an artist's history on a particular chart. | |
| − | + | == Examples == | |
| + | {{Aligned table |cols=3 |class=wikitable | ||
| + | | '''Code''' | '''Output''' | '''Comments''' | ||
| + | | {{tlc|BillboardURLbyName|artist{{=}}Carly Rae Jepsen|chart{{=}}Hot 100}} | {{BillboardURLbyName|artist=Carly Rae Jepsen|chart=Hot 100}} | | ||
| + | | {{tlc|BillboardURLbyName|artist{{=}}Carly Rae Jepsen|chart{{=}}Top Album Sales}} | {{BillboardURLbyName|artist=Carly Rae Jepsen|chart=Top Album Sales}} | | ||
| + | | {{tlc|BillboardURLbyName|artist{{=}}carly rae jepsen|chart{{=}}top album sales}} | {{BillboardURLbyName|artist=carly rae jepsen|chart=top album sales}} | Equivalent to above. Artist and chart are case insensitive. | ||
| + | | {{tlc|BillboardURLbyName|artist{{=}}Carly Rae Jepsen|chart{{=}}all}} | {{BillboardURLbyName|artist=Carly Rae Jepsen|chart=all}} | <code>chart{{=}}all</code> links to Billboard's "main" chart for the given artist (in this case, the Hot 100). | ||
| + | | {{tlc|BillboardURLbyName|artist{{=}}Carly Rae Jepsen}} | {{BillboardURLbyName|artist=Carly Rae Jepsen}} | Billboard's landing page for this artist, including their chart history, and recent news and videos relating to the artist. Content at this URL is liable to drift over time. Not recommended. | ||
| + | }} | ||
| − | + | == Usage == | |
| − | + | This template is normally used within citations, e.g. | |
| − | + | {{Markup | |
| + | |<nowiki>It reached no. 2 on the Billboard Modern Rock Tracks chart.<ref>{{cite web | url={{BillboardURLbyName|artist=the breeders|chart=alternative songs}} | title=The Breeders Chart History | accessdate=2007-07-31 | work=[[Billboard (magazine)|Billboard]]}}</ref></nowiki> | ||
| + | |It reached no. 2 on the Billboard Alternative Songs chart.<ref>{{cite web | url={{BillboardURLbyName|artist=the breeders|chart=alternative songs}} | title=The Breeders Chart History | accessdate=2007-07-31 | work=[[Billboard (magazine)|Billboard]]}}</ref> | ||
| + | }} | ||
| − | + | {{reflist}} | |
| − | |||
| − | {{ | + | == Notes == |
| + | |||
| + | The artist name used by Billboard may not match Wikipedia's naming. Be especially mindful of artists whose names contain special characters. For example, an article about a song by [[Pink (singer)|P!nk]] needs to use {{tlx|BillboardURLbyName|artist{{=}}pnk|chart{{=}}Hot 100}} to match Billboard's url scheme. Billboard is also inconsistent about the use of a leading "The" in a band's name. For this reason, it's usually a good idea to test any urls generated by this template before adding them to an article. | ||
| − | == | + | ==TemplateData== |
| − | + | <templatedata> | |
| + | { | ||
| + | "description": "Generates billboard.com URLs for the chart history of a given artist.", | ||
| + | "params": { | ||
| + | "artist": { | ||
| + | "label": "Artist name", | ||
| + | "description": "The name of the artist, as it appears in billboard.com URLs", | ||
| + | "type": "string", | ||
| + | "required": true, | ||
| + | "example": "The White Stripes" | ||
| + | }, | ||
| + | "chart": { | ||
| + | "label": "Chart name", | ||
| + | "description": "The name of the Billboard chart", | ||
| + | "example": "Digital Albums", | ||
| + | "type": "string", | ||
| + | "suggested": true | ||
| + | }, | ||
| + | "bio": { | ||
| + | "description": "Deprecated. No effect.", | ||
| + | "type": "string", | ||
| + | "deprecated": true | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </templatedata> | ||
| − | |||
== See also == | == See also == | ||
| − | <includeonly>{{ | + | <includeonly>{{Sandbox other|| |
<!-- Categories below this line, please; interwikis at Wikidata --> | <!-- Categories below this line, please; interwikis at Wikidata --> | ||
{{DEFAULTSORT:Billboardurlbyname}} | {{DEFAULTSORT:Billboardurlbyname}} | ||
Latest revision as of 23:57, 23 April 2020
| This is a documentation subpage for Template:BillboardURLbyName. It contains usage information, categories and other content that is not part of the original template page. |
This template returns a billboard.com URL for an artist's history on a particular chart.
Contents
Examples
Script error: No such module "aligned table".
Usage
This template is normally used within citations, e.g.
| Markup | Renders as |
|---|---|
It reached no. 2 on the Billboard Modern Rock Tracks chart.<ref>{{cite web | url={{BillboardURLbyName|artist=the breeders|chart=alternative songs}} | title=The Breeders Chart History | accessdate=2007-07-31 | work=[[Billboard (magazine)|Billboard]]}}</ref>
|
It reached no. 2 on the Billboard Alternative Songs chart.[1] |
- ↑ "The Breeders Chart History". Billboard. Retrieved 2007-07-31.
Notes
The artist name used by Billboard may not match Wikipedia's naming. Be especially mindful of artists whose names contain special characters. For example, an article about a song by P!nk needs to use {{BillboardURLbyName|artist=pnk|chart=Hot 100}} to match Billboard's url scheme. Billboard is also inconsistent about the use of a leading "The" in a band's name. For this reason, it's usually a good idea to test any urls generated by this template before adding them to an article.
TemplateData
Generates billboard.com URLs for the chart history of a given artist.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Artist name | artist | The name of the artist, as it appears in billboard.com URLs
| String | required |
| Chart name | chart | The name of the Billboard chart
| String | suggested |
| Bio | bio | Deprecated. No effect. | String | deprecated |