Template:S-ttl/doc
This is a documentation subpage for Template:S-ttl
(see that page for the template itself). It contains usage information, categories, and other content that is not part of the original template page. |
This template creates a single succession box center column to be used with succession boxes for the function of listing titles.
This template is used on 200,000+ pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages, or in your own user space. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
Usage
The format is {{s-ttl|title=enter title here|years=enter years title was held here|parameter=}}
, where parameter= can be any of the optional parameters listed below.
Usage note: Any parameter displayed in italics or bold in the example below must not contain line breaks in the wikitext; for values with multiple lines, use <br />
instead of a manual line break.
Parameter names
- title (required) — Text to be displayed for title.
- order (optional) — Indicates the nth person to hold a given office. For use with offices that have a recognized sequence. E.g. 28th
- district (optional) — For use with parliamentary offices. Insert as a wikilink the district represented during the tenure in office.
- dynasty (optional) — Adds a sub-line beneath the title that allows for a "dynasty" number for certain royal dynastic lines (such as the Pharaohs of Egypt).
- creation (optional) — Adds a sub-line beneath the title that allows for a "creation" number for certain noble titles (such as the Dukes of Cornwall).
- years (optional) — Years served in office, typically a range of dates.
- regent1–regent8 AND years1–years8 (optional) — These parameters can be used when an office is held in tandem with another person. Examples of this include co-rulers of a country or region and regencies. It does not include consorts or sub-positions such as vice presidencies. The "years" parameter should only contain years, not days or months, but all other guidelines rules apply.
- alongside (optional) — This parameter is reserved for political positions where two people share power, such as US senators.
- under (optional) — This parameter is reserved for political positions that are subordinate to others, such as Lieutenant Governors serving under Governors.
- with–with25 (optional) — Alternative parameter for use when an office is shared with one or more others
- lords (optional) — Designates that the person was a member of the House of Lords. The parameter is asking for the dates they served in the house.
- rows (optional) — Number of table rows this entry should span.
Usage
{{S-ttl | title= | order= | district= | dynasty= | creation= | years= | regent1= | years1= | regent2= | years2= | regent3= | years3= | regent4= | years4= | regent5= | years5= | regent6= | years6= | regent7= | years7= | regent8= | years8= | alongside= | under= | with= | with2= | with3= | with4= | with5= | with6= | with7= | with8= | with9= | with10= | with11= | with12= | with13= | with14= | with15= | with16= | with17= | with18= | with19= | with20= | with21= | with22= | with23= | with24= | with25= | lords= | rows= }}
Output (raw)
| style="width: 40%; text-align: center;" rowspan="{{{rows}}}"|{{{order}}} {{{title}}}
Representative for {{{district}}}
{{{dynasty}}}
{{{creation}}}
{{{years}}}
with {{{regent1}}} ({{{years1}}})
{{{regent2}}} ({{{years2}}})
... (...)
{{{regent8}}} ({{{years8}}})
Served alongside: {{{alongside}}}
Served under: {{{under}}}
With: {{{with}}}
{{{with2}}}
...
{{{with25}}}
Member of the House of Lords
({{{lords}}})
Output (as table cell)
Output (in succession box, rows=2)
Examples
From the Richard, 1st Earl of Cornwall article:
{{s-start}} {{s-reg | en}} {{s-new | creation}} {{s-ttl | title=[[Earl of Cornwall]] | creation=7th creation | years=4 March 1857 – 21 January 1861}} {{s-aft | after=[[Edmund, 2nd Earl of Cornwall|Edmund]]}} {{s-end}}Template:S-regTemplate:S-new
From the Jefferson Davis article:
{{s-start}} {{s-par | us-sen}} {{s-bef | before=[[Stephen Adams (politician)|Stephen Adams]]}} {{s-ttl | title=[[List of United States senators from Mississippi|Senator from Mississippi (Class 1)]] | years=March 4, 1857 – January 21, 1861 | alongside=[[Albert G. Brown]]}} {{s-aft|after=[[Adalbert Ames]]}} {{s-end}}Template:S-par
From the Woodrow Wilson article:
{{s-start}} {{s-off}} {{s-bef|before=[[William Howard Taft]]}} {{s-ttl|title=[[President of the United States]]|order=28th|years=1913–1921}} {{s-aft|After=[[Warren G. Harding]]}} {{s-end}}Template:S-off
TemplateData
TemplateData for S-ttl
This template creates a single succession box center column to be used with succession boxes for the function of listing titles.
Parameter | Description | Type | Status | |
---|---|---|---|---|
title | title | Text to be displayed for title. | String | required |
order | order | Indicates the nth person to hold a given office. Should always be used in numerical, not written form. For use with offices that have a recognized sequence.
| String | optional |
district | district | For use with parliamentary offices. Insert as a wikilink the district represented during the tenure in office. | String | optional |
dynasty | dynasty | Adds a sub-line beneath the title that allows for a 'dynasty' number for certain royal dynastic lines (such as the Pharaohs of Egypt). | String | optional |
creation | creation | Adds a sub-line beneath the title that allows for a 'creation' number for certain noble titles (such as the Dukes of Cornwall). | String | optional |
years | years | Years served in office, typically a range of dates. | String | suggested |
regent1 | regent1 | Used when an office is held in tandem with another person. Examples of this include co-rulers of a country or region and regencies. It does not include consorts or sub-positions such as vice presidencies. | String | optional |
years1 | years1 | Time regent1 served. Should only contain years, not days or months. | String | optional |
regent2 | regent2 | no description | String | optional |
years2 | years2 | no description | String | optional |
regent3 | regent3 | no description | String | optional |
years3 | years3 | no description | String | optional |
regent4 | regent4 | no description | String | optional |
years4 | years4 | no description | String | optional |
regent5 | regent5 | no description | String | optional |
years5 | years5 | no description | String | optional |
regent6 | regent6 | no description | String | optional |
years6 | years6 | no description | String | optional |
regent7 | regent7 | no description | String | optional |
years7 | years7 | no description | String | optional |
regent8 | regent8 | no description | String | optional |
years8 | years8 | no description | String | optional |
alongside | alongside | This parameter is reserved for political positions where two people share power, such as US senators. | String | optional |
under | under | This parameter is reserved for political positions that are subordinate to others. | String | optional |
with | with | For use when an office is shared with one or more others. | String | optional |
with2 | with2 | no description | String | optional |
with3 | with3 | no description | String | optional |
with4 | with4 | no description | String | optional |
with5 | with5 | no description | String | optional |
with6 | with6 | no description | String | optional |
with7 | with7 | no description | String | optional |
with8 | with8 | no description | String | optional |
with9 | with9 | no description | String | optional |
with10 | with10 | no description | String | optional |
with11 | with11 | no description | String | optional |
with12 | with12 | no description | String | optional |
with13 | with13 | no description | String | optional |
with14 | with14 | no description | String | optional |
with15 | with15 | no description | String | optional |
with16 | with16 | no description | String | optional |
with17 | with17 | no description | String | optional |
with18 | with18 | no description | String | optional |
with19 | with19 | no description | String | optional |
with20 | with20 | no description | String | optional |
with21 | with21 | no description | String | optional |
with22 | with22 | no description | String | optional |
with23 | with23 | no description | String | optional |
with24 | with24 | no description | String | optional |
with25 | with25 | no description | String | optional |
lords | lords | Designates that the person was a member of the House of Lords. The dates they served in the house should be specified. | String | optional |
rows | rows | Number of table rows this entry should span. | String | optional |
See also
Documentation for creating succession boxes can be found at Template:S-start/doc.