Template:MastersEventInfobox/doc: Difference between revisions

From Bulbapedia, the community-driven Pokémon encyclopedia.
Jump to navigationJump to search
(documentation for {{MastersEventInfobox}})
 
(TemplateData)
 
(3 intermediate revisions by 2 users not shown)
Line 4: Line 4:
Infoboxes should be used at the beginning of the page, before any introductory text.
Infoboxes should be used at the beginning of the page, before any introductory text.


==Parameters==
===Parameters===
All parameters are case sensitive.
All parameters are case sensitive.
{| class="wikitable" style="background: #e5f1ec;"
{| class="wikitable" style="background: #e5f1ec;"
Line 19: Line 19:
| titlecolor
| titlecolor
| ''[[wp:Web colors#HTML color names|Color word]]'' • ''Hex code'' • ''[[Help:Color templates|Color template]]''
| ''[[wp:Web colors#HTML color names|Color word]]'' • ''Hex code'' • ''[[Help:Color templates|Color template]]''
| '''Optional'''. The text color for the title. Defaults to <code>Black</code>.
| '''Optional'''. The text color for the title. Defaults to <code>black</code>.
Include <code>#</code> when using Hex code or color template.
|-
|-
| name
| name
| ''String''
| ''String''
| Event name
| The English name of the event.
|-
|-
| jname
| jname
Line 39: Line 40:
| size
| size
| ''size''
| ''size''
| Image size.
| '''Optional'''. Image size. Defaults to <code>250px</code>.
|-
|-
| caption
| caption
Line 47: Line 48:
| textcolor
| textcolor
| ''[[wp:Web colors#HTML color names|Color word]]'' • ''Hex code'' • ''[[Help:Color templates|Color template]]''
| ''[[wp:Web colors#HTML color names|Color word]]'' • ''Hex code'' • ''[[Help:Color templates|Color template]]''
| '''Optional'''. The text color for the infobox. Defaults to <code>Black</code>.
| '''Optional'''. The text color for the row labels. Defaults to <code>black</code>.
Include <code>#</code> when using Hex code or color template.
|-
|-
| etype
| etype
Line 53: Line 55:
| The event type.
| The event type.
|-
|-
| stdt
| first
| ''String''
| ''String''
| The event start date.
| The dates for the event's first run.
|-
|-
| endt
| rerun
| ''String''
| ''String''
| The event end date
| '''Optional'''. The dates for reruns of the event. Separate multiple reruns with <code><nowiki><br/></nowiki></code>
|-
|-
| feat
| feat
| ''String''
| ''String''
| Sync pairs or skills featured in this event
| Sync pairs or theme skills featured in this event.
|-
|-
| featLabel
| featLabel
| ''String''
| ''String''
| '''Optional'''. Override for the "featured" row. Defaults to <code>sync pairs</code>.
| '''Optional'''. Override for the subject of the "featured" row. Defaults to <code>sync pairs</code>.
|-
|-
| bonus
| bonus
| <code>yes</code> • <code>no</code>
| <code>yes</code> • <code>no</code>
| '''Optional'''. Set to <code>no</code> (or blank string) to hide the bonuses during this event.
| '''Optional'''. Set to <code>no</code> (or blank string) if this event did not give reward or strength bonuses to any sync pairs.
Defaults to <code>yes</code> and thus will always show the header unless explicitly set to <code>no</code>.
Defaults to <code>yes</code> and thus will always show the bonuses section unless explicitly set to <code>no</code>.
|-
|-
| bon1
| bon1
| ''String''
| ''String''
| '''Optional'''. First reward bonus. Defaults to <code>1.6</code>
| '''Optional'''. First reward bonus multiplier. Defaults to <code>1.6</code>.
|-
|-
| spbon1
| spbon1
Line 84: Line 86:
| bon2
| bon2
| ''String''
| ''String''
| '''Optional'''. Second reward bonus. Defaults to <code>1.4</code>
| '''Optional'''. Second reward bonus multiplier. Defaults to <code>1.4</code>.
|-
|-
| spbon2
| spbon2
Line 92: Line 94:
| bon3
| bon3
| ''String''
| ''String''
| '''Optional'''. Third reward bonus. Defaults to <code>1.2</code>
| '''Optional'''. Third reward bonus multiplier. Defaults to <code>1.2</code>.
|-
|-
| spbon4
| spbon3
| ''String''
| ''String''
| '''Optional'''. Sync pairs that have the third reward bonus.
| '''Optional'''. Sync pairs that have the third reward bonus.
Line 106: Line 108:
| '''Optional'''. Theme skills with strength bonus in this event.
| '''Optional'''. Theme skills with strength bonus in this event.
|}
|}
===TemplateData===
<templatedata>
{
"params": {
"type": {
"label": "Type",
"description": "The base name of a color template.",
"type": "line",
"required": true
},
"titlecolor": {
"label": "Title Textcolor",
"description": "Optional. The text color for the title. \nInclude # when using Hex code or color template.",
"type": "line",
"suggestedvalues": [
"white",
"black"
],
"default": "black"
},
"name": {
"label": "Event name",
"description": "The English name of the event.",
"type": "line",
"required": true
},
"jname": {
"label": "Japanese name",
"description": "The Japanese name of the event, in Japanese script.",
"type": "line",
"required": true
},
"jtrans": {
"label": "Translated name",
"description": "The English translation of the event's Japanese name.",
"type": "line",
"required": true
},
"image": {
"label": "Image",
"description": "File name for the infobox image, with extension.",
"type": "wiki-file-name",
"required": true
},
"size": {
"label": "Image Size",
"description": "Optional. Image size.",
"default": "250px",
"suggested": true,
"type": "line"
},
"caption": {
"label": "Caption",
"description": "Image caption.",
"type": "line",
"required": true
},
"textcolor": {
"label": "Row label textcolor",
"description": "Optional. The text color for the row labels. \nInclude # when using Hex code or color template.",
"type": "line",
"suggestedvalues": [
"black",
"white"
],
"default": "black"
},
"etype": {
"label": "Event type",
"description": "The event type.",
"type": "line",
"required": true
},
"first": {
"label": "First run dates",
"description": "The dates for the event's first run.",
"type": "line",
"required": true
},
"rerun": {
"label": "Rerun dates",
"description": "Optional. The dates for reruns of the event. Separate multiple reruns with <br/>",
"type": "string",
"suggested": true
},
"featLabel": {
"label": "Featured Row Label",
"description": "Optional. Override for the subject of the \"featured\" row. ",
"type": "line",
"default": "sync pairs",
"suggested": true
},
"feat": {
"label": "Featured Pairs/Skills",
"description": "Sync pairs or theme skills featured in this event.",
"type": "string",
"required": true
},
"bonus": {
"label": "Bonuses",
"description": "Optional. Set to no (or blank string) if this event did not give reward or strength bonuses to any sync pairs.",
"type": "line",
"suggestedvalues": [
"no",
"yes"
],
"default": "yes",
"suggested": true
},
"spbon1": {
"label": "Bonus 1 Sync pairs",
"description": "Optional. Sync pairs that have the first reward bonus.",
"type": "line",
"suggested": true
},
"bon1": {
"label": "Bonus Multiplier 1",
"description": "Optional. First reward bonus multiplier.",
"type": "line",
"default": "1.6",
"suggested": true
},
"spbon2": {
"label": "Bonus 2 Sync pairs",
"description": "Optional. Sync pairs that have the second reward bonus.",
"type": "line",
"suggested": true
},
"bon2": {
"label": "Bonus Multiplier 2",
"description": "Optional. First reward bonus multiplier.",
"type": "line",
"default": "1.4",
"suggested": true
},
"spbon3": {
"label": "Bonus 3 Sync pairs",
"description": "Optional. Sync pairs that have the third reward bonus.",
"type": "line",
"suggested": true
},
"bon3": {
"label": "Bonus Multiplier 3",
"description": "Optional. First reward bonus multiplier.",
"type": "line",
"default": "1.2",
"suggested": true
},
"skillrbon": {
"label": "Reward Bonus theme skills",
"description": "Optional. Theme skills with reward bonus in this event.",
"type": "line",
"suggested": true
},
"skillsbon": {
"label": "Strength theme skills",
"description": "Optional. Theme skills with strength bonus in this event.",
"type": "line",
"suggested": true
},
"stdt": {
"label": "Start Dates",
"description": "The event start dates.",
"type": "string",
"deprecated": "Use <first> and <rerun>"
},
"endt": {
"label": "End Dates",
"description": "The event end dates.",
"type": "string",
"deprecated": "Use <first> and <rerun>"
}
},
"description": "{{MastersEventInfobox}} should be used as the infobox for events from Pokémon Masters EX. \nInfoboxes should be used at the beginning of the page, before any introductory text.",
"paramOrder": [
"type",
"titlecolor",
"name",
"jname",
"jtrans",
"image",
"size",
"caption",
"textcolor",
"etype",
"first",
"rerun",
"stdt",
"endt",
"feat",
"featLabel",
"bonus",
"bon1",
"spbon1",
"bon2",
"spbon2",
"bon3",
"spbon3",
"skillrbon",
"skillsbon"
],
"format": "block"
}
</templatedata>


==Examples==
==Examples==
Line 113: Line 320:
|name=Reach for the Top
|name=Reach for the Top
|jname=頂点へと翔ける者
|jname=頂点へと翔ける者
|jtrans=
|jtrans=The one who soars to the top
|image=Masters Reach for the Top.png
|image=Masters Reach for the Top.png
|size=250px
|size=250px
|caption=Event notification image
|caption=Event notification image
|etype=Story event
|etype=Story event
|stdt=September 3, 2019
|first=September 3, 2019 to September 30, 2019
|endt=September 30, 2019
|feat={{mas|Blue}} and {{p|Pidgeot}}
|feat={{mas|Blue}} and {{p|Pidgeot}}
|bonus=no
|bonus=no
Line 129: Line 335:
|name=Reach for the Top
|name=Reach for the Top
|jname=頂点へと翔ける者
|jname=頂点へと翔ける者
|jtrans=
|jtrans=The one who soars to the top
|image=Masters Reach for the Top.png
|image=Masters Reach for the Top.png
|size=250px
|size=250px
|caption=Event notification image
|caption=Event notification image
|etype=Story event
|etype=Story event
|stdt=September 3, 2019
|first=September 3, 2019 to September 30, 2019
|endt=September 30, 2019
|feat={{mas|Blue}} and {{p|Pidgeot}}
|feat={{mas|Blue}} and {{p|Pidgeot}}
|bonus=no
|bonus=no
Line 147: Line 352:
|name=Two Champions
|name=Two Champions
|jname=ふたりの王者
|jname=ふたりの王者
|jtrans=
|jtrans=Two Kings
|image=Masters Two Champions.png
|image=Masters Two Champions.png
|size=250px
|size=250px
|caption=Event notification image
|caption=Event notification image
|etype=Story event
|etype=Story event
|stdt=December 26, 2019<br>{{tt|May 25, 2021|second run}}
|first=December 26, 2019 to January 22, 2020
|endt=January 22, 2020<br>{{tt|June 8, 2021|second run}}
|rerun=May 25, 2021 to June 8, 2021
|feat={{mas|Lance}} and {{p|Dragonite}}<br>{{mas|Cynthia}} and {{p|Garchomp}}
|feat={{mas|Lance}} and {{p|Dragonite}}<br>{{mas|Cynthia}} and {{p|Garchomp}}
|spbon1={{tt|Lance and Dragonite<br>Cynthia and Garchomp|second run only}}
|spbon1=Lance and Dragonite (second run only)<br>Cynthia and Garchomp (second run only)
|spbon2={{tt|{{mas|Clair}} and {{p|Kingdra}}<br>{{mas|Rosa}} and {{p|Snivy}}/{{p|Servine}}/{{p|Serperior}}|second run only}}
|spbon2={{mas|Clair}} and {{p|Kingdra}} (second run only)<br>{{mas|Rosa}} and {{p|Snivy}}/{{p|Servine}}/{{p|Serperior}} (second run only)
|spbon3={{tt|Player character and {{p|Pikachu}}<br>Player character and {{p|Torchic}}|second run only}}
|spbon3=Player character and {{p|Pikachu}} (second run only)<br>Player character and {{p|Torchic}} (second run only)
}}
}}
<pre>
<pre>
Line 166: Line 371:
|name=Two Champions
|name=Two Champions
|jname=ふたりの王者
|jname=ふたりの王者
|jtrans=
|jtrans=Two Kings
|image=Masters Two Champions.png
|image=Masters Two Champions.png
|size=250px
|size=250px
|caption=Event notification image
|caption=Event notification image
|etype=Story event
|etype=Story event
|stdt=December 26, 2019<br>{{tt|May 25, 2021|second run}}
|first=December 26, 2019 to January 22, 2020
|endt=January 22, 2020<br>{{tt|June 8, 2021|second run}}
|rerun=May 25, 2021 to June 8, 2021
|feat={{mas|Lance}} and {{p|Dragonite}}<br>{{mas|Cynthia}} and {{p|Garchomp}}
|feat={{mas|Lance}} and {{p|Dragonite}}<br>{{mas|Cynthia}} and {{p|Garchomp}}
|spbon1={{tt|Lance and Dragonite<br>Cynthia and Garchomp|second run only}}
|spbon1=Lance and Dragonite (second run only)<br>Cynthia and Garchomp (second run only)
|spbon2={{tt|{{mas|Clair}} and {{p|Kingdra}}<br>{{mas|Rosa}} and {{p|Snivy}}/{{p|Servine}}/{{p|Serperior}}|second run only}}
|spbon2={{mas|Clair}} and {{p|Kingdra}} (second run only)<br>{{mas|Rosa}} and {{p|Snivy}}/{{p|Servine}}/{{p|Serperior}} (second run only)
|spbon3={{tt|Player character and {{p|Pikachu}}<br>Player character and {{p|Torchic}}|second run only}}
|spbon3=Player character and {{p|Pikachu}} (second run only)<br>Player character and {{p|Torchic}} (second run only)
}}
}}
</pre>
</pre>
<noinclude>[[Category:Documentation templates]]</noinclude>

