User:Razr Nation/DVDchart/doc
This is a documentation subpage for User:Razr Nation/DVDchart. It may contain usage information, categories and other content that is not part of the original user template page. |
This template is used to cite sources in Wikipedia. It is specifically for Music DVDs. A similar template for use when citing sources for musical singles can be found at Template:Singlechart, and a similar template for music albums can be found at Template:Albumchart; however, for EPs or other releases, it has not yet been developed.
Usage
[edit]Following, the most common parameters used on the template:
{{User:Hahc21/DVDchart|(Chart identifier)|(Peak position)|artist=|album=|dvd=|year=|date=|refname=|accessdate=31 May 2012}}
Fields
[edit]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 identifier) (or first parameter, without name): Chart identifier. Must be one of the options listed under Chart ID in the tables. 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 DVD 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.
- album: Title of the DVD. 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.
- dvd: Title of the DVD. Some charts need to be provided with this field instead of the album field to correctly work.
- artist: Name of the album's performer. As for the album 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 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.
- id: Numeric identifier used by some chart listings (see below). 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.
- 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 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 DVD, e.g.,
note=2-disc deluxe edition
, or{{User:Hahc21/DVDchart|Australia|1|dvd=Live at Wembley|artist=Beyoncé|archiveurl=http://www.webcitation.org/Gfht978y|note=2-disc deluxe edition}}
. - 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 ac_Chartid_artist) will be used. A reference with a name can be reused for claims elsewhere in the article. Optional parameter.
- refgroup: Enables you to specify a name for the reference group. Optional parameter.
Supports
[edit]Chart ID | Output | Website used as archive | Req. | Notes |
---|---|---|---|---|
AustraliaMV | Australian DVD Albums (ARIA) | www.ariacharts.com.au | artist dvd archiveurl archivedate |
This ID needs the chart to be archived to secure future verifiability. That means, it must be used archiving the url [1] with either WebCite or any other archiving method. Then, providing the parameters needed on the template. On archiveurl the WebCite url must be written, and on url the original given above. |
AustriaMV | Austrian Music DVD (Ö3 Austria) | www.austriancharts.at | date year |
This ID return a weekly top 10. For that reason, the date and year paramenters are mandatory. date must be in this format:YYYYMMDD. |
FlandersMV | Belgian Music DVD (Ultratop Flanders) | www.ultratop.be | artist album dvd |
Don't forget to check as some albums have the [DVD] tag after the name (example: The Reel Me [DVD]). If that happens, use the dvd parameter instead of the album parameter. |
WalloniaMV | Belgian Music DVD (Ultratop Wallonia) | www.ultratop.be | artist album dvd |
Don't forget to check as some albums have the [DVD] tag after the name (example: The Reel Me [DVD]). If that happens, use the dvd parameter instead of the album parameter. |
ItalyMV | Italian Music DVD (FIMI) | www.fimi.it | year month id |
The month parameter must be in numbers. As an example, February must be written as 02, or June as 06. the id parameter can be found searching on the Achive before selecting the year and the month: http://www.fimi.it/classifiche_search_dvd.php. |
NetherlandsMV | Dutch Music DVD (MegaCharts) | www.dutchcharts.nl | artist album dvd |
Don't forget to check as some albums have the [DVD] tag after the name (example: The Reel Me [DVD]). If that happens, use the dvd parameter instead of the album parameter. |
SpainMV | Spanish Music DVD (PROMUSICAE) | www.promusicae.es | year week |
The year parameter must contain only the last two numbers of the year. As an example, if the year is 2011, then only "11" must be written on the parameter. The week parameter mjst be in numbers. Example: 06. |
UKMV | UK Music Video DVD (Official Charts Company) | www.officialcharts.com | artist date |
Music Video DVD albums archive from 2009 onwards. The date parameter must be provided in the way YYYY-MM-DD, which is the issue date that can be found on the arhives of the OCC. |
Examples with table layout
[edit]Example with dummy data
[edit]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 are examlpes table with its corresponding output:
{| class="wikitable sortable" border="1" |- ! Chart ! Peak<br/>position |- | row 1, cell 1 | row 1, cell 2 |- | row 2, cell 1 | row 2, cell 2 |- {{User:Hahc21/DVDchart|Flanders|1|artist=Jennifer Lopez|album=The Reel Me|accessdate=31 May 2012}} |- {{User:Hahc21/DVDchart|Wallonia|1|artist=Jennifer Lopez|album=The Reel Me|accessdate=31 May 2012}} |} {{reflist}}
Expands into:
Chart | Peak position |
---|---|
row 1, cell 1 | row 1, cell 2 |
row 2, cell 1 | row 2, cell 2 |
Illegal chart entered Flanders | 1 |
Illegal chart entered Wallonia | 1 |
Maintenance categories
[edit]To help maintain music articles, this template will automatically categorize articles that call it based on the parameters used in the reference.
DVDchart category
[edit]Category:DVDchart contains all articles that make use of the template.
See also
[edit]- {{Singlechart}} — counterpart of DVDchart but for chart positions for single releases.
- {{Albumchart}} — counterpart of DVDchart and Singlechart but for chart positions for music album releases.
This user page employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, or your user space before changing anything here. |