Template:Infobox song/doc: Difference between revisions

added parameter names example
m (1 revision imported)
(added parameter names example)
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}}
{{Music infobox header}}
{{Music infobox header}}
{{Auto short description}}
{{Lua|Module:Infobox|Module:InfoboxImage|Module:String|Module:Check for unknown parameters}}
{{Lua|Module:Infobox|Module:InfoboxImage|Module:String|Module:Check for unknown parameters}}


Line 53: Line 55:


== Code ==
== Code ==
{{Parameter names example |name | cover | cover_size | cover_upright | alt | border | caption | type | artist | album | EP | language | English_title | A-side | B-side | written | published | released | recorded | studio | venue | genre | length | label | writer | composer | lyricist | producer | chronology | prev_title | prev_title2 | prev_year | title | title2 | year | next_title | next_title2 | next_year | tracks | misc | original_artist | from_album | __µ}}
The first template code below includes the most commonly used infobox parameters.  If there is no information in the article to support the field, leave it blank.  Remove the <code><nowiki><!--</nowiki></code> and <code><nowiki>--></nowiki></code> to use the {{tl|Start date}} and {{tl|Duration}} subtemplates.   
The first template code below includes the most commonly used infobox parameters.  If there is no information in the article to support the field, leave it blank.  Remove the <code><nowiki><!--</nowiki></code> and <code><nowiki>--></nowiki></code> to use the {{tl|Start date}} and {{tl|Duration}} subtemplates.   


Line 62: Line 66:
| name          =  
| name          =  
| cover        = <!--just the file name-->
| cover        = <!--just the file name-->
| alt          =
| type          =  
| type          =  
| artist        =  
| artist        =  
Line 135: Line 140:


===type===
===type===
Specify "single", "instrumental", "composition", "promo", etc., as shown in the code table below.  The entry will be automatically linked to the corresponding article, so only the unlinked code is needed (the default is "song"). If an album track was later released as a single, '''use the most notable or best known'''. For example, "[[Stairway to Heaven]]" was released as a promo single in several markets and as a digital single in 2007, but became best known as a song from Led Zeppelin's fourth album. This field is used to generate the header and color; please note that it is not used for genre, which is described in the {{para|genre}} fields.
Specify "single", "instrumental", "composition", "promo", etc., as shown in the code table below.  The entry will be automatically linked to the corresponding article, so only the unlinked code is needed (the default is "song"). This field is used to generate the header and color; please note that it is not used for genre, which is described in the {{para|genre}} fields.
 
A song that is called a "single" by sources, even if the song was not released as part of a single, may be classified as a "single".
 
If an album track was later released as a single, '''use the most notable or best known'''. For example, "[[Stairway to Heaven]]" was released as a promo single in several markets and as a digital single in 2007, but became best known as a song from Led Zeppelin's fourth album.  
{{left|{{Infobox song/doc/type|color=Color|link=Link}}}}
{{left|{{Infobox song/doc/type|color=Color|link=Link}}}}
{{clear}}
{{clear}}
Line 167: Line 176:


===released===
===released===
Indicate the commercial release date, whether it is a single, album, or other.  Enter the date using {{tl|Start date}}.  For example, use <code><nowiki>{{Start date|YYYY|MM|DD}}</nowiki></code> for the complete date, <code><nowiki>{{Start date|YYYY|MM}}</nowiki></code> if only year and month are known, or <code><nowiki>{{Start date|YYYY}}</nowiki></code> for just a year.  For multiple entries, see Notes{{r|plainlist}} for details. Generally, later releases or in secondary markets, reissues, on compilations, etc., should only be included in the body of the article.   
Indicate the commercial release date, whether it is a single, album, or other.  Usually, this is the date that it became widely available to the public, such as in retail. Dates for leaked copies, advance or limited promo releases to radio stations, etc., generally are not used, but may be included in an appropriate section of the main body if noteworthy. For example, album tracks that receive airplay should use the album release date, rather than when they were added to radio. If the same song is later released as an actual single and that becomes the best known (and {{para|type|single}} is used), indicate the date the single was released.  Enter the date using {{tl|Start date}}.  For example, use <code><nowiki>{{Start date|YYYY|MM|DD}}</nowiki></code> for the complete date, <code><nowiki>{{Start date|YYYY|MM}}</nowiki></code> if only year and month are known, or <code><nowiki>{{Start date|YYYY}}</nowiki></code> for just a year.  For multiple entries, see Notes{{r|plainlist}} for details. Generally, later releases or in secondary markets, reissues, on compilations, etc., should only be included in the body of the article.   