Latest revision as of 07:33, 15 March 2024

{{MastersEventInfobox}} as the infobox for events from Pokémon Masters EX.

How to use

Infoboxes should be used at the beginning of the page, before any introductory text.

Parameters

All parameters are case sensitive.

Parameter Allowed values Notes
type Color template The base name of a color template.

Do not include color, color light, or color dark.

titlecolor Color wordHex codeColor template Optional. The text color for the title. Defaults to black.

Include # when using Hex code or color template.

name String The English name of the event.
jname String The Japanese name of the event, in Japanese script.
jtrans String The English translation of the event's Japanese name.
image Filename File name for the infobox image, with extension.
size size Optional. Image size. Defaults to 250px.
caption String Image caption.
textcolor Color wordHex codeColor template Optional. The text color for the row labels. Defaults to black.

Include # when using Hex code or color template.

etype String The event type.
first String The dates for the event's first run.
rerun String Optional. The dates for reruns of the event. Separate multiple reruns with <br/>
feat String Sync pairs or theme skills featured in this event.
featLabel String Optional. Override for the subject of the "featured" row. Defaults to sync pairs.
bonus yesno Optional. Set to no (or blank string) if this event did not give reward or strength bonuses to any sync pairs.

Defaults to yes and thus will always show the bonuses section unless explicitly set to no.

