Revision 30784 of "سانچو:S-inc/doc" on sdwiki

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS 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 of the United Kingdom|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 of the United Kingdom|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}}

== See also ==

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

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Exclude in print]]
[[Category:Succession templates|{{PAGENAME}}]]

</includeonly>