===<del>format</del>===
===<del>format</del>===
The format parameter has been removed as a result of the July–August 2020 talk page discussion. Any information entered in {{para|format}} will not be displayed.
The format parameter has been removed as a result of [[Template talk:Infobox song/Archive 8#Format section|a 2020 discussion]]. Any information entered in {{para|format}} will not be displayed.


===recorded===
===recorded===
Line 176: Line 185:


===studio===
===studio===
If the song was recorded in a '''recording studio''', enter the name and location. Link the studio, but not well-known cities, states, or countries (see [[WP:OVERLINK]]). Remove "Studios" if it appears in the name – use <nowiki>[[Sound City Studios|Sound City]]</nowiki> rather than <nowiki>[[Sound City Studios]]</nowiki>.  For multiple entries, see Notes{{r|flatlist}} for details. For "United States" and "United Kingdom", it is preferred that they be abbreviated "U.S." and "UK", but political subdivisions should never be (never "MA" for "Massachusetts", "ON" for "Ontario", etc.). See Notes{{r|location}} for details.
If the song was recorded in a '''recording studio''', enter the name and location. Link the studio, but not well-known cities, states, or countries (see [[WP:OVERLINK]]). Remove "Studios" if it appears in the name – use <nowiki>[[Sound City Studios|Sound City]]</nowiki> rather than <nowiki>[[Sound City Studios]]</nowiki>.  For multiple entries, see Notes{{r|plainlist}} for details. For "United States" and "United Kingdom", it is preferred that they be abbreviated "U.S." and "UK", but political subdivisions should never be (never "MA" for "Massachusetts", "ON" for "Ontario", etc.). See Notes{{r|location}} for details.


===venue===
===venue===
Line 182: Line 191:


===genre===
===genre===
The field should include the music genre(s) that best describes the song. It should come from a [[WP:RS|reliable source]] and also '''be stated and referenced''' in the body of the article; personal opinions or [[WP:original research|original research]] must be not be included. Note that most genres are not proper nouns and should not be capitalized.  However, the first word in a list of multiple genres should be capitalized.  For multiple entries, see Notes{{r|flatlist}} for details.
The field should include the music genre(s) that best describes the song. It should come from a [[WP:RS|reliable source]] and also '''be stated and referenced''' in the body of the article; personal opinions or [[WP:original research|original research]] must not be included. Note that most genres are not proper nouns and should not be capitalized.  However, the first word in a list of multiple genres should be capitalized.  For multiple entries, see Notes{{r|flatlist}} for details.


===length===
===length===
Line 250: Line 259:
| writer  = The Artist
| writer  = The Artist
| producer = The Producer
| producer = The Producer
| tracks  = {{Rumours tracks}}
| tracks  = {{Astral Weeks track listing}}
}}
}}


If a separate album track listing sub-template has been created, it may be added to the {{para|tracks}} of the infobox. Using such a template may be more convenient for multi-disc albums or those with many tracks. A header with the album name will be automatically generated, along with the number of tracks. The song title will not be linked, but will appear in <strong>bold</strong>.
If a separate album track listing sub-template has been created, it may be added to the {{para|tracks}} of the infobox. Using such a template may be more convenient for multi-disc albums or those with many tracks. A header with the album name will be automatically generated, along with the number of tracks. The song title will not be linked, but will appear in <strong>bold</strong>.


