Difference between revisions of "Template:Extra chronology/doc"

From blackwiki
Jump to navigation Jump to search
imported>Ojorojo
(updated)
imported>Jc86035
m (TemplateData)
Line 5: Line 5:
  
 
Extra chronologies may be added to {{tl|Infobox album}} and {{tl|Infobox single}}, depending on which version of this template is used.  Both add the proper header, color, and formatting (depending on the {{para|type}} designation) and are added to the infoboxes in the {{para|misc}} field.
 
Extra chronologies may be added to {{tl|Infobox album}} and {{tl|Infobox single}}, depending on which version of this template is used.  Both add the proper header, color, and formatting (depending on the {{para|type}} designation) and are added to the infoboxes in the {{para|misc}} field.
 +
 +
If this template is substituted, it will return a cleaned-up copy of itself with unnecessary parameters removed and deprecated parameters replaced.
  
 
==Infobox album version==
 
==Infobox album version==
 
{{infobox|title=Albums and EPs|data1={{parameter names example|artist|type=studio|prev_title|prev_year|title|year|next_title|next_year}}}}
 
{{infobox|title=Albums and EPs|data1={{parameter names example|artist|type=studio|prev_title|prev_year|title|year|next_title|next_year}}}}
The album version provides the previous, current, and next albums and the years of their release. The titles appear in italics, with the current title also in bold.
+
The album version provides the previous, current, and next albums and the years of their release. The titles appear in italics, with the current title also in bold. Extra formatting does not usually need to be added.
  
 
;Code :
 
;Code :
 
