Editing Template:S-start/doc (section)

==Analysis of succession templates==
Here follows a detailed description of the succession templates, with information about the circumstances in which they are used and examples of their use in succession boxes. The five basic templates are not included, as their function is standard (see previous section) and their parameters are documented separately [[#Additional features|lower in this page]].

The templates are analyzed in sections according to their place in succession boxes.

===Predecessor/successor templates===
These are the templates that are used to substitute ''s-bef'' and/or ''s-aft'' when a box documents a succession different from the usual format of "predecessor-subject-successor", like at the beginning or end of a succession chain and at a vacancy. The templates in this category are four: ''s-new'', ''s-non'', ''s-inc'', and ''s-vac''.

====S-new====
''S-new'' is used instead of ''s-bef'' to signify the beginning of a new succession chain, where there is no predecessor before the subject for a specific title.

Simply using <nowiki>{{s-new}}</nowiki> will produce a plain "New title" cell. Using parameters can change this title: "creation" produces a "New creation" cell instead of the "New title" one, "party" produces a "New political party" one, etc. (see the [[Template:S-new|template page]] for an exhaustive list). There is also a "reason" parameter, which gives the option of entering the reason behind the title's creation, using a short sentence.

Here follows an example of the usage of ''Template:S-new'', taken from the article of [[Aegon I Targaryen]]:

::<nowiki>{{s-start}}</nowiki>
::<nowiki>{{s-new}}</nowiki>
::<nowiki>{{s-ttl|title=[[King of the Andals, the Rhoynar and the First Men]]<br>[[Lord of the Seven Kingdoms]]<br>[[Protector of the Realm]]|years={{Date|1|37}}}}</nowiki>
::<nowiki>{{s-aft|after=[[Aenys I Targaryen|Aenys I]]}}</nowiki>
::<nowiki>{{s-end}}</nowiki>

Which will appear like this:

{{s-start}}
{{s-new}}
{{s-ttl|title=[[King of the Andals, the Rhoynar, and the First Men]]<br>[[Lord of the Seven Kingdoms]]<br>[[Protector of the Realm]]|years={{Date|1|37}}}}
{{s-aft|after=[[Aenys I Targaryen|Aenys I]]}}
{{s-end}}

====S-non====
''S-non'' is the opposite of ''s-new'': it is used to signal the conclusion of a chain of succession, replacing ''s-aft'' in the box's successor cell. ''S-non'' fills the slot when a position is abolished, becomes extinct, or otherwise falls into permanent disuse. ''S-vac'' should be used instead if the line of succession resumes after a period of vacancy. 

As the reasons for the end of a title are more numerous and possibly more difficult to describe than those for its creation, ''s-non'' is an open template, allowing for the insertion of practically any message (using the "reason" parameter, which cannot be omitted). It is preferable, however, that these messages are as short as possible, like "Abolished."

''S-non'' must be followed by a <nowiki>|-</nowiki> character in complex tables, or error might occur in the display of these succession boxes.  The use of this character is not necessary if a reason is given, as the use of a reason incorporates the use of the <nowiki>|</nowiki> character. The very first and last lines of each table are also excepted, as it is not necessary to add the character before the first line and after the last one.

Here follows an example of the usage of ''Template:S-non'', taken from the article of the [[Bloodstone Emperor]]:

::<nowiki>{{s-start}}</nowiki>
::<nowiki>{{s-bef|before=[[Amethyst Empress]]}}</nowiki>
::<nowiki>{{s-ttl|title=[[God-emperor]] of the [[Great Empire of the Dawn]]}}</nowiki>
::<nowiki>{{s-non|reason=Last emperor}}</nowiki>
::<nowiki>{{s-end}}</nowiki>

Which will appear like this:

{{s-start}}
{{s-bef|before=[[Amethyst Empress]]}}
{{s-ttl|title=[[God-emperor]] of the [[Great Empire of the Dawn]]}}
{{s-non|reason=Last emperor}}
{{s-end}}

====S-inc====
''S-inc'' is used instead of ''s-aft'' to show that the subject is the current holder of a title, and that for this reason there is no successor to the title for the duration of the subject's term. There are incumbents for all succession chains that have not already ended, with the exception of those currently vacant.

One will normally use the proper ''s-inc'' template, <nowiki>{{s-inc}}</nowiki>, which will produce a simple "Incumbent" cell. There is the "heir" parameter, which allows one to include the name of the incumbent's heir (if any), as well as the "heir-type" parameter, where an heir's specific title or status can be stated (usually "Heir apparent" or "Heir presumptive").

Here follows an example of the usage of ''Template:S-inc'', take from the article of [[Tommen Baratheon]]:

::<nowiki>{{s-start}}</nowiki>
::<nowiki>{{s-bef|before=[[Joffrey Baratheon|Joffrey I]]}}</nowiki>
::<nowiki>{{s-ttl|title=[[King of the Andals, the Rhoynar and the First Men]]<br>[[Lord of the Seven Kingdoms]]|years={{Date|300}}–present}}</nowiki>
::<nowiki>{{s-inc|heir=[[Myrcella Baratheon]]|heir-type=Heiress presumptive}}</nowiki>
::<nowiki>{{s-end}}</nowiki>

Which will appear like this:

{{s-start}}
{{s-bef|before=[[Joffrey Baratheon|Joffrey I]]}}
{{s-ttl|title=[[King of the Andals, the Rhoynar, and the First Men]]<br>[[Lord of the Seven Kingdoms]]|years={{Date|300}}–present}}
{{s-inc|heir=[[Myrcella Baratheon]]|heir-type=Heiress presumptive}}
{{s-end}}

====S-vac====
''S-vac'' may be used in place of either ''s-bef'' or ''s-aft'' (or both in the same line), and its purpose is to indicate breaks in succession chains, primarily vacancies. A vacancy is a length of time during which a title is unoccupied—for monarchs, such periods are known as interregna. Vacancies occur to most offices, although it should be noted that the short period that often passes between the end of the previous holder's term and the election/appointment of the next holder does not count as a vacancy.

There are two basic versions for ''s-vac'', each of which requires a parameter. The version for the predecessor cell uses a "last" parameter, where the name of the title's holder before the vacancy can be filled, while the version for the successor cell uses the parameter "next". Furthermore, there are title parameters that change the message displayed ("Vacant"), depending on the specific circumstances: "commission" produces an "In commission" label and "suspended" produces a "Suspended" one, to furnish two examples (see the [[Template:S-vac|template page]] for an exhaustive list).

Apart from the standard edition of ''s-vac'', there is also a pair of versions for the cases where title holders are unknown, and thus there are again missing links in the chains of succession, even though the titles were actually occupied at those times. In these occasions, the "last" and "next" parameters are replaced with "unknlast" and "unknnext" respectively, while the "unknown" title parameter ought to be used. This way readers can navigate unobstructed along even incomplete succession chains.

For all four versions there is also an optional "as" parameter, for changes of title names (see the [[#"As" parameter|relevant section]] lower in this page), as well as a "reason" parameter (preferably only used for vacancies), where a brief explanation for the vacancy can be entered.

Note that ''s-vac'' must in every event be preceded (when a predecessor cell) or followed (when a successor cell) by a <nowiki>|-</nowiki> character in succession boxes, because serious errors can occur in the display of these boxes if the character is omitted. The very first and last lines of each table are excepted, as it is not necessary to add the character before the first line and after the last one.

Here follows an example of the usage of ''Template:S-vac'', taken from the article of [[Pycelle]]:

::<nowiki>{{s-start}}</nowiki>
::<nowiki>{{s-bef|before=[[Merion]]}}</nowiki>
::<nowiki>{{s-ttl|title=[[Grand Maester]]|years={{Date|259|300}}}}</nowiki>
::<nowiki>{{s-vac}}</nowiki>
::<nowiki>{{s-end}}</nowiki>

Which will appear like this:

{{s-start}}
{{s-bef|before=[[Merion]]}}
{{s-ttl|title=[[Grand Maester]]|years={{Date|259|300}}}}
{{s-vac}}
{{s-end}}

===Titles and offices===
The only title cell template other than ''s-ttl'' is ''s-tul'' and it is used for titular titles or titles held in pretense. For other forms and functions of ''s-ttl'', see the [[Template:S-start#Additional features|"Additional features"]] section.

====S-tul====
''S-tul'' is used instead of ''s-ttl'' to signify that a title (usually a regnal one) is held by a person, but the power normally associated with it is not. This may take two forms: titular rulers and pretenders.

*Titular rulers are people who legitimately deserve a title yet are somehow incapable of securing it, as in the case of [[Janos Slynt]], [[Lord of Harrenhal]] during the early years of the [[War of the Five Kings]]. Generally, a titular ruler's title will again be inherited by someone with power and remains only temporarily suspended. There is generally only one titular claimant to a title.

*[[Pretender]]s are people who may or may not have a rightful claim to a title, but regardless do not possess any legitimate authority. Examples of this include [[Stannis Baratheon]], [[Renly Baratheon]], [[Daemon I Blackfyre]], etc. Pretenders are not always successive, as titular leaders generally are, and there can be multiple pretenders at the same time (as in the War of the Five Kings).

''S-tul'' is used for the above described cases because of its basic difference from ''s-ttl'': the word "Titular" appears above the title in the displayed cell, and there are formatting differences as well. Apart from the obligatory "title" parameter and the optional but basic "years" parameter (as well as the omnipresent "rows" parameter), this template accepts no parameters.

Here follows an example of the usage of ''Template:S-tul'', taken from the article of [[Janos Slynt]]:

::<nowiki>{{s-start}}</nowiki>
::<nowiki>{{s-bef|before=[[Shella Whent]]}}</nowiki>
::<nowiki>{{s-tul|title=[[Lord of Harrenhal]]|years={{Date|298|299}}}}</nowiki>
::<nowiki>{{s-aft|after=[[Vargo Hoat]]}}</nowiki>
::<nowiki>{{s-end}}</nowiki>

Which will appear like this:

{{s-start}}
{{s-bef|before=[[Shella Whent]]}}
{{s-tul|title=[[Lord of Harrenhal]]|years{{Date|298|299}}}}
{{s-aft|after=[[Vargo Hoat]]}}
{{s-end}}

===Additional features===
As the purpose of succession boxes is to succinctly convey useful information to the readers, there exist parameters that allow the introduction of data into the boxes beyond the already examined capabilities of the succession templates. In particular, there are eleven parameters: the "as" parameter, which is used in predecessor and successor cells, and the "regents" family along with the "alongside," "creation," and "dynasty" parameters for the title cell. All of them are optional.

===="As" parameter====
The parameter ''as'', which can be found in the ''s-bef'', ''s-aft'', and ''s-vac'' templates, is used to inform the reader of a change in the title's name from the previous or next holder. In these cases, even though the title retains more or less the same power and the succession chain is not interrupted, the title's name is different. As readers might be confused to see the title suddenly change during the course of a succession chain, the "as" parameter is used to prepare them for the impending change in both directions, added to both the succession box before and the one after the name change.

Please note that certain changes in title names, like the inclusion in a title of "Queen" instead of "King," or that of other gender-specific words, need not be clarified with the "as" parameter.

Here follows an example of the usage of the "as" parameter, taken from the article of [[Aurane Waters]]:

::<nowiki>{{s-start}}</nowiki>
::<nowiki>{{s-bef|before=[[Mace Tyrell]]|as=[[Master of ships]]}}</nowiki>
::<nowiki>{{s-ttl|title=[[Grand admiral]]|years={{Date|300}}}}</nowiki>
::<nowiki>{{s-aft|after=[[Paxter Redwyne]]|as=[[Master of ships]]}}</nowiki>
::<nowiki>{{s-end}}</nowiki>

Which will appear like this:

{{s-start}}
{{s-bef|before=[[Mace Tyrell]]|as=[[master of ships]]}}
{{s-ttl|title=[[Grand admiral]]|years={{Date|300}}}}
{{s-aft|after=[[Paxter Redwyne]]|as=[[master of ships]]}}
{{s-end}}

===="Regents" parameter====
This is a group of six parameters, which are used exclusively in ''s-ttl'' in order to indicate [[regent|regencies]] and other joint occupations of offices and titles. This characterization applies to occupation of the very same office, and not of similar ones. Each cell supports up to three regents, whose names can be inserted into parameters "regent1", "regent2", and "regent3" respectively; if there are less than three regents only the first one or two parameters need be used.

For each of the regents there is a corresponding parameter for the years during which they held the office jointly with the subject: "years1", "years2", and "years3". If a regent held the title during the entire term of the subject, however, no years are necessary. The order of the regents should be chronological, with the one assuming the office earlier coming first; if a regent held the office throughout the subject's term (no regency dates), that regent ought to have precedence.

Here follows an example of the usage of the "regents" parameter:

::<nowiki>{{s-start}}</nowiki>
::<nowiki>{{s-bef|before=</nowiki>''Insert predecessor here''<nowiki>}}</nowiki>
::<nowiki>{{s-ttl|title=</nowiki>''Insert title of person here''<nowiki>|years=</nowiki>''Insert years here''
::<nowiki>|regent1=</nowiki>''Enter name or title of first (or only) regent''<nowiki>|years1=</nowiki>''Enter first regent's years''<nowiki>}}</nowiki>
::<nowiki>|regent2=</nowiki>''Enter name of title of second regent''<nowiki>|years2=</nowiki>''Enter second regent's years''<nowiki>}}</nowiki>
::<nowiki>|regent3=</nowiki>''Enter name or title of third regent''<nowiki>|years3=</nowiki>''Enter third regent's years''<nowiki>}}</nowiki>
::<nowiki>{{s-aft|after=</nowiki>''Insert successor here''<nowiki>}}</nowiki>
::<nowiki>{{s-end}}</nowiki>

Which looks like:

{{s-start}}
{{s-bef|before=Philip}}
{{s-ttl|title=Queen of Antarctica|years=1889–1914
|regent1=Philip|years1=1889–1897
|regent2=Anthony|years2=1889–1895
|regent3=Elizabeth|years3=1895–1897}}
{{s-aft|after=Margaret}}
{{s-end}}

===="Alongside" parameter====
The purpose of the "alongside" parameter, used in the ''s-ttl'' template, is to show that the subject has served in a parliament or congress for the same constituency, district, state, or other kind of electoral division, as long as that division traditionally elects between two and four representatives. The ultimate number of names that is filled in the parameter is equal to, or greater than, the number of the seats in the district in question minus one, and greatly depends on the length of the subject's term. There are no years for this parameter, and the names are only separated by commas; line breaks (<nowiki><br /></nowiki>) can be used to improve the box's layout.

Here follows one example of the usage of the "alongside" parameter, using a made-up scenario of [[Alios Qhaedar]] being [[Triarch of Volantis]]:

::<nowiki>{{s-start}}</nowiki>
::<nowiki>{{s-bef|before=[[Malaquo Maegyr]]|before2=[[Doniphos Paenymion]]|before3=[[Nyessos Vhassar]]}}</nowiki>
::<nowiki>{{s-ttl|title=[[Triarch of Volantis]]|years={{Date|300}}&nbsp;–present|alongside=[[Parquello Vaelaros]]<br>[[Belicho Staegone]]}}</nowiki>
::<nowiki>{{s-inc}}</nowiki>
::<nowiki>{{s-end}}</nowiki>

Which looks like:

{{s-start}}
{{s-bef|before=[[Malaquo Maegyr]]|before2=[[Doniphos Paenymion]]|before3=[[Nyessos Vhassar]]}}
{{s-ttl|title=[[Triarch of Volantis]]|years={{Date|300}}&nbsp;–present|alongside=[[Parquello Vaelaros]]<br>[[Belicho Staegone]]}}
{{s-inc}}
{{s-end}}

====S-ref====
Template ''s-ref'' exists to provide notes and references related to the information in succession boxes.

''S-ref'' supports up to ten sources/notes, which are entered as follows:

<nowiki>{{s-ref|</nowiki>''Enter source/note 1 here''|''Enter source/note 2 here''|''Enter source/note 3 here''| ... |''Enter source/note 10 here''<nowiki>}}</nowiki>

Only use as many fields as is necessary in each box. It is very important to note that ''s-ref'' already incorporates the function of template ''end'', and it is thus unnecessary to use <nowiki>{{s-end}}</nowiki> to close a succession box when ''s-ref'' is used.

The notes and sources in ''s-ref'' are automatically numbered; they ought to be listed in the template with the order in which the information sourced, or to which the notes refer, is encountered in the box. The resulting numbers should be superscript next to the names, titles, and/or dates to which they refer—to do that, enclose a number in <nowiki><sup> tags like this: <sup>2</sup></nowiki>. (For numbers 1 to 3 one may also use the characters provided in the symbol box under the edit window.)<includeonly>
[[Category:Succession templates|start]]
</includeonly>