The example to the right uses {{tl|Rumours tracks}} to demonstrate. To see its use in actual song infobox, click on the song links. Please note, if a singles chronology is also used in the infobox ({{para|prev_title}}, etc.), {{tl|Extra track listing}} must be used in the {{para|misc}} field (refer to that [[Template:Extra track listing#Usage]] for the code and explanation).
The example to the right uses {{tl|Astral Weeks track listing}} to demonstrate. To see its use in actual song infobox, click on the song links. Please note, if a singles chronology is also used in the infobox ({{para|prev_title}}, etc.), {{tl|Extra track listing}} must be used in the {{para|misc}} field (refer to that [[Template:Extra track listing#Usage]] for the code and explanation).
{{clear}}
{{clear}}


Line 397: Line 406:
<ref name="quotes">If any details besides the actual song title (country, etc.) are added, quote marks need to be added manually to the song title. Additionally, for {{para|A-side}} and {{para|B-side}}, quote marks need to be added for each title if there is more than one.
<ref name="quotes">If any details besides the actual song title (country, etc.) are added, quote marks need to be added manually to the song title. Additionally, for {{para|A-side}} and {{para|B-side}}, quote marks need to be added for each title if there is more than one.
</ref>
</ref>
<ref name="plainlist"> For multiple entries, this parameter uses <code>class=plainlist</code>. Format the items as a normal bulleted list; don't use other list templates or <nowiki><br/></nowiki>. For example:<pre>
<ref name="plainlist"> For multiple entries, format the items as a normal bulleted list; don't use other list templates or <nowiki><br/></nowiki>. For example:<pre>
| studio =
| studio =
*First item
*First item
Line 407: Line 416:
|}
|}
</ref>
</ref>
<ref name="flatlist">For short horizontal lists of two or three items, comma separators are acceptable, but for longer lists the use of the <code>class=hlist</code> is preferred as it offers a benefit to users of screen readers (see [[Wikipedia:Accessibility]] for more information on [[Web Content Accessibility Guidelines]]). To use it, format the items as a normal bulleted list; don't use other list templates or <nowiki><br/></nowiki>. For example:<pre>
<ref name="flatlist">For short horizontal lists of two or three items, comma separators are acceptable, but for longer lists, format the items as a normal bulleted list; don't use other list templates or <nowiki><br/></nowiki>. For example:<pre>
| genre =
| genre =
*Item one
*Item one
Line 431: Line 440:
[[Category:Templates that add a tracking category]]
[[Category:Templates that add a tracking category]]
}}
}}
==Short description==
This template generates an automatic short description of the form {{tq|YYYY [type] by [artist]}} under certain conditions, when it appears once in an article in the lead, {{para|artist}} is defined, and {{property|P577}} is defined on Wikidata. A manually entered short description will override the automatic one. If an article can generate a satisfactory automatic description, any preexisting manual description may be deleted.


