Template:CharacterList/doc: Difference between revisions
FlyingRagnar (talk | contribs) m (moved Template:EquipmentCharacter/doc to Template:CharacterList/doc: More generic name, since this template can be used for equipment or spells) |
FlyingRagnar (talk | contribs) mNo edit summary |
||
| Line 5: | Line 5: | ||
===Header=== | ===Header=== | ||
A header call to this template should be the first usage of this template on any page. | A header call to this template should be the first usage of this template on any page. | ||
<pre>{{CharacterList|header}}</pre> | ===Equipment=== | ||
When used for equipment, the header should be as follows. | |||
<pre>{{CharacterList|header|equipment}}</pre> | |||
*header: A required parameter which marks this as the start of a character table. | *header: A required parameter which marks this as the start of a character table. | ||
*equipment: A required parameter to utilize the correct styles. | |||
===Spells=== | |||
When used for spells, the header should be as follows. | |||
<pre>{{CharacterList|header|spell}}</pre> | |||
*header: A required parameter which marks this as the start of a character table. | |||
*spell: A required parameter to utilize the correct styles. | |||
===Entries=== | ===Entries=== | ||
Each entry in the character table is represented by a single template call. | Each entry in the character table is represented by a single template call. | ||
| Line 19: | Line 27: | ||
==Example== | ==Example== | ||
===Sample=== | ===Sample=== | ||
{{CharacterList|header}} | {{CharacterList|header|equipment}} | ||
{{CharacterList|entry|character=[[Ragnar]]|console=NES,GBC}} | {{CharacterList|entry|character=[[Ragnar]]|console=NES,GBC}} | ||
{{CharacterList|entry|character=[[Bianca]]|console=SNES,PS2}} | {{CharacterList|entry|character=[[Bianca]]|console=SNES,PS2}} | ||
| Line 25: | Line 33: | ||
===Code=== | ===Code=== | ||
<pre> | <pre> | ||
{{CharacterList|header}} | {{CharacterList|header|equipment}} | ||
{{CharacterList|entry|character=[[Ragnar]]|console=NES,GBC}} | {{CharacterList|entry|character=[[Ragnar]]|console=NES,GBC}} | ||
{{CharacterList|entry|character=[[Bianca]]|console=SNES,PS2}} | {{CharacterList|entry|character=[[Bianca]]|console=SNES,PS2}} | ||
{{CharacterList|footer}} | {{CharacterList|footer}} | ||
</pre> | </pre> | ||
Revision as of 18:43, 20 February 2010
The CharacterList template is used to display a set of characters who can equip a certain piece of equipment in Dragon Quest games. It specifically applies to the set of characters which share some common attribute (commonly a piece of equipment that can be equipped or a spell that can be learned) in a single game.
Usage
In almost all cases, using this template should be preceded by a heading for the game and a subheading of 'Characters'. This specifies what information the table actually contains.
Header
A header call to this template should be the first usage of this template on any page.
Equipment
When used for equipment, the header should be as follows.
{{CharacterList|header|equipment}}
- header: A required parameter which marks this as the start of a character table.
- equipment: A required parameter to utilize the correct styles.
Spells
When used for spells, the header should be as follows.
{{CharacterList|header|spell}}
- header: A required parameter which marks this as the start of a character table.
- spell: A required parameter to utilize the correct styles.
Entries
Each entry in the character table is represented by a single template call.
{{CharacterList|entry|character=[[Ragnar]]|console=NES}}
- entry: A required parameter which marks this as a single character table entry.
- character: The name of the character. Should be an interwiki link.
- console: The console version of the game. Can and should denote multiple consoles when appropriate.
The footer call marks the end of the character table.
{{CharacterList|footer}}
- footer: A required parameter marking the template as the footer.
Example
Sample
| Characters |
|
| Ragnar | |
| Bianca |
Code
{{CharacterList|header|equipment}}
{{CharacterList|entry|character=[[Ragnar]]|console=NES,GBC}}
{{CharacterList|entry|character=[[Bianca]]|console=SNES,PS2}}
{{CharacterList|footer}}
