Template:S-vac/doc

From Sim Football Wiki
< Template:S-vac
Revision as of 10:45, 23 May 2020 by 37thchamber (talk | contribs) (1 revision imported: succession boxes)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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"
disclaimed — Replaces "Vacant" with "Disclaimed"
dormant — Replaces "Vacant" with "Dormant"
extinct — Replaces "Vacant" with "Extinct"
forfeit — Replaces "Vacant" with "Forfeit"
recreated — Replaces "Vacant" with "Recreated"
sedevacante — Replaces "Vacant" with "Sede vacante"
suspended — Replaces "Vacant" with "Suspended"
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
Title next held by
Charles 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-vac

<templatedata> {

   "description": "A succession-box cell for vacant titles (predecessor or successor).",
   "params": {
       "1": {
           "label": "Code",
           "description": "Code for reason, if not specified its taken as Vacant. Can be one of - 'abeyance' or 'ab': In abeyance, 'recreated' or 're': Recreated, 'suspended' or 'su': Suspended, 'disclaimed' or 'di': Disclaimed, 'commission' or 'co': In commission, 'dormant' or 'do': Dormant, 'forfeit': Forfeit, 'unkn' or 'unknown': Unknown.",
           "type": "string",
           "required": false
       },
       "reason": {
           "label": "reason",
           "description": "the reason(s) for the vacancy",
           "type": "string",
           "required": false
       },
       "last": {
           "label": "last",
           "description": "Name of the last title-holder. 'last' and 'unknlast' cannot both be specified",
           "type": "string",
           "required": false
       },
       "unknlast": {
           "label": "unknlast",
           "description": "Name of the last known title-holder, use with code as unknown. 'last' and 'unknlast' cannot both be specified",
           "type": "string",
           "required": false
       },
       "next": {
           "label": "next",
           "description": "Name of the next title-holder, 'next' and 'unknnext' cannot both be specified.",
           "type": "string",
           "required": false
       },
       "unknnext": {
           "label": "unknnext",
           "description": "Name of the next known title-holder, use with code as unknown, 'next' and 'unknnext' cannot both be specified.",
           "type": "string",
           "required": false
       },
       "as": {
           "label": "as",
           "description": "Designates a change in title; enter the title of the title-holder after entering this parameter if different than title found in | style="width: 40%; text-align: center;" rowspan="1"| {{{title}}}        .",
           "type": "string",
           "required": false
       },
       "rows": {
           "label": "rows",
           "description": "Number of table rows to span.",
           "type": "string",
           "required": false
       }
   }

} </templatedata>

See also

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