Template:S-vac/doc

This template creates a single succession box column to be used with succession boxes.

Usage

The format is {{s-vac|parameter=}}, where parameter= is replaced by one or more of the parameter names shown in the following table.

This template allows for exactly ONE "before" field, ONE "after" field, ONE "subline", and ONE "header".

IMPORTANT: All uses must be either preceded (if initial) or followed (if other rows follow) with the |- characters, lest the table not display properly.

"Before" fields

last — Designates the last title-holder; enter the name of the last title-holder after entering this parameter.

unknlast — Designates the last known title-holder; enter the name of the last known title-holder after entering this parameter.

Note: This parameter should be used under the header: unknown.

"After" fields

next — Designates the next title-holder; enter the name of the next title-holder after entering this parameter.

unknnext — Designates the next known title-holder; enter the name of the next known title-holder after entering this parameter.

Note: This parameter should be used under the header: unknown.

Sublines

as — Designates a change in title; enter the title of the title-holder after entering this parameter if different than title found in s-ttl.

Header replacements

reason — Designates the reason(s) for the vacancy; enter a short explanation after entering this parameter, if necessary.

abeyance — Replaces "Vacant" with "In abeyance"

commission — Replaces "Vacant" with "In commission"

recreated — Replaces "Vacant" with "Recreated"

forfeit — Replaces "Vacant" with "Forfeit"

suspended — Replaces "Vacant" with "Suspended"

disclaimed — Replaces "Vacant" with "Disclaimed"

dormant — Replaces "Vacant" with "Dormant"

unknown — Replaces "Vacant" with "Unknown"

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

Example

From the Charles I of England article:

{{s-start}}
{{s-reg}}
{{s-bef | before = [[James I of England|James I]]}}
{{s-ttl | title  = [[King of England]] | years = 27 March 1625 – 30 January 1649}}
{{s-vac | next  = [[Charles II of England|Charles II]] | reason = [[English Civil War]]}}
{{s-end}}

Regnal titles
Preceded by James I	King of England 27 March 1625 – 30 January 1649	Vacant English Civil War Title next held by Charles II

See also

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