Editing Template:S-start/doc (section)

===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>