Template:S-tul/doc

This is a documentation subpage for Template:S-tul.
It contains usage information, categories and other content that is not part of the original template page.

This template creates a single succession box center column to be used with succession boxes for the function of listing titular titles (claimed titles with no associated authority).

Usage

The format is {{s-tul|title=enter title here|years=enter years title was held here|parameter=}}, where parameter= can be used optionally for any of the additional parameters listed in the following table.

All succession boxes using this template should have the header Template:s-pre.

line — This parameter allows an editor to designate a claimant line (such as Legitimist) beneath the title line.

reason — Use this to provide a brief description of the reasons behind the titular title. Be sure to wikilink and events.

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

Example

From the Alfonso XIII of Spain article:

{{s-start}}
{{s-pre}}
{{s-bef|before=[[Alfonso Carlos of Bourbon, Duke of San Jaime|Alphonse II]]}}
{{s-tul|title=[[List of French monarchs|King of France]] and [[List of Navarrese monarchs|Navarre]]
|line=[[Legitimists|Legitimist claimant]]
|years=September 29, 1936 – February 29, 1941
|reason=[[July Revolution|Bourbon monarchy deposed, 1830]]}}
{{s-aft|after=[[Infante Jaime, Duke of Segovia|Jacques II]]}}
{{s-end}}

Titles in pretence
Preceded by Alphonse II	— TITULAR — King of France and Navarre Legitimist claimant September 29, 1936 – February 29, 1941 Reason for succession failure: Bourbon monarchy deposed 1830	Succeeded by Jacques II

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for S-tul

<templatedata> {

   "description": "A middle column succession box for listing titular titles (claimed titles with no associated authority).",
   "params": {
       "title": {
           "label": "title",
           "description": "Claimed title",
           "type": "string",
           "required": true
       },
       "line": {
           "label": "line",
           "description": "Allows a claimant line to be designate (such as Legitimist) beneath the title line.",
           "type": "string",
           "required": false
       },
       "years": {
           "label": "years",
           "description": "Dates title claimed. Use – for ranges.",
           "type": "string",
           "required": false
       },
       "reason": {
           "label": "reason",
           "description": "Reason for succession failure",
           "type": "string",
           "required": false
       },
       "start": {
           "label": "start",
           "description": "Start date for reason",
           "type": "string",
           "required": false
       },
       "end": {
           "label": "end",
           "description": "End date for reason",
           "type": "string",
           "required": false
       },
       "rows": {
           "label": "rows",
           "description": "Number of rows to span",
           "type": "string",
           "required": false
       }
   }

} </templatedata>

Related pages

Documentation for creating succession boxes can be found at Template:S-start/doc.