<pre>{{Infobox album
 
<pre>{{Infobox album
 
...
 
...
| misc        = {{Extra chronology
+
| misc        = {{subst:Extra chronology
 
  | artist    =  
 
  | artist    =  
 
  | type      =  
 
  | type      =  
Line 37: Line 39:
 
==Infobox single version==
 
==Infobox single version==
 
{{infobox|title=Singles|data1={{parameter names example|artist|type=single|prev_title|prev_year|title|year|next_title|next_year}}}}
 
{{infobox|title=Singles|data1={{parameter names example|artist|type=single|prev_title|prev_year|title|year|next_title|next_year}}}}
In addition to providing the previous, current, and next singles and the years of their release, the single version allows two song titles to be entered.  This is useful for [[double A-side]] singles, such as "[[Ruby Tuesday (song)|Ruby Tuesday]]"/"[[Let's Spend the Night Together]]". The titles appear in quotes, with the current title also in bold.
+
In addition to providing the previous, current, and next singles and the years of their release, the single version allows two song titles to be entered.  This is useful for [[double A-side]] singles, such as "[[Ruby Tuesday (song)|Ruby Tuesday]]"/"[[Let's Spend the Night Together]]". The titles appear in quotes, with the current title also in bold. Extra formatting does not usually need to be added.
  
 
;Code :
 
;Code :
 
<pre>{{Infobox single
 
<pre>{{Infobox single
 
...
 
...
| misc        = {{Extra chronology
+
| misc        = {{subst:Extra chronology
 
  | artist      =  
 
  | artist      =  
 
  | type        =  
 
  | type        =  
Line 86: Line 88:
 
],
 
],
 
"type": "string",
 
"type": "string",
"description": "To specify single or a type of album. Valid values are: single, studio, demo, ep, live, greatest, remix, box, compilation, mixtape, soundtrack, film, cast, video, other"
+
"description": "To specify single or a type of album. Valid values are: single, studio, demo, ep, live, greatest, remix, box, compilation, mixtape, soundtrack, film, cast, video, other",
 +
"suggested": true
 
},
 
},
 
"artist": {
 
"artist": {
Line 95: Line 98:
 
],
 
],
 
"type": "string",
 
"type": "string",
"description": "The name of the recording artist"
+
"description": "The name of the recording artist",
 +
"suggested": true
 
},
 
},
 
"prev_title": {
 
"prev_title": {
 
"required": false,
 
"required": false,
"label": "Prev title",
+
"label": "Previous title",
 
"type": "string",
 
"type": "string",
"description": "The title of the artist's previous release"
+
"description": "The title of the artist's previous release. Add a link if an article exists",
 +
"example": "[[Help! (song)|Help!]]",
 +
"suggested": true
 
},
 
},
 
"prev_year": {
 
"prev_year": {
 
"required": false,
 
"required": false,
"label": "Prev year",
+
"label": "Previous year",
"type": "number",
+
"type": "date",
"description": "The year that the previous work was released"
+
"description": "The year that the previous work was released",
 +
"example": "1965",
 +
"suggested": true
 
},
 
},
 
"title": {
 
"title": {
Line 113: Line 121:
 
"label": "Title",
 
"label": "Title",
 
"type": "string",
 
"type": "string",
"description": "The title of the current work"
+
"description": "The title of the current release. No formatting required. For double A-sides only, if this is the other side add a wikilink if an article exists",
 +
"example": "All Star",
 +
"suggested": true
 
},
 
},
 
"year": {
 
"year": {
"required": false,
+
"required": true,
 
"label": "Year",
 
"label": "Year",
"type": "number",
+
"type": "date",
"description": "The year that the current work was released"
+
"description": "The year that the current work was released",
 +
"example": "2001",
 +
"suggested": true
 
},
 
},
 
"next_title": {
 
"next_title": {
Line 125: Line 137:
 
"label": "Next title",
 
"label": "Next title",
 
"type": "string",
 
"type": "string",
"description": "The title of the following work"
+
"description": "The title of the artist's following release. Add a link if an article exists",
 +
"example": "[[My Neck, My Back (Lick It)]]",
 +
"suggested": true
 
},
 
},
 
"next_year": {
 
"next_year": {
 
"required": false,
 
"required": false,
 
"label": "Next year",
 
"label": "Next year",
"type": "number",
+
"type": "date",
"description": "The year the following work was released"
+
"description": "The year the following work was released",
 +
"example": "2002"
 
},
 
},
 
"last_single": {
 
"last_single": {
Line 165: Line 180:
 
"type": "string",
 
"type": "string",
 
"deprecated": "Replace with separate «next_title» and «next_year» parameters."
 
"deprecated": "Replace with separate «next_title» and «next_year» parameters."
 +
},
 +
"prev_title2": {
 +
"label": "Previous title (2)",
 +
"description": "The second title of the artist's previous release, for double A-sides only. Add a link if an article exists",
 +
"example": "[[Day Tripper]]",
 +
"type": "string"
 +
},
 +
"title2": {
 +
"label": "Title (2)",
 +
"description": "The second title of the current release, for double A-sides only. If this is the other side then add a link if an article exists",
 +
"example": "[[Strawberry Fields Forever]]",
 +
"type": "string"
 +
},
 +
"next_title2": {
 +
"label": "Next title (2)",
 +
"description": "The second title of the artist's following release, for double A-sides only. Add a link if an article exists",
 +
"example": "[[Kids with Guns]]",
 +
"type": "string"
 
}
 
}
 
},
 
},
"description": "For use with {{Infobox album}} or {{Infobox single}} – adds an extra chronology range",
+
"description": "For use with {{Infobox album}} or {{Infobox single}} – adds an extra chronology range. If there are deprecated parameters, substitute the template and it will clean itself up.",
 
"paramOrder": [
 
"paramOrder": [
 
"type",
 
"type",
 
"artist",
 
"artist",
 
"prev_title",
 
"prev_title",
 +
"prev_title2",
 
"prev_year",
 
"prev_year",
 
"title",
 
"title",
 +
"title2",
 
"year",
 
"year",
 
"next_title",
 
"next_title",
 +
"next_title2",
 
"next_year",
 
"next_year",
 
"last_single",
 
"last_single",

Revision as of 06:10, 18 May 2017

Usage

Extra chronologies may be added to {{Infobox album}} and {{Infobox single}}, depending on which version of this template is used. Both add the proper header, color, and formatting (depending on the |type= designation) and are added to the infoboxes in the |misc= field.

If this template is substituted, it will return a cleaned-up copy of itself with unnecessary parameters removed and deprecated parameters replaced.

Infobox album version

Albums and EPs
Template:Parameter names example

The album version provides the previous, current, and next albums and the years of their release. The titles appear in italics, with the current title also in bold. Extra formatting does not usually need to be added.

Code 
{{Infobox album
...
| misc        = {{subst:Extra chronology
 | artist     = 
 | type       = 
 | prev_title = 
 | prev_year  = 
 | title      = 
 | year       = 
 | next_title = 
 | next_year  = 
 }}
}}
artist 
The name of the artist, with live album, EP, etc., appended to produce either "Artist live album chronology", "Artist EP chronology", etc. If just the artist's name is used, the header will display "Artist chronology".
type 
Specify studio, live, compilation, etc., as detailed in {{Infobox album/doc/type}} – this triggers the header color and formatting.
prev_title 
Enter the name of the previous album. If it has a WP article, add a link.
prev_year 
The year the previous album was released.
title 
Enter the name of the current or article title. This should not be wikilinked, since it should be the subject of the article.
year 
The year the current album was released.
next_title 
Enter the name of the next album and link as appropriate.
next_year 
The year the next album was released.
Notes 
All parameters are optional except |title= and |type=. Horizontal lines replace the header row if you omit |artist=.

Infobox single version

Singles
Template:Parameter names example

In addition to providing the previous, current, and next singles and the years of their release, the single version allows two song titles to be entered. This is useful for double A-side singles, such as "Ruby Tuesday"/"Let's Spend the Night Together". The titles appear in quotes, with the current title also in bold. Extra formatting does not usually need to be added.

Code 
{{Infobox single
...
| misc         = {{subst:Extra chronology
 | artist      = 
 | type        = 
 | prev_title  = 
 | prev_title2 = 
 | prev_year   = 
 | title       = 
 | title2      = 
 | year        = 
 | next_title  = 
 | next_title2 = 
 | next_year   = 
 }}
}}
artist 
Enter the name of the artist to produce "Artist chronology". Adding singles, American, etc., after "Artist" will display "Artist singles chronology", "Artist American chronology", etc.
type 
Specify single.
prev_title 
Enter the name of the previous single. If it has a WP article, add a link.
prev_title2 
Leave blank, unless the previous is a double A-side single. Then enter the name of the previous single second or flip side and link as appropriate.
prev_year 
The year the previous single was released.
title 
Enter the name of the current or article title. This should not be wikilinked, since it should be the subject of the article.
title2 
Leave blank, unless it is a double A-side single. Then enter the name of the second or flip side of current or article title.
year 
The year the current single was released.
next_title 
Enter the name of the next single. If it has a article, add a link.
next_title2 
Enter the name of the second or flip side of next single, if it is a double-A. Link as appropriate.
next_year 
The year the next single was released.
Notes 
All parameters are optional except |title= and |type=. Horizontal lines replace the header row if you omit |artist=.

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Extra chronology

For use with {{Infobox album}} or {{Infobox single}} – adds an extra chronology range. If there are deprecated parameters, substitute the template and it will clean itself up.

Template parameters

ParameterDescriptionTypeStatus
Typetype Type

To specify single or a type of album. Valid values are: single, studio, demo, ep, live, greatest, remix, box, compilation, mixtape, soundtrack, film, cast, video, other

Stringrequired
Artistartist Artist

The name of the recording artist

Stringsuggested
Previous titleprev_title

The title of the artist's previous release. Add a link if an article exists

Example
[[Help! (song)|Help!]]
Stringsuggested
Previous title (2)prev_title2

The second title of the artist's previous release, for double A-sides only. Add a link if an article exists

Example
[[Day Tripper]]
Stringoptional
Previous yearprev_year

The year that the previous work was released

Example
1965
Datesuggested
Titletitle

The title of the current release. No formatting required. For double A-sides only, if this is the other side add a wikilink if an article exists

Example
All Star
Stringrequired
Title (2)title2

The second title of the current release, for double A-sides only. If this is the other side then add a link if an article exists

Example
[[Strawberry Fields Forever]]
Stringoptional
Yearyear

The year that the current work was released

Example
2001
Daterequired
Next titlenext_title

The title of the artist's following release. Add a link if an article exists

Example
[[My Neck, My Back (Lick It)]]
Stringsuggested
Next title (2)next_title2

The second title of the artist's following release, for double A-sides only. Add a link if an article exists

Example
[[Kids with Guns]]
Stringoptional
Next yearnext_year

The year the following work was released

Example
2002
Dateoptional
lastlast_single Last single last_album Last album

previous in chronology

Stringdeprecated
thisthis_single This single this_album This album

this single or album in chronology

Stringdeprecated
nextnext_single Next single next_album Next album

next in chronology

Stringdeprecated