Template:S-ttl/doc

This template creates a single succession box center column to be used with succession boxes for the function of listing titles.

Usage
The format is, where parameter= can be used optionally for any of the additional parameters listed in the following table.


 * district &mdash; For use with parliamentary offices. Insert as a wikilink the district represented during the tenure in office.
 * regent1 (or regent 2, or regent 3) AND years1 (or years2, or years3) &mdash; These parameters can be used when an office is held in tandem with another person. Examples of this include co-rulers of a country or region and regencies.  It does not include consorts or sub-positions such as vice presidencies.  The "years" parameter should only contain years, not days or months, but all other guidelines rules apply.
 * alongside &mdash; This parameter is reserved for political positions where two people share power, such as US senators.
 * lords &mdash; Designates that the person was a member of the House of Lords. The parameter is asking for the dates they served in the house.
 * creation &mdash; Adds a sub-line beneath the title that allows for a "creation" number for certain noble titles (such as the Dukes of Cornwall).
 * dynasty &mdash; Adds a sub-line beneath the title that allows for a "dynasty" number for certain royal dynastic lines (such as the Pharaohs of Egypt).
 * with alternative parameter for use when an office is shared with one or more others
 * with2–with25 to allow others sharing the office to be listed separately

This template allows for multiple row-spans using the parameter |rows=| between the template name and the first parameter.

Example
From the Richard, 1st Earl of Cornwall article: 

From the Jefferson Davis article: 

TemplateData
{   "description": "This template creates a single succession box center column to be used with succession boxes for the function of listing titles.", "params": { "title": { "label": "title", "description": "", "type": "string", "required": true },       "years": { "label": "years", "description": "Years served in office, typically a range of dates.", "type": "string", "required": false },       "district": { "label": "district", "description": "For use with parliamentary offices. Insert as a wikilink the district represented during the tenure in office.", "type": "string", "required": false },       "dynasty": { "label": "dynasty", "description": "Adds a sub-line beneath the title that allows for a 'dynasty' number for certain royal dynastic lines (such as the Pharaohs of Egypt).", "type": "string", "required": false },       "creation": { "label": "creation", "description": "Adds a sub-line beneath the title that allows for a 'creation' number for certain noble titles (such as the Dukes of Cornwall).", "type": "string", "required": false },       "lords": { "label": "lords", "description": "Designates that the person was a member of the House of Lords. The dates they served in the house should be specified.", "type": "string", "required": false },       "regent1": { "label": "regent1", "description": "Used when an office is held in tandem with another person. Examples of this include co-rulers of a country or region and regencies. It does not include consorts or sub-positions such as vice presidencies.", "type": "string", "required": false },       "years1": { "label": "years1", "description": "Time regent1 served. Should only contain years, not days or months.", "type": "string", "required": false },       "regent2": { "label": "regent2", "description": "", "type": "string", "required": false },       "years2": { "label": "years2", "description": "", "type": "string", "required": false },       "regent3": { "label": "regent3", "description": "", "type": "string", "required": false },       "years3": { "label": "years3", "description": "", "type": "string", "required": false },       "regent4": { "label": "regent4", "description": "", "type": "string", "required": false },       "years4": { "label": "years4", "description": "", "type": "string", "required": false },       "regent5": { "label": "regent5", "description": "", "type": "string", "required": false },       "years5": { "label": "years5", "description": "", "type": "string", "required": false },       "regent6": { "label": "regent6", "description": "", "type": "string", "required": false },       "years6": { "label": "years6", "description": "", "type": "string", "required": false },       "regent7": { "label": "regent7", "description": "", "type": "string", "required": false },       "years7": { "label": "years7", "description": "", "type": "string", "required": false },       "regent8": { "label": "regent8", "description": "", "type": "string", "required": false },       "years8": { "label": "years8", "description": "", "type": "string", "required": false },       "alongside": { "label": "alongside", "description": "This parameter is reserved for political positions where two people share power, such as US senators.", "type": "string", "required": false },       "with": { "label": "with", "description": "For use when an office is shared with one or more others.", "type": "string", "required": false },       "with2": { "label": "with2", "description": "", "type": "string", "required": false },       "with3": { "label": "with3", "description": "", "type": "string", "required": false },       "with4": { "label": "with4", "description": "", "type": "string", "required": false },       "with5": { "label": "with5", "description": "", "type": "string", "required": false },       "with6": { "label": "with6", "description": "", "type": "string", "required": false },       "with7": { "label": "with7", "description": "", "type": "string", "required": false },       "with8": { "label": "with8", "description": "", "type": "string", "required": false },       "with9": { "label": "with9", "description": "", "type": "string", "required": false },       "with10": { "label": "with10", "description": "", "type": "string", "required": false },       "with11": { "label": "with11", "description": "", "type": "string", "required": false },       "with12": { "label": "with12", "description": "", "type": "string", "required": false },       "with13": { "label": "with13", "description": "", "type": "string", "required": false },       "with14": { "label": "with14", "description": "", "type": "string", "required": false },       "with15": { "label": "with15", "description": "", "type": "string", "required": false },       "with16": { "label": "with16", "description": "", "type": "string", "required": false },       "with17": { "label": "with17", "description": "", "type": "string", "required": false },       "with18": { "label": "with18", "description": "", "type": "string", "required": false },       "with19": { "label": "with19", "description": "", "type": "string", "required": false },       "with20": { "label": "with20", "description": "", "type": "string", "required": false },       "with21": { "label": "with21", "description": "", "type": "string", "required": false },       "with22": { "label": "with22", "description": "", "type": "string", "required": false },       "with23": { "label": "with23", "description": "", "type": "string", "required": false },       "with24": { "label": "with24", "description": "", "type": "string", "required": false },       "with25": { "label": "with25", "description": "", "type": "string", "required": false },       "rows": { "label": "rows", "description": "Number of table rows this entry should span.", "type": "string", "required": false }   } }