==TemplateData==
==TemplateData==
Line 439: Line 451:
"params": {
"params": {
"name": {
"name": {
"aliases": [
"Name",
"title"
],
"label": "Name",
"label": "Name",
"description": "The name or title of the song.",
"description": "The name or title of the song.",
Line 450: Line 458:
},
},
"cover": {
"cover": {
"aliases": [
"Cover",
"image"
],
"label": "Cover",
"label": "Cover",
"description": "An appropriate image, such as a sheet music or single picture sleeve cover.",
"description": "An appropriate image, such as a sheet music or single picture sleeve cover.",
"example": "A file name, without the File: <NAME.jpg>",
"example": "A file name, without the File: <NAME.jpg>",
"type": "string"
"type": "wiki-file-name",
"aliases": [
"image"
]
},
},
"cover_size": {
"cover_size": {
"aliases": [
"Cover size",
"cover size"
],
"label": "Cover_size",
"label": "Cover_size",
"type": "string"
"type": "number",
"deprecated": "Cover_upright should be used if needed"
},
},
"alt": {
"alt": {
"aliases": [
"Alt"
],
"label": "Alt",
"label": "Alt",
"description": "Alternative text for the cover image, to describe it to visually impaired readers.",
"description": "Alternative text for the cover image, to describe it to visually impaired readers.",
"type": "string"
"type": "line"
},
},
"border": {
"border": {
"aliases": [
"Border"
],
"label": "Border",
"label": "Border",
"description": "Set to yes to put a 1 pixel border around the image.",
"description": "Set to yes to put a 1 pixel border around the image.",
"type": "string"
"type": "line",
"autovalue": "yes",
"suggestedvalues": [
"yes"
]
},
},
"caption": {
"caption": {
"aliases": [
"Caption"
],
"label": "Caption",
"label": "Caption",
"description": "Caption for the image; this will overwrite automatically generated <\"Song\" cover> when a file is added to the \"caption\" field",
"description": "Caption for the image; this will overwrite automatically generated <\"Song\" cover> when a file is added to the \"caption\" field",
"example": "Sheet music cover, 1920.",
"example": "Sheet music cover, 1920.",
"type": "string"
"type": "string"
},
"comment": {
"aliases": [
"Comment"
],
"label": "Comment",
"type": "string",
"deprecated": "This parameter is no longer used."
},
},
"type": {
"type": {
"aliases": [
"Type"
],
"label": "Type",
"label": "Type",
"description": "Specify \"song\", \"single\", \"Instrumental\", \"Composition\", etc. This generates the header and color.",
"description": "Specify \"song\", \"single\", \"Instrumental\", \"Composition\", etc. This generates the header and color.",
"type": "string",
"type": "line",
"suggested": true
"suggested": true,
"suggestedvalues": [
"single",
"song",
"promo",
"demo",
"remix single",
"instrumental",
"composition",
"hymn",
"nursery"
]
},
},
"artist": {
"artist": {
"aliases": [
"Artist",
"original_artist"
],
"label": "Artist",
"label": "Artist",
"description": "The name of the artist.",
"description": "The name of the artist.",
Line 520: Line 515:
},
},
"album": {
"album": {
"aliases": [
"Album",
"from_album",
"from Album"
],
"label": "Album",
"label": "Album",
"description": "The name of the album on which the song originally appeared.",
"description": "The name of the album on which the song originally appeared.",
Line 535: Line 525:
},
},
"English_title": {
"English_title": {
"aliases": [
"english_title"
],
"label": "English title",
"label": "English title",
"description": "The English translation of the name of the song, if it is in another language.",
"description": "The English translation of the name of the song, if it is in another language.",
"type": "string"
"type": "line"
},
},
"written": {
"written": {
"aliases": [
"label": "Written (date)",
"Written"
],
"label": "Written",
"description": "The date the song was written; this is usually used for songs created before music publishing or recording",
"description": "The date the song was written; this is usually used for songs created before music publishing or recording",
"type": "string"
"type": "date"
},
},
"published": {
"published": {
"aliases": [
"label": "Published (date)",
"Published"
],
"label": "Published",
"description": "The date the song was published; this is usually used for songs created before the rise of music recording",
"description": "The date the song was published; this is usually used for songs created before the rise of music recording",
"type": "string"
"type": "date"
},
},
"released": {
"released": {
"aliases": [
"label": "Released (date)",
"Released"
],
"label": "Released",
"description": "For recorded music: The earliest known date of commercial release, using a single occurrence, using {{Start date}}. For April 1, 2015, enter {{Start date|2015|04|01}}.",
"description": "For recorded music: The earliest known date of commercial release, using a single occurrence, using {{Start date}}. For April 1, 2015, enter {{Start date|2015|04|01}}.",
"type": "string"
"type": "date"
},
"format": {
"aliases": [
"Format"
],
"label": "Format",
"type": "string",
"deprecated": "No longer used."
},
},
"A-side": {
"A-side": {
"aliases": [
"a-side"
],
"label": "A-side",
"label": "A-side",
"description": "For singles: the name of A-side of the current or title single.",
"description": "For singles: the name of A-side of the current or title single.",
Line 583: Line 550:
},
},
"B-side": {
"B-side": {
"aliases": [
"b-side"
],
"label": "B-side",
"label": "B-side",
"description": "For singles: the name of the B-side of the current or title single. Only one of the fields 'A-side' or 'B-side' should be used.",
"description": "For singles: the name of the B-side of the current or title single. Only one of the fields 'A-side' or 'B-side' should be used.",
Line 591: Line 555:
},
},
"recorded": {
"recorded": {
"aliases": [
"label": "Recorded (date)",
"Recorded"
],
"label": "Recorded",
"description": "The date(s) the song was recorded.",
"description": "The date(s) the song was recorded.",
"type": "string"
"type": "date"
},
},
"venue": {
"venue": {
"aliases": [
"Venue"
],
"label": "Venue",
"label": "Venue",
"description": "For live recordings, include the name of the venue (concert hall, stadium, etc.) and location.",
"description": "For live recordings, include the name of the venue (concert hall, stadium, etc.) and location.",
Line 607: Line 565:
},
},
"studio": {
"studio": {
"aliases": [
"Studio"
],
"label": "Studio",
"label": "Studio",
"description": "If the song was recorded in a recording studio, enter the name and location.",
"description": "If the song was recorded in a recording studio, enter the name and location.",
Line 615: Line 570:
},
},
"genre": {
"genre": {
"aliases": [
"Genre"
],
"label": "Genre",
"label": "Genre",
"description": "The genre(s) that best describes the song. This must not be original research, and should be stated and referenced in the article.",
"description": "The genre(s) that best describes the song. This must not be original research, and should be stated and referenced in the article.",
Line 624: Line 576:
},
},
"length": {
"length": {
"aliases": [
"Length"
],
"label": "Length",
"label": "Length",
"description": "The length of the song, using {{Duration}}. To display 3 minutes 45 seconds as 3:45, enter {{Duration|m=3|s=45}}.",
"description": "The length of the song, using {{Duration}}. To display 3 minutes 45 seconds as 3:45, enter {{Duration|m=3|s=45}}.",
Line 632: Line 581:
},
},
"label": {
"label": {
"aliases": [
"Label"
],
"label": "Label",
"label": "Label",
"description": "The record company label which originally released the recording.  Releases in other territories, different formats, reissues, etc., should be included in the body of the article, not in this field.",
"description": "The record company label which originally released the recording.  Releases in other territories, different formats, reissues, etc., should be included in the body of the article, not in this field.",
Line 640: Line 586:
},
},
"writer": {
"writer": {
"aliases": [
"Writer",
"songwriter",
"Songwriter"
],
"label": "Songwriter/Writer",
"label": "Songwriter/Writer",
"description": "The name of the person(s) credited with writing both the music and lyrics for the song. Where a separate lyricist and composer have been clearly identified by a reliable source, use the \"composer\" and \"lyricist\" fields instead.",
"description": "The name of the person(s) credited with writing both the music and lyrics for the song. Where a separate lyricist and composer have been clearly identified by a reliable source, use the \"composer\" and \"lyricist\" fields instead.",
"type": "string",
"type": "string"
"suggested": true
},
},
"composer": {
"composer": {
"aliases": [
"Composer"
],
"label": "Composer",
"label": "Composer",
"description": "The name of the person(s) who composed the song's music, if different than the lyricist. If not differentiated in the article, use the \"songwriter/writer\" field instead.",
"description": "The name of the person(s) who composed the song's music, if different than the lyricist. If not differentiated in the article, use the \"songwriter/writer\" field instead.",
Line 659: Line 596:
},
},
"lyricist": {
"lyricist": {
"aliases": [
"Lyricist"
],
"label": "Lyricist",
"label": "Lyricist",
"description": "The person(s) who wrote the lyrics, if different than the song's composer. If not differentiated in the article, use the \"songwiter/writer\" field instead.",
"description": "The person(s) who wrote the lyrics, if different than the song's composer. If not differentiated in the article, use the \"songwriter/writer\" field instead.",
"type": "string"
"type": "string"
},
},
"language": {
"language": {
"aliases": [
"Language"
],
"label": "Language",
"label": "Language",
"description": "Only if the song is not in English, indicate the language.",
"description": "Only if the song is not in English, indicate the language.",
Line 675: Line 606:
},
},
"producer": {
"producer": {
"aliases": [
"Producer"
],
"label": "Producer",
"label": "Producer",
"description": "The person(s) who is credited with the record production.",
"description": "The person(s) who is credited with the record production.",
Line 683: Line 611:
},
},
"chronology": {
"chronology": {
"aliases": [
"label": "Chronology (artist)",
"Chronology"
"description": "For singles: Replacement of artist's name for the chronology section.",
],
"type": "string"
"label": "Chronology",
"description": "For singles: Header for the chronology section.",
"type": "string",
"default": "(Artist name) singles chronology"
},
},
"prev_title": {
"prev_title": {
Line 737: Line 661:
},
},
"tracks": {
"tracks": {
"aliases": [
"Tracks"
],
"label": "Tracks",
"label": "Tracks",
"description": "To add a full-album track listing.",
"description": "To add a full-album track listing.",
"type": "string"
"type": "string"
},
},
"prev_track": {
"misc": {
"label": "Prev_track",
"label": "Misc",
"type": "string",
"description": "To add extra subtemplates, such as {{Extra chronology}}, {{Extra track listing}}, {{Extra album cover}}, {{Audio sample}}, etc.",
"deprecated": "No longer used."
"type": "string"
},
},
"track_no": {
"cover_upright": {
"label": "Track_no",
"label": "Cover_upright",
"type": "number",
"type": "number"
"deprecated": "No longer used."
},
"next_track": {
"label": "Next_track",
"type": "string",
"deprecated": "No longer used."
},
"ISWC": {
"label": "ISWC",
"type": "string",
"deprecated": "No longer used."
},
"prev": {
"label": "Prev",
"type": "string",
"deprecated": "No longer used."
},
},
"prev_no": {
"original_artist": {
"label": "Prev_no",
"deprecated": true
"type": "number",
"deprecated": "No longer used."
},
},
"next": {
"from_album": {
"label": "Next",
"deprecated": true
"type": "string",
"deprecated": "No longer used."
},
"next_no": {
"label": "Next_no",
"type": "number",
"deprecated": "No longer used."
},
},
"misc": {
"__µ": {
"aliases": [
"deprecated": true
"Misc"
],
"label": "Misc",
"description": "To add extra subtemplates, such as {{Extra chronology}}, {{Extra track listing}}, {{Extra album cover}}, {{Audio sample}}, etc.",
"type": "string"
}
}
},
},
Line 798: Line 689:
"cover",
"cover",
"cover_size",
"cover_size",
"cover_upright",
"alt",
"alt",
"border",
"border",
Line 833: Line 725:
"next_year",
"next_year",
"tracks",
"tracks",
"prev_track",
"track_no",
"next_track",
"misc",
"misc",
"ISWC",
"original_artist",
"comment",
"from_album",
"prev",
"__µ"
"prev_no",
],
"next",
"format": "{{_\n| _____________ = _\n}}\n"
"next_no",
"format"
]
}
}
</templatedata>
</templatedata>
Line 850: Line 736:


== Tracking categories ==  
== Tracking categories ==  
* {{clc|Pages using infobox song with deprecated parameters}}
* {{clc|Pages using infobox song with unknown parameters}}
* {{clc|Pages using infobox song with unknown parameters}}
* {{clc|Infobox song with A-side or B-side quote formatting fix needed}}
* {{clc|Song articles with missing songwriters}}
* {{clc|Song articles with missing songwriters}}
* {{clc|Song articles with both composer and songwriter}}
* {{clc|Song articles with both composer and songwriter}}
Anonymous user