Template:S-inc/doc

This template creates a single succession box column for incumbents to be used with succession boxes. It is only meant to be used in the right column of succession boxes.

Usage

The format is {{s-inc|parameter=}}, where parameter= is replaced by one or more of the parameter names shown in the following table. The code without any parameters defaults to Incumbent.

current — Replaces Incumbent with Current holder

recent — Replaces Incumbent with Most recent

heir — Designates the heir of the current incumbent, thus allowing the succession chain to continue as a list of heirs

heir-type — Replaces "Heir" with the inserted text, preferably one of "Heir apparent", "Heir presumptive", "Coadjutor bishop"

Note: Template:s-ttl does not allow for a template to have an incumbent, so editors must add "– present" after the first date. If using the "recent" parameter, this is not necessary.

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

Example

From the Elizabeth II of the United Kingdom article:

{{s-start}}
{{s-reg}}
{{s-bef | before = [[George VI]]}}
{{s-ttl | title = [[Queen of the United Kingdom]] | years = 6 February 1952 – present}}
{{s-inc | heir = [[Charles, Prince of Wales]] | heir-type = Heir apparent}}
{{s-end}}

Regnal titles
Preceded by George VI	Queen of the United Kingdom 6 February 1952 – present	Incumbent Heir apparent: Charles, Prince of Wales

TemplateData

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

TemplateData for S-inc

Used in third column of a succession box to indicate the current holder is incumbent.

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
Type	1	Can be 'current' which gives 'Current holder' or 'recent' which gives 'Most recent'. If unset gives the default 'Incumbent'.	String	optional
heir	heir	Name of heir of the current incumbent, thus allowing the succession chain to continue as a list of heirs	String	optional
heir-type	heir-type	Type of heir, preferably one of 'Heir apparent', 'Heir presumptive', 'Coadjutor bishop', default gives just 'Heir'.	String	optional
rows	rows	Number of table rows to span.	String	optional

See also

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