Template:PkmnInfo/doc: Difference between revisions

From PokéFarm Q Official Wiki
Jump to navigation Jump to search
No edit summary
(Finished info on parameters.)
Line 1: Line 1:
<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 ==
<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 27: Line 27:
|-
|-
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>pkmnName</code></h4>
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>pkmnName</code></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. In some cases defining [[#fileName|<span style="font-family:monospace">fileName</span>]] may be necessary for the Pokémon's image to display.
| 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. In some cases defining [[#fileName|<span style="font-family:monospace;font-size:initial">fileName</span>]] may be necessary for the Pokémon's image to display.
:*Example: <code>pkmnName = Oricorio (Pointe Style)</code>
:*Example: <code>pkmnName = Oricorio (Pointe Style)</code>
|}
|}
Line 38: Line 38:
|-
|-
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>type1</code></h4>
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>type1</code></h4>
| The primary type of the Pokémon. Sometimes used in combination with [[#type2|<span style="font-family:monospace">type2</span>]].
| The primary type of the Pokémon. Sometimes used in combination with [[#type2|<span style="font-family:monospace;font-size:initial">type2</span>]].
|-
|-
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>expHatch</code></h4>
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>expHatch</code></h4>
Line 52: Line 52:
|-
|-
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>eggGroup1</code></h4>
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>eggGroup1</code></h4>
| The primary Egg group of the Pokémon. Sometimes used in combination with [[#eggGroup2|<span style="font-family:monospace">eggGroup2</span>]].
| The primary Egg group of the Pokémon. Sometimes used in combination with [[#eggGroup2|<span style="font-family:monospace;font-size:initial">eggGroup2</span>]].
|-
|-
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>colour1</code></h4>
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>colour1</code></h4>
Line 62: Line 62:
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>body</code></h4>
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>body</code></h4>
| The body style of the Pokémon.
| The body style of the Pokémon.
|-
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>dexEntry</code></h4>
| The Pokédex Entry of the Pokémon. This should be the exact same text that appears in the Pokédex on PFQ. Not to be confused with [[#eggDesc|<span style="font-family:monospace;font-size:initial">eggDesc</span>]].
|}
|}


Line 71: Line 74:
|-
|-
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>fileName</code></h4>
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>fileName</code></h4>
| If the file name of the Pokémon's image does not match [[#pkmnName|<span style="font-family:monospace">pkmnName</span>]], set this parameter to the file name, excluding <code>[[File:Pokémon_</code> and <code>.png]]</code>.
| If the file name of the Pokémon's image does not match [[#pkmnName|<span style="font-family:monospace;font-size:initial">pkmnName</span>]], set this parameter to the file name, excluding <code>[[File:Pokémon_</code> and <code>.png]]</code>.
:*Example: <code>fileName = Oricorio Pointe</code>
:*Example: <code>fileName = Oricorio Pointe</code>
|-
|-
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>type2</code></h4>
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>type2</code></h4>
| The secondary type of the Pokémon. Should always be used in combination with [[#type1|<span style="font-family:monospace">type1</span>]].
| The secondary type of the Pokémon. Should always be used in combination with [[#type1|<span style="font-family:monospace;font-size:initial">type1</span>]].
|-
|-
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>eggGroup2</code></h4>
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>eggGroup2</code></h4>
| The secondary Egg Group of the Pokémon. Should always be used in combination with [[#eggGroup1|<span style="font-family:monospace">eggGroup1</span>]].
| The secondary Egg Group of the Pokémon. Should always be used in combination with [[#eggGroup1|<span style="font-family:monospace;font-size:initial">eggGroup1</span>]].
|-
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>eggDesc</code></h4>
| The Egg Description of the Pokémon. This should be the exact same text that appears in the Pokédex on PFQ. If left undefined while [[#expHatch|<span style="font-family:monospace;font-size:initial">expHatch</span>]] is not set to <code>0</code>, this will display as missing even if the Pokémon does not hatch from an Egg. Not to be confused with [[#dexEntry|<span style="font-family:monospace;font-size:initial">dexEntry</span>]].
|-
! style="vertical-align: top; text-align: left" | <h4 style="display: inline; font-weight: normal;"><code>etymology</code></h4>
| The origin of the Pokémon's name. Under normal circumstances this will likely only apply to [[Exclusive_Pokémon#Exclusives|Fakemon]], as other variants of other Pokémon typically will have the same etymology as their official counterpart(s). Information on potential design influences should not be given here, as etymology relates specifically to the origins of words, or in this case names.
|}
|}
<!--
== Code ==
If one chooses, the following code could be copied and filled with as much information as is available at the time. Note that some missing parameters could be left undefined, while others need to be defined as missing. If a parameter is not applicable to a Pokémon, it could be removed entirely to cut down on the size of the article.
::<div style="font-family: monospace; border: 1px solid #CCC; color: #000; background: #FFF; padding: 4px"><nowiki>{{PkmnInfo
|pkmnName=
|fileName=
|type1=
|type2=
|expHatch=
|expGroup=
|gender=
|eggGroup1=
|eggGroup2=
|colour1=
|colour2=
|body=
|eggDesc=
|dexEntry=
|etymology=
}}</nowiki></div-->

Revision as of 17:11, 25 May 2017

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
Shiny Lunupine
Albino Lunupine
Melanistic 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: Quadruped
This information is currently missing.
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. In some cases defining fileName may be necessary for the Pokémon's image to display.
  • Example: pkmnName = Oricorio (Pointe Style)

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.

type1

The primary type of the Pokémon. Sometimes used in combination with type2.

expHatch

The amount of EXP required to hatch the Pokémon's Egg. If the Pokémon is not known to hatch from an Egg, this value should be set to 0.

expGroup

The EXP Group of the Pokémon. Should be the exact same string as in the Pokédex.
  • Example: expGroup = Medium-Fast (1,000,000)

gender

The gender ratio for the Pokémon. Should be the exact same string as in the Pokédex.
  • Example: gender = 1 Male to 3 Females

eggGroup1

The primary Egg group of the Pokémon. Sometimes used in combination with eggGroup2.

colour1

The normal Pokédex colour of the Pokémon.

colour2

The shiny Pokédex colour of the Pokémon.

body

The body style of the Pokémon.

dexEntry

The Pokédex Entry of the Pokémon. This should be the exact same text that appears in the Pokédex on PFQ. Not to be confused with eggDesc.

Optional

The following parameters needn't necessarily be defined in all cases. That being said, if any of the following are applicable to the Pokémon in question, the parameters should be defined using the {{Missing}} template.

fileName

If the file name of the Pokémon's image does not match pkmnName, set this parameter to the file name, excluding [[File:Pokémon_ and .png]].
  • Example: fileName = Oricorio Pointe

type2

The secondary type of the Pokémon. Should always be used in combination with type1.

eggGroup2

The secondary Egg Group of the Pokémon. Should always be used in combination with eggGroup1.

eggDesc

The Egg Description of the Pokémon. This should be the exact same text that appears in the Pokédex on PFQ. If left undefined while expHatch is not set to 0, this will display as missing even if the Pokémon does not hatch from an Egg. Not to be confused with dexEntry.

etymology

The origin of the Pokémon's name. Under normal circumstances this will likely only apply to Fakemon, as other variants of other Pokémon typically will have the same etymology as their official counterpart(s). Information on potential design influences should not be given here, as etymology relates specifically to the origins of words, or in this case names.