Difference between revisions of "Template:HadezCharData/doc"
Wraith0x29a (talk | contribs) m |
Wraith0x29a (talk | contribs) m |
||
| Line 1: | Line 1: | ||
This is a work in progress and my first attempt at serious wiki-fiddling so be gentle :) | This is a work in progress and my first attempt at serious wiki-fiddling so be gentle :) | ||
| − | + | If valid world and character parameters are entered it shows character data gathered in real-time from the game and sets some semantic tags on the page. | |
| + | |||
| + | If invalid world or character characters are entered (user errror or if a character has died or been deleted) nothing is shown at all. | ||
There are currently two display formats, a 'prose' version suitable for use as an introduction at the top of a character's page and a 'plain' list of the character's details suitable for putting in a box or at the foot of the page. There will be a formatted infobox style format with colour and image options coming soon. | There are currently two display formats, a 'prose' version suitable for use as an introduction at the top of a character's page and a 'plain' list of the character's details suitable for putting in a box or at the foot of the page. There will be a formatted infobox style format with colour and image options coming soon. | ||
| Line 14: | Line 16: | ||
Only one of <b>char_name</b> or <b>char_id</b> is required. | Only one of <b>char_name</b> or <b>char_id</b> is required. | ||
| + | |||
| + | Don't put spaces after parameter values. | ||
===Examples=== | ===Examples=== | ||
<nowiki>{{HadezCharData|world_id=6|char_name=Erisha|format=prose}}</nowiki> | <nowiki>{{HadezCharData|world_id=6|char_name=Erisha|format=prose}}</nowiki> | ||
| + | |||
| + | Erisha [[Da Hadez Family|Da Hadez]] is a [[warrior]]-[[hero]] in the realm of [[Oritolon]] on the [[Colonies]] continent. She is 57 years old, is [[Lord]] of [[Iglavik]] and has 173 honour and 45 prestige. Her liege is Cleatus [[Maggot]], [[Duke]] of [[Oritolon]]. | ||
<nowiki>{{HadezCharData|world_id=6|char_id=977|format=plain}}</nowiki> | <nowiki>{{HadezCharData|world_id=6|char_id=977|format=plain}}</nowiki> | ||
| + | |||
| + | ===Semantic Tags Set=== | ||
| + | |||
| + | Along with the visual output the template adds 'member of:' semantic tags that flag the character as a member of their family, region, duchy and realm. | ||
===Known Issues=== | ===Known Issues=== | ||
Revision as of 22:16, 28 November 2009
This is a work in progress and my first attempt at serious wiki-fiddling so be gentle :)
If valid world and character parameters are entered it shows character data gathered in real-time from the game and sets some semantic tags on the page.
If invalid world or character characters are entered (user errror or if a character has died or been deleted) nothing is shown at all.
There are currently two display formats, a 'prose' version suitable for use as an introduction at the top of a character's page and a 'plain' list of the character's details suitable for putting in a box or at the foot of the page. There will be a formatted infobox style format with colour and image options coming soon.
Parameters
world_id - The ID of the world the character exists in.
char_name - The first name of the character. Do not include family name.
char_id - The ID of the character (preferred over char_name for performance reasons)
Only one of char_name or char_id is required.
Don't put spaces after parameter values.
Examples
{{HadezCharData|world_id=6|char_name=Erisha|format=prose}}
Erisha Da Hadez is a warrior-hero in the realm of Oritolon on the Colonies continent. She is 57 years old, is Lord of Iglavik and has 173 honour and 45 prestige. Her liege is Cleatus Maggot, Duke of Oritolon.
{{HadezCharData|world_id=6|char_id=977|format=plain}}
Semantic Tags Set
Along with the visual output the template adds 'member of:' semantic tags that flag the character as a member of their family, region, duchy and realm.
Known Issues
As characters vary there may be cases where this template does not work as expected. Please report these in the discussion page for this template. Particularly I want to test that the feature that works out and displays a character's liege works correctly.
The prose version needs tweaked for the case of rulers who have no liege.
