Template:Succession box

Template documentationviewedithistorypurge

This template creates a standard line for succession boxes.

Deprecated in favour of the s-start template series, the succession box template might be used only for the simplest succession lines. These are single succession lines showing nothing more than a succession of three people holding exactly the same title. For succession lines sharing cells with other lines, for new or expired titles, for incumbencies or vacancies, for titular rulers or pretenders, for titles which change their name before or after the subject, and for lines requiring other additional information, the specialised templates of the {{s-start}} series should be used instead of this one. For purposes of consistency and simplicity, it is preferable to use {{s-start}} series templates in all cases.

Syntax

Basic usage: <syntaxhighlight lang="wikitext" style="overflow:auto;">

</syntaxhighlight>

Full usage: <syntaxhighlight lang="wikitext" style="overflow:auto;">

</syntaxhighlight>

Usage

A succession box may start with a single {{S-start}} and end with one {{S-end}}. Alternatively, the old versions may be used, namely {{Start box}} as the initial template and {{End box}} as the finishing one; the two formats are compatible with each other.

Within each succession box, one or more lines may be created. One {{Succession box}} is used for each line, and parameters are used to insert data into the template: "before" for the predecessor of the subject, "title" for the subject's title, "years" for the time period during which they held the title, and "after" for the name of their successor.

Parameters

Years

Mandatory; a value is required. The value may be years or full dates. A range is not required, such as if a term of office was one year.

Title

The title of the office held. Do not put the name of the person covered by the article into this field.

Usage with multiple office-holders

Where a post was held by more than one person at a time, extra parameters should be used to include them.

Predecessors

• For multiple predecessors use "before", "before2", "before3", etc. (max 5)

Successors

• For multiple successors use "after", "after2", "after3", etc. (max 5)

Concurrent office-holders

• For concurrent office-holders use "with", "with2", "with3", etc. (max 25)

Examples

Example with single office-holder

From the article Winston Churchill:

<syntaxhighlight lang="wikitext" style="overflow:auto;">

</syntaxhighlight>

Example with multiple office-holders

From the article Richard Temple-Grenville, 2nd Duke of Buckingham and Chandos:

<syntaxhighlight lang="wikitext" style="overflow:auto;">

</syntaxhighlight>

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Succession box in articles based on its TemplateData.

TemplateData for Succession box

<templatedata> { "description": "This template creates a standard line for succession boxes. It is normally preceded by

and followed by |}", "params": { "years": { "label": "Years", "description": "The years the office held, value may be years or full dates, a range is not require if the post was only held for a year", "type": "string", "example": "1912–1935", "suggested": true }, "title": { "label": "Title", "description": "Title of the office; do not include the person's name", "type": "string", "required": false, "suggested": true, "example": "Prime Minister of the United Kingdom" }, "rows": { "label": "Rows", "type": "number", "required": false, "description": "Number of rows to cover" }, "before": { "label": "Before", "description": "First predecessor", "type": "string", "required": false, "suggested": true }, "before2": { "label": "before2", "description": "Second predecessor", "type": "string", "required": false }, "before3": { "label": "before3", "description": "Third predecessor", "type": "string", "required": false }, "before4": { "label": "before4", "description": "Forth predecessor", "type": "string", "required": false }, "before5": { "label": "before5", "description": "Fifth predecessor", "type": "string", "required": false }, "after": { "label": "after", "description": "First successors", "type": "string", "required": false, "suggested": true }, "after2": { "label": "after2", "description": "Second successors", "type": "string", "required": false }, "after3": { "label": "after3", "description": "Third successors", "type": "string", "required": false }, "after4": { "label": "after4", "description": "Forth successors", "type": "string", "required": false }, "after5": { "label": "after5", "description": "Fifth successors", "type": "string", "required": false }, "alongside": { "label": "alongside", "description": "Used when they 'Served alongside' another person", "type": "string", "required": false }, "with": { "label": "with", "description": "Concurrent office-holders, up to 25 people", "type": "string", "required": false }, "with2": { "label": "with2", "type": "string", "required": false }, "with3": { "label": "with3", "type": "string", "required": false }, "with4": { "label": "with4", "type": "string", "required": false }, "with5": { "label": "with5", "type": "string", "required": false }, "with6": { "label": "with6", "type": "string", "required": false }, "with7": { "label": "with7", "type": "string", "required": false }, "with8": { "label": "with8", "type": "string", "required": false }, "with9": { "label": "with9", "type": "string", "required": false }, "with10": { "label": "with10", "type": "string", "required": false }, "with11": { "label": "with11", "type": "string", "required": false }, "with12": { "label": "with12", "type": "string", "required": false }, "with13": { "label": "with13", "type": "string", "required": false }, "with14": { "label": "with14", "type": "string", "required": false }, "with15": { "label": "with15", "type": "string", "required": false }, "with16": { "label": "with16", "type": "string", "required": false }, "with17": { "label": "with17", "type": "string", "required": false }, "with18": { "label": "with18", "type": "string", "required": false }, "with19": { "label": "with19", "type": "string", "required": false }, "with20": { "label": "with20", "type": "string", "required": false }, "with21": { "label": "with21", "type": "string", "required": false }, "with22": { "label": "with22", "type": "string", "required": false }, "with23": { "label": "with23", "type": "string", "required": false }, "with24": { "label": "with24", "type": "string", "required": false }, "with25": { "label": "with25", "type": "string", "required": false } }, "format": "block", "paramOrder": [ "title", "years", "before", "before2", "before3", "before4", "before5", "after", "after2", "after3", "after4", "after5", "alongside", "with", "with2", "with3", "with4", "with5", "with6", "with7", "with8", "with9", "with10", "with11", "with12", "with13", "with14", "with15", "with16", "with17", "with18", "with19", "with20", "with21", "with22", "with23", "with24", "with25", "rows" ] } </templatedata>

See also

• Documentation for creating more complex succession boxes can be found at Template:S-start.
• A quick overview of the various templates and parameters of the s-start series can be found at the Cheatsheet.
• {{Sequence}}

The above documentation is transcluded from Template:Succession box/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.