Difference between revisions of "Template:HadezCharData/doc"
Wraith0x29a (talk | contribs) m |
Wraith0x29a (talk | contribs) m (Formatting fix and clarifications.) |
||
| Line 1: | Line 1: | ||
| + | ===Summary=== | ||
| + | |||
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 :) | ||
| Line 7: | Line 9: | ||
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. | ||
| − | [[User:Wraith0x29a]] | + | Author: [[User:Wraith0x29a|Wraith0x29a]] |
===Parameters=== | ===Parameters=== | ||
| − | <b>world_id</b> - The ID of the world the character exists in.<br> | + | <b>world_id</b> - (required) - The ID of the world the character exists in.<br> |
| − | <b>char_name</b> - The first name of the character | + | <b>char_name</b> or <b>char_id</b> - (required) - The first name or the ID of the character.<br> |
| − | <b> | + | <b>format</b> - (required) - The format to display the output in (current options are 'prose' or 'plain'). |
| − | + | ===Examples=== | |
| − | + | (<i>nb. To avoid tagging this page with semantic tags for the character involved the example output below is hard-coded on this page, not generated from the template</i>) | |
| − | |||
| − | === | + | ====Prose Format==== |
<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]]. | 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]]. | ||
| + | ====Plain Format==== | ||
<nowiki>{{HadezCharData|world_id=6|char_id=977|format=plain}}</nowiki> | <nowiki>{{HadezCharData|world_id=6|char_id=977|format=plain}}</nowiki> | ||
| − | + | Erisha [[Da Hadez Family|Da Hadez]]<br> | |
| + | Class: [[Warrior]] / [[Hero]]<br> | ||
| + | Age: 57<br> | ||
| + | Honour: 173<br> | ||
| + | Prestige: 45<br> | ||
| + | Positions: [[Lord]] of [[Iglavik]]<br> | ||
| + | Region: Iglavik ( lord: Erisha [[Da Hadez Family|Da Hadez]] )<br> | ||
| + | Duchy: [[Oritolon]] ( duke: Cleatus [[Maggot Family|Maggot]])<br> | ||
| + | Realm: [[Oritolon]] ( ruler: Antonine [[Octavius Family|Octavius]] )<br> | ||
| + | Continent: [[Colonies]]<br> | ||
| + | Liege: Cleatus [[Maggot Family|Maggot]] | ||
| − | + | ===Semantic Tags=== | |
| + | |||
| + | The template adds 'member of:' semantic tags that mark the character as a member of their family and region. | ||
===Known Issues=== | ===Known Issues=== | ||
| Line 35: | Line 49: | ||
Please report these in the discussion page for this template. | 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. | Particularly I want to test that the feature that works out and displays a character's liege works correctly. | ||
| − | |||
| − | |||
Revision as of 05:23, 29 November 2009
Contents
Summary
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.
Author: Wraith0x29a
Parameters
world_id - (required) - The ID of the world the character exists in.
char_name or char_id - (required) - The first name or the ID of the character.
format - (required) - The format to display the output in (current options are 'prose' or 'plain').
Examples
(nb. To avoid tagging this page with semantic tags for the character involved the example output below is hard-coded on this page, not generated from the template)
Prose Format
{{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.
Plain Format
{{HadezCharData|world_id=6|char_id=977|format=plain}}
Erisha Da Hadez
Class: Warrior / Hero
Age: 57
Honour: 173
Prestige: 45
Positions: Lord of Iglavik
Region: Iglavik ( lord: Erisha Da Hadez )
Duchy: Oritolon ( duke: Cleatus Maggot)
Realm: Oritolon ( ruler: Antonine Octavius )
Continent: Colonies
Liege: Cleatus Maggot
Semantic Tags
The template adds 'member of:' semantic tags that mark the character as a member of their family and region.
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.