bon1 String Optional. First reward bonus multiplier. Defaults to 1.6.
spbon1 String Optional. Sync pairs that have the first reward bonus.
bon2 String Optional. Second reward bonus multiplier. Defaults to 1.4.
spbon2 String Optional. Sync pairs that have the second reward bonus.
bon3 String Optional. Third reward bonus multiplier. Defaults to 1.2.
spbon3 String Optional. Sync pairs that have the third reward bonus.
skillrbon String Optional. Theme skills with reward bonus in this event.
skillsbon String Optional. Theme skills with strength bonus in this event.

TemplateData

{{MastersEventInfobox}} should be used as the infobox for events from Pokémon Masters EX. Infoboxes should be used at the beginning of the page, before any introductory text.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Typetype

The base name of a color template.

Linerequired
Title Textcolortitlecolor

Optional. The text color for the title. Include # when using Hex code or color template.

Suggested values
white black
Default
black
Lineoptional
Event namename

The English name of the event.

Linerequired
Japanese namejname

The Japanese name of the event, in Japanese script.

Linerequired
Translated namejtrans

The English translation of the event's Japanese name.

Linerequired
Imageimage

File name for the infobox image, with extension.

Filerequired
Image Sizesize

Optional. Image size.

Default
250px
Linesuggested
Captioncaption

