Template:CharacterEquipmentList/doc: Difference between revisions
Created doc page |
No edit summary |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
<pre>{{CharactEquipmentList|header|equipmentType=Helmets|statModified=Defense}}</pre> | <pre>{{CharactEquipmentList|header|equipmentType=Helmets|statModified=Defense}}</pre> | ||
*header: A required parameter which marks this as the start of an equipment list table. | *header: A required parameter which marks this as the start of an equipment list table. | ||
*equipmentType: The type of equipment | *equipmentType: The type of equipment in this table (weapon, armor, shield, etc.) | ||
* | *title: A required parameter specifying the title of this table. Normally the name of the game. | ||
*subtitle: An optional parameter specifying a subtitle. Normally the console version of the game when more than one exists. | |||
===Entry=== | ===Entry=== | ||
Each entry call designates a single equipment item | Each entry call designates a single equipment item | ||
<pre>{{CharacterEquipmentList|entry|item=[[Leather | <pre>{{CharacterEquipmentList|entry|item=[[Leather hat]]|statModifier=+20}}</pre> | ||
*entry: A required parameter marking an entry. | *entry: A required parameter marking an entry. | ||
*item: The equipment item. Should be an interwiki link. Should also include console information if there are variations between equipment in different releases (i.e. (GBC)). | *item: The equipment item. Should be an interwiki link. Should also include console information if there are variations between equipment in different releases (i.e. ({{GBC}})). | ||
*statModifier: The modifier amount of the main stat the equipment modifies. Should include a '+' symbol. | *statModifier: The modifier amount of the main stat the equipment modifies. Should include a '+' symbol. | ||
===Note=== | |||
A note can be added where additional detail is necessary. | |||
<pre>{{CharacterEquipmentList|note|text=This is a note.}}</pre> | |||
*note: A required parameter marking this as a note. | |||
*text: The text of the note. | |||
===Footer=== | ===Footer=== | ||
The footer call marks the end of the equipment table. | The footer call marks the end of the equipment table. | ||
| Line 20: | Line 26: | ||
==Example== | ==Example== | ||
===Sample=== | ===Sample=== | ||
{{CharacterEquipmentList|header| | {{CharacterEquipmentList|header|title={{Dragon Quest III}}|subtitle={{NES}}|equipmentType=Weapon}} | ||
{{CharacterEquipmentList|entry|item=[[Club]] | {{CharacterEquipmentList|entry|item=[[Oaken club|Club]]|statModifier=Attack +6}} | ||
{{CharacterEquipmentList|entry|item=[[Thorn | {{CharacterEquipmentList|entry|item=[[Thorn whip]]|statModifier=Attack +20}} | ||
{{CharacterEquipmentList|note|text=This is my note.}} | |||
{{CharacterEquipmentList|footer}} | {{CharacterEquipmentList|footer}} | ||
===Code=== | ===Code=== | ||
<pre> | <pre> | ||
{{CharacterEquipmentList|header| | {{CharacterEquipmentList|header|title={{Dragon Quest III}}|subtitle={{NES}}|equipmentType=Weapon}} | ||
{{CharacterEquipmentList|entry|item=[[Club]] | {{CharacterEquipmentList|entry|item=[[Oaken club|Club]]|statModifier=Attack +6}} | ||
{{CharacterEquipmentList|entry|item=[[Thorn | {{CharacterEquipmentList|entry|item=[[Thorn whip]]|statModifier=Attack +20}} | ||
{{CharacterEquipmentList|note|text=This is my note.}} | |||
{{CharacterEquipmentList|footer}} | {{CharacterEquipmentList|footer}} | ||
</pre> | </pre> | ||