Template:S-hou/doc

This template creates a template topper to be used with succession boxes for members of important families or dynasties

Without parameter
The template defaults to PAGENAME and a break if no parameter is given. In the following table, the first column contains the header and the second column shows the template call used to create it.



With parameter
The format is, where parameter is replaced by one of the parameter names shown in the following table.

1 = Person's family name or regnal house 2 = Person's birth day 3 = Person's birth year 4 = Person's death day 5 = Person's death year 6 = Person's senior family name (if house is a part of a cadet branch) name = The person's name if it is not the same as the page title (this option is not required if the pagename fits the individual perfectly)


 * Combinations:















This template should ALWAYS be followed with a succession list and requires the bookend templates, Template:s-start and Template:s-end or Template:s-ref, to work properly.

Example
From the Henry VIII of England article: 

TemplateData
{   "description": "A template topper to be used with succession boxes for members of important families or dynasties.", "params": { "1": {           "label": "Family name/House", "description": "Person's family name or regnal house", "type": "string", "required": false },       "2": {            "label": "Day+Month of birth", "description": "Person's birth day, eg. 28 June", "type": "string", "required": false },       "3": {            "label": "Year of birth", "description": "Person's birth year", "type": "string", "required": false },       "4": {            "label": "Day+Month of death", "description": "Person's death day, eg 28 January", "type": "string", "required": false },       "5": {            "label": "Year of death", "description": "Person's death year", "type": "string", "required": false },       "6": {            "label": "Senior family name", "description": "Person's senior family name (if house is a part of a cadet branch)", "type": "string", "required": false },       "name": { "label": "name", "description": "The person's name if it is not the same as the page title.", "type": "string", "required": false },       "inhibit": { "label": "inhibit", "description": "Suppress using for the title.", "type": "string", "required": false }   } }