Image caption.

Linerequired
Row label textcolortextcolor

Optional. The text color for the row labels. Include # when using Hex code or color template.

Suggested values
black white
Default
black
Lineoptional
Event typeetype

The event type.

Linerequired
First run datesfirst

The dates for the event's first run.

Linerequired
Rerun datesrerun

Optional. The dates for reruns of the event. Separate multiple reruns with <br/>

Stringsuggested
Start Datesstdt

The event start dates.

Stringdeprecated
End Datesendt

The event end dates.

Stringdeprecated
Featured Pairs/Skillsfeat

Sync pairs or theme skills featured in this event.

Stringrequired
Featured Row LabelfeatLabel

Optional. Override for the subject of the "featured" row.

Default
sync pairs
Linesuggested
Bonusesbonus

Optional. Set to no (or blank string) if this event did not give reward or strength bonuses to any sync pairs.

Suggested values
no yes
Default
yes
Linesuggested
Bonus Multiplier 1bon1

Optional. First reward bonus multiplier.

Default
1.6
Linesuggested
Bonus 1 Sync pairsspbon1

Optional. Sync pairs that have the first reward bonus.

Linesuggested
Bonus Multiplier 2bon2

Optional. First reward bonus multiplier.

Default
1.4
Linesuggested
Bonus 2 Sync pairsspbon2

