Template:HadezCharData/doc

Summary

This is a work in progress and my first attempt at serious wiki-fiddling so be gentle :)

It displays character details, updated in real-time, taken from the game.

It is to be used on character pages only as it sets some character-specific semantic tags.

There are currently three display formats, and infobox style 'box' that sits at the right of the page, a 'plain' list of the character's details suitable for putting in a box or at the foot of the page and a 'prose' version suitable for use as an introduction at the top of a character's page.

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'). background - (optional) - The HTML color code to use for the box format background. header - (optional) - The HTML color code to use for the box format header background. list - (optional) - The HTML color code to use for the box format list background (left hand column). value - (optional) - The HTML color code to use for the box format values background (right hand column).

If invalid world or character parameters are entered (user error or if a character has died or been deleted) nothing is shown at all.

HTML hexadecimal based color codes (eg. #AA0000 for mid red) should include the # prefix.
The default color-scheme of tasteful greys is used if the color parameters are omitted for the box format.

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)

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

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.

Box Format

Erisha Da Hadez
Class	Warrior / Hero
Age Honour Prestige	57 173 45
Liege	Cleatus Maggot
Positions	Lord of Iglavik
Region lord	Iglavik Erisha Da Hadez
Duchy duke	Oritolon Cleatus Maggot
Realm ruler	Oritolon Antonine Octavius
Continent	Colonies

(approximate example shown to the right of page)

{{HadezCharData
|world_id=6
|char_name=Erisha
|format=box
|background=#555555
|header=#FF00FF
|list=#00FFFF
|value=#FFFF00
}}

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.

If using multiple instances of this template on a page be aware that errors in the parameters to one instance of the template may cause values from the previous instance of the template to be used. This can cause unexpected results. This appears to be an unavoidable consequence of the way the underlying wiki system works. Thanks to Kag for helping highlight this bug.

There is no way to discover from the game data API whether or not a character gets a tax share from their region and so whether they are a knight or simple noble. They are listed by this template simply as Nobles.

Differentiating between the different types of non-duke local lords (Baron, Count, Viscount, Marques etc) is next to impossible so all are listed as 'Lord'.