Template:CharacterEquipmentList/doc: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
*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 in this table (weapon, armor, shield, etc.) | *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. | *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. | *subtitle: An optional parameter specifying a subtitle. Normally the console version of the game when more than one exists. | ||
*collapsed: An optional parameter specifying that the table should collapse by default. This parameter should be given a dummy value if specified, i.e. collapsed=true. | |||
===Entry=== | ===Entry=== | ||
Each entry call designates a single equipment item | Each entry call designates a single equipment item | ||
| Line 16: | Line 16: | ||
*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 25: | Line 30: | ||
{{CharacterEquipmentList|entry|item=[[Club]]|statModifier=Attack +6}} | {{CharacterEquipmentList|entry|item=[[Club]]|statModifier=Attack +6}} | ||
{{CharacterEquipmentList|entry|item=[[Thorn Whip]]|statModifier=Attack +20}} | {{CharacterEquipmentList|entry|item=[[Thorn Whip]]|statModifier=Attack +20}} | ||
{{CharacterEquipmentList|note|This is my note.}} | |||
{{CharacterEquipmentList|footer}} | {{CharacterEquipmentList|footer}} | ||
===Code=== | ===Code=== | ||
| Line 31: | Line 37: | ||
{{CharacterEquipmentList|entry|item=[[Club]]|statModifier=Attack +6}} | {{CharacterEquipmentList|entry|item=[[Club]]|statModifier=Attack +6}} | ||
{{CharacterEquipmentList|entry|item=[[Thorn Whip]]|statModifier=Attack +20}} | {{CharacterEquipmentList|entry|item=[[Thorn Whip]]|statModifier=Attack +20}} | ||
{{CharacterEquipmentList|note|This is my note.}} | |||
{{CharacterEquipmentList|footer}} | {{CharacterEquipmentList|footer}} | ||
</pre> | </pre> | ||
Revision as of 13:10, 27 August 2010
The CharacterEquipmentList template is used to list equipment which a character is able to equip. A separate list should be used for each type of equipment (Weapons, Armor, Shields, Helmets).
Usage
Header
A header call to this template should be the first usage of this template on any page.
{{CharactEquipmentList|header|equipmentType=Helmets|statModified=Defense}}
- header: A required parameter which marks this as the start of an equipment list table.
- 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.
- collapsed: An optional parameter specifying that the table should collapse by default. This parameter should be given a dummy value if specified, i.e. collapsed=true.
Entry
Each entry call designates a single equipment item
{{CharacterEquipmentList|entry|item=[[Leather Hat]]|statModifier=+20}}
- 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)).
- 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.
{{CharacterEquipmentList|note|text=This is a note.}}
- note: A required parameter marking this as a note.
- text: The text of the note.
The footer call marks the end of the equipment table.
{{CharacterEquipmentList|footer}}
- footer: A required parameter marking the template as the footer.
Example
Sample
| Dragon Quest III (NES) | |
|---|---|
| Weapon | Modifier(s) |
| Club | Attack +6 |
| Thorn Whip | Attack +20 |
| {{{text}}} | |
Code
{{CharacterEquipmentList|header|title=Dragon Quest III|subtitle=NES|equipmentType=Weapon}}
{{CharacterEquipmentList|entry|item=[[Club]]|statModifier=Attack +6}}
{{CharacterEquipmentList|entry|item=[[Thorn Whip]]|statModifier=Attack +20}}
{{CharacterEquipmentList|note|This is my note.}}
{{CharacterEquipmentList|footer}}