View source for Template:S-inc/doc

{{Documentation subpage}}
{{High-use}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->

This template creates a single succession box column for incumbents to be used with [[Template:S-start|succession boxes]]. It is only meant to be used in the right column of succession boxes.

== Usage ==

The format is <code><nowiki>{{</nowiki>s-inc|''parameter=''}}</code>, 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:
<pre style="font-size:95%; width:95%; overflow:auto;">
{{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}}
</pre>
{{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}}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"description": "Used in third column of a succession box to indicate the current holder is incumbent.",
	"params": {
		"1": {
			"label": "Type",
			"description": "Can be 'current' which gives 'Current holder' or 'recent' which gives 'Most recent'. If unset gives the default 'Incumbent'.",
			"type": "string",
			"required": false
		},
		"heir": {
			"label": "heir",
			"description": "Name of heir of the current incumbent, thus allowing the succession chain to continue as a list of heirs",
			"type": "string",
			"required": false
		},
		"heir-type": {
			"label": "heir-type",
			"description": "Type of heir, preferably one of 'Heir apparent', 'Heir presumptive', 'Coadjutor bishop', default gives just 'Heir'.",
			"type": "string",
			"required": false
		},
		"rows": {
			"label": "rows",
			"description": "Number of table rows to span.",
			"type": "string",
			"required": false
		}
	},
	"format": "block"
}
</templatedata>

== See also ==

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

<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, THANKS -->
[[Category:Succession templates]]

}}</includeonly>