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

From blackwiki
Jump to navigation Jump to search
imported>Ojorojo
(partial update (more to come))
imported>Ojorojo
(updated)
Line 8: Line 8:
 
==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 their associated dates. 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.
  
 
;Code :
 
;Code :
Line 25: Line 25:
 
}}</pre>
 
}}</pre>
  
;artist : The name of the artist, with <code>album</code>, <code>EP</code>, etc., appended to produce either "Artist album chronology", "Artist EP chronology", etc.  If just the artist's name is used, the header will display "Artist chronology".
+
;artist : The name of the artist, with <code>live album</code>, <code>EP</code>, 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 <code>album</code>, <code>studio</code>, <code>live</code>, <code>compilation</code>, etc., as detailed in {{tl|Infobox album/doc/type}} – this triggers the header color and formatting.
+
;type : Specify <code>studio</code>, <code>live</code>, <code>compilation</code>, etc., as detailed in {{tl|Infobox album/doc/type}} – this triggers the header color and formatting.
;prev_title : Enter the name of the previous album. If it has an article, add a link.
+
;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.
 
;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.
 
;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.  
 
;year : The year the current album was released.  
;next_title : Enter the name of the next album. If it has a WP article, add a link.
+
;next_title : Enter the name of the next album and link as appropriate.
 
;next_year : The year the next album was released.
 
;next_year : The year the next album was released.
 
;Notes : All parameters are optional except {{para|title}} and {{para|type}}. Horizontal lines replace the header row if you omit {{para|artist}}.
 
;Notes : All parameters are optional except {{para|title}} and {{para|type}}. Horizontal lines replace the header row if you omit {{para|artist}}.
Line 37: Line 37:
 
==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.
  
 
;Code :
 
;Code :
Line 56: Line 57:
 
}}
 
}}
 
</pre>
 
</pre>
 +
 +
;artist : Enter the name of the artist to produce "Artist chronology".  Adding <code>singles</code>, <code>American</code>, etc., after "Artist" will display "Artist singles chronology", "Artist American chronology", etc.
 +
;type : Specify <code>single</code>.
 +
;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 {{para|title}} and {{para|type}}. Horizontal lines replace the header row if you omit {{para|artist}}.
  
 
{{clear}}
 
{{clear}}
 +
 
==Template data==
 
==Template data==
 
{{TemplateDataHeader}}
 
{{TemplateDataHeader}}
Line 71: Line 86:
 
],
 
],
 
"type": "string",
 
"type": "string",
"description": "The type of album/single. Valid values are: 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"
 
},
 
},
 
"artist": {
 
"artist": {

Revision as of 21:55, 17 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.

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.

Code 
{{Infobox album
...
| misc        = {{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.

Code 
{{Infobox single
...
| misc         = {{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

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

Stringoptional
Prev titleprev_title

The title of the artist's previous release

Stringoptional
Prev yearprev_year

The year that the previous work was released

Numberoptional
Titletitle

The title of the current work

Stringrequired
Yearyear

The year that the current work was released

Numberoptional
Next titlenext_title

The title of the following work

Stringoptional
Next yearnext_year

The year the following work was released

Numberoptional
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