Optional. Sync pairs that have the second reward bonus.

Linesuggested
Bonus Multiplier 3bon3

Optional. First reward bonus multiplier.

Default
1.2
Linesuggested
Bonus 3 Sync pairsspbon3

Optional. Sync pairs that have the third reward bonus.

Linesuggested
Reward Bonus theme skillsskillrbon

Optional. Theme skills with reward bonus in this event.

Linesuggested
Strength theme skillsskillsbon

Optional. Theme skills with strength bonus in this event.

Linesuggested

Examples

Reach for the Top
頂点へと翔ける者 The one who soars to the top
Masters Reach for the Top.png
Event notification image
Type Story event
First run September 3, 2019 to September 30, 2019
Featured sync pairs Blue and Pidgeot
{{MastersEventInfobox
|type=flying
|titlecolor=white
|name=Reach for the Top
|jname=頂点へと翔ける者
|jtrans=The one who soars to the top
|image=Masters Reach for the Top.png
|size=250px
|caption=Event notification image
|etype=Story event
|first=September 3, 2019 to September 30, 2019
|feat={{mas|Blue}} and {{p|Pidgeot}}
|bonus=no
}}


Two Champions
ふたりの王者 Two Kings
Masters Two Champions.png
Event notification image
Type Story event
First run December 26, 2019 to January 22, 2020
Rerun(s) May 25, 2021 to June 8, 2021
Featured sync pairs Lance and Dragonite
Cynthia and Garchomp
Sync pairs with reward bonus 
1.6× Lance and Dragonite (second run only)
Cynthia and Garchomp (second run only) 
1.4× Clair and Kingdra (second run only)
Rosa and Snivy/Servine/Serperior (second run only) 
1.2× Player character and Pikachu (second run only)
Player character and Torchic (second run only)
{{MastersEventInfobox
|type=dragon
|titlecolor=white
|textcolor=white
|name=Two Champions
|jname=ふたりの王者
|jtrans=Two Kings
|image=Masters Two Champions.png
|size=250px
|caption=Event notification image
|etype=Story event
|first=December 26, 2019 to January 22, 2020
|rerun=May 25, 2021 to June 8, 2021
|feat={{mas|Lance}} and {{p|Dragonite}}<br>{{mas|Cynthia}} and {{p|Garchomp}}
|spbon1=Lance and Dragonite (second run only)<br>Cynthia and Garchomp (second run only)
|spbon2={{mas|Clair}} and {{p|Kingdra}} (second run only)<br>{{mas|Rosa}} and {{p|Snivy}}/{{p|Servine}}/{{p|Serperior}} (second run only)
|spbon3=Player character and {{p|Pikachu}} (second run only)<br>Player character and {{p|Torchic}} (second run only)
}}