Difference between revisions of "Template:Extra album cover/doc"

From blackwiki
Jump to navigation Jump to search
imported>George Ho
(→‎TemplateData: fix typo)
imported>Zackmann08
(removing support for deprecated params. All uses have been converted.)
Line 5: Line 5:
  
 
'''Important''': When using this template, please ensure you comply with the [[WP:NFCC|non-free content criteria]]. This includes not using multiple non-free images when one would suffice.
 
'''Important''': When using this template, please ensure you comply with the [[WP:NFCC|non-free content criteria]]. This includes not using multiple non-free images when one would suffice.
 
If this template is substituted, it will return a cleaned-up copy of itself (see [[Wikipedia:Substitution trick]]) with unnecessary parameters removed and deprecated parameters replaced. Parameter indentation will also automatically be fixed.
 
  
 
====Infobox album====
 
====Infobox album====
Line 14: Line 12:
 
<pre style="overflow:auto">{{Infobox album
 
<pre style="overflow:auto">{{Infobox album
 
...
 
...
| misc    = {{subst:Extra album cover
+
| misc    = {{Extra album cover
 
  | header  =  
 
  | header  =  
 
  | type    = studio
 
  | type    = studio
Line 30: Line 28:
 
<pre style="overflow:auto">{{Infobox single
 
<pre style="overflow:auto">{{Infobox single
 
...
 
...
| misc          = {{subst:Extra album cover
+
| misc          = {{Extra album cover
 
  | header  =  
 
  | header  =  
 
  | type    = single
 
  | type    = single
Line 46: Line 44:
 
"params": {
 
"params": {
 
"header": {
 
"header": {
"aliases": [
 
"upper_caption",
 
"Upper caption"
 
],
 
 
"label": "Header",
 
"label": "Header",
 
"description": "text for top of image",
 
"description": "text for top of image",
Line 57: Line 51:
 
},
 
},
 
"type": {
 
"type": {
"aliases": [
 
"Type"
 
],
 
 
"label": "Type",
 
"label": "Type",
 
"description": "sets the header color",
 
"description": "sets the header color",
Line 68: Line 59:
 
"cover": {
 
"cover": {
 
"aliases": [
 
"aliases": [
"Cover",
 
 
"image"
 
"image"
 
],
 
],
Line 78: Line 68:
 
},
 
},
 
"cover_size": {
 
"cover_size": {
"aliases": [
 
"cover size",
 
"Cover size"
 
],
 
 
"label": "Cover size",
 
"label": "Cover size",
 
"description": "specifies the image size"
 
"description": "specifies the image size"
 
},
 
},
 
"alt": {
 
"alt": {
"aliases": [
 
"Alt"
 
],
 
 
"label": "Alt",
 
"label": "Alt",
 
"description": "alternative text for the visually impaired",
 
"description": "alternative text for the visually impaired",
Line 94: Line 77:
 
},
 
},
 
"border": {
 
"border": {
"aliases": [
 
"Border"
 
],
 
 
"label": "Border",
 
"label": "Border",
 
"description": "type \"yes\" to add a 1px border to the image",
 
"description": "type \"yes\" to add a 1px border to the image",
Line 102: Line 82:
 
},
 
},
 
"caption": {
 
"caption": {
"aliases": [
 
"Caption",
 
"lower_caption",
 
"Lower caption"
 
],
 
 
"label": "Caption",
 
"label": "Caption",
 
"description": "adds a caption beneath the image",
 
"description": "adds a caption beneath the image",

Revision as of 20:31, 13 November 2018

Usage

Important: When using this template, please ensure you comply with the non-free content criteria. This includes not using multiple non-free images when one would suffice.

Infobox album

For use with {{Infobox album}}; use this template in |misc= like this:

{{Infobox album
...
| misc    = {{Extra album cover
 | header  = 
 | type    = studio
 | cover   = 
 | border  = <!-- optional parameter, type "yes" here to add a 1px border to the cover image -->
 | alt     = 
 | caption = 
}}
}}

Other values for |type= are at Template:Infobox album/color.

Infobox single

For use with {{Infobox single}}; use this template in |misc= like this:

{{Infobox single
...
| misc          = {{Extra album cover
 | header  = 
 | type    = single
 | cover   = 
 | border  = <!-- optional parameter, type "yes" here to add a 1px border to the cover image -->
 | alt     = 
 | caption = 
}}
}}

TemplateData

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 album cover

For use with {{Infobox album}}, {{Infobox song}}, or {{Infobox single}} – adds an extra album cover or image

Template parameters

ParameterDescriptionTypeStatus
Headerheader

text for top of image

Example
Alternative cover
Stringsuggested
Typetype

sets the header color

Example
song, single, for albums see types in {{Infobox album/color}}
Stringsuggested
Covercover image

the file name for the cover

Example
XXX.jpg (without File:)
Filerequired
Cover sizecover_size

specifies the image size

Unknownoptional
Altalt

alternative text for the visually impaired

Stringoptional
Borderborder

type "yes" to add a 1px border to the image

Stringoptional
Captioncaption

adds a caption beneath the image

Example
Later American release
Stringoptional