Template:PkmnInfo/doc: Difference between revisions
Jump to navigation
Jump to search
(Starting page with an example. Proper documentation yet to come.) |
m (saving wip) |
||
| Line 1: | Line 1: | ||
= Example = | <noinclude>{{Note|This document as well as the template that it pertains to are currently works in progress. Please refrain from changing information for the time being.}}</noinclude>== Example == | ||
{{Note|The template does not display properly with undefined variables. As such, the example displayed has been filled with [[Lunupine]]'s information.}} | {{Note|The template does not display properly with undefined variables. As such, the example displayed has been filled with [[Lunupine]]'s information.}} | ||
| Line 10: | Line 10: | ||
|expGroup=Medium-Fast (1,000,000) | |expGroup=Medium-Fast (1,000,000) | ||
|type1=Dark | |type1=Dark | ||
| | |gender=1 Male to 1 Female | ||
|eggGroup1=Field | |eggGroup1=Field | ||
|colour1=Black | |colour1=Black | ||
| Line 18: | Line 17: | ||
|etymology=A combination of the Latin ''luna'', meaning moon, and "lupine", derived from the Latin ''lupinus'', meaning wolf. | |etymology=A combination of the Latin ''luna'', meaning moon, and "lupine", derived from the Latin ''lupinus'', meaning wolf. | ||
}} | }} | ||
== Parameters == | |||
=== Required === | |||
The following parameters must be defined at all times. Failure to do so will result in the template displaying improperly. | |||
{| style="margin-left: 36px" | | |||
|- | |||
! style="vertical-align: top; text-align: left" | <h4 style="font-size: 10pt; display: inline; background-color: #f9f9f9; padding: 0; margin: 0; font-family: monospace;">pkmnName</h4> | |||
| This value is the bare minimum required for '''<nowiki>{{PkmnInfo}}</nowiki>''' to function properly. This should be the name of the Pokémon in question and should include the forme if applicable. | |||
:*Example: <code>pkmnName = Oricorio (Pointe Style)</code> | |||
|- | |||
! style="vertical-align: top; text-align: left" | <h4 style="font-size: 10pt; display: inline; background-color: #f9f9f9; padding: 0; margin: 0; font-family: monospace;">expHatch</h4> | |||
| The amount of EXP required to hatch the Pokémon's Egg. If the Pokémon does not hatch from an Egg, this value should be set to <code>0</code>. | |||
|} | |||
=== Expected === | |||
The following parameters should always be defined, though they may be unavailable. If undefined, they will automatically be filled with a missing template. As such, if information is unavailable, do not fill these parameters with the [[Template:Missing|<nowiki>{{Missing}}</nowiki>]] template, but instead leave them blank, as there is logic within the template based on whether or not a parameter is defined that has the potential to break the template if an unexpected value is used. | |||
{| style="margin-left: 36px" | | |||
|- | |||
! style="vertical-align: top; text-align: left" | <h4 style="font-size: 10pt; display: inline; background-color: #f9f9f9; padding: 0; margin: 0; font-family: monospace;">gender</h4> | |||
| The gender ratio for the Pokémon. | |||
|- | |||
! style="vertical-align: top; text-align: left" | <h4 style="font-size: 10pt; display: inline; background-color: #f9f9f9; padding: 0; margin: 0; font-family: monospace;">colour1</h4> | |||
| The normal Pokédex colour of the Pokémon. | |||
|- | |||
! style="vertical-align: top; text-align: left" | <h4 style="font-size: 10pt; display: inline; background-color: #f9f9f9; padding: 0; margin: 0; font-family: monospace;">colour2</h4> | |||
| The shiny Pokédex colour of the Pokémon. | |||
|- | |||
! style="vertical-align: top; text-align: left" | <h4 style="font-size: 10pt; display: inline; background-color: #f9f9f9; padding: 0; margin: 0; font-family: monospace;">eggGroup1</h4> | |||
| The primary Egg group of the Pokémon. | |||
|- | |||
! style="vertical-align: top; text-align: left" | <h4 style="font-size: 10pt; display: inline; background-color: #f9f9f9; padding: 0; margin: 0; font-family: monospace;">type1</h4> | |||
| The primary type of the Pokémon. | |||
|} | |||
=== Optional === | |||
The following parameters needn't be defined in all cases. That being said, if any of the following are applicable to a Pokémon, the | |||
Revision as of 03:44, 8 April 2017
- Note: This document as well as the template that it pertains to are currently works in progress. Please refrain from changing information for the time being.
Example
- Note: The template does not display properly with undefined variables. As such, the example displayed has been filled with Lunupine's information.
Lunupine
Lunupine let out melodic howls during the nights of a full moon. It is rarely seen out in the wild.
Type: 
Genders: 1 Male to 1 Female
EXP group: Medium-Fast (1,000,000)
Egg group: Field
Colour: Black / Blue
Size: ???
Body style: 
This information is currently missing.
Help us by adding Lunupine's base stats.
Help us by adding Lunupine's base stats.
Parameters
Required
The following parameters must be defined at all times. Failure to do so will result in the template displaying improperly.
pkmnName |
This value is the bare minimum required for {{PkmnInfo}} to function properly. This should be the name of the Pokémon in question and should include the forme if applicable.
|
|---|---|
expHatch |
The amount of EXP required to hatch the Pokémon's Egg. If the Pokémon does not hatch from an Egg, this value should be set to 0.
|
Expected
The following parameters should always be defined, though they may be unavailable. If undefined, they will automatically be filled with a missing template. As such, if information is unavailable, do not fill these parameters with the {{Missing}} template, but instead leave them blank, as there is logic within the template based on whether or not a parameter is defined that has the potential to break the template if an unexpected value is used.
gender |
The gender ratio for the Pokémon. |
|---|---|
colour1 |
The normal Pokédex colour of the Pokémon. |
colour2 |
The shiny Pokédex colour of the Pokémon. |
eggGroup1 |
The primary Egg group of the Pokémon. |
type1 |
The primary type of the Pokémon. |
Optional
The following parameters needn't be defined in all cases. That being said, if any of the following are applicable to a Pokémon, the
