Template:S-ttl/doc

{{Documentation subpage}}

This template creates a single succession box center column to be used with succession boxes for the function of listing titles.

{{High-risk|200,000+}}

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 {{tag|br|s}} 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.
  • regent1regent8 AND years1years8 (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.
  • withwith25 (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)

{{Parameter names example | title | order | district | dynasty | creation | years | regent1 | years1 | regent2 | years2 | regent3=... | years3=... | regent8 | years8 | alongside | under | with | with2 | with3=... | with25 | lords | rows }}

Output (as table cell)

{{S-start}}

{{Parameter names example | title | order | district | dynasty | creation | years | regent1 | years1 | regent2 | years2 | regent3=... | years3=... | regent8 | years8 | alongside | under | with | with2 | with3=... | with25 | lords }}

{{S-end}}

Output (in succession box, rows=2)

{{S-start}}

{{S-bef}}

{{Parameter names example | rows=2 | title | order | district | dynasty | creation | years | regent1 | years1 | regent2 | years2 | regent3=... | years3=... | regent8 | years8 | alongside | under | with | with2 | with3=... | with25 | lords }}

{{S-aft}}

{{S-bef}}

{{S-aft}}

{{S-end}}

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

{{s-end}}

{{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}}

{{s-end}}

From the Jefferson Davis article:

{{s-start}}

{{s-par | us-sen}}

{{s-bef | before=Stephen Adams}}

{{s-ttl | title=Senator from Mississippi (Class 1)

| years=March 4, 1857 – January 21, 1861

| alongside=Albert G. Brown}}

{{s-aft|after=Adalbert Ames}}

{{s-end}}

{{s-start}}

{{s-par | us-sen}}

{{s-bef | before=Stephen Adams}}

{{s-ttl | title=Senator from Mississippi (Class 1)

| years=March 4, 1857 – January 21, 1861

| alongside=Albert G. Brown}}

{{s-aft|after=Adalbert Ames}}

{{s-end}}

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

{{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}}

TemplateData

{{TemplateData header}}

{

"description": "This template creates a single succession box center column to be used with succession boxes for the function of listing titles.",

"params": {

"title": {

"label": "title",

"description": "Text to be displayed for title.",

"type": "string",

"required": true

},

"order": {

"label": "order",

"description": "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.",

"example": "28th",

"type": "string",

"required": false

},

"district": {

"label": "district",

"description": "For use with parliamentary offices. Insert as a wikilink the district represented during the tenure in office.",

"type": "string",

"required": false

},

"dynasty": {

"label": "dynasty",

"description": "Adds a sub-line beneath the title that allows for a 'dynasty' number for certain royal dynastic lines (such as the Pharaohs of Egypt).",

"type": "string",

"required": false

},

"creation": {

"label": "creation",

"description": "Adds a sub-line beneath the title that allows for a 'creation' number for certain noble titles (such as the Dukes of Cornwall).",

"type": "string",

"required": false

},

"years": {

"label": "years",

"description": "Years served in office, typically a range of dates.",

"type": "string",

"required": false,

"suggested": true

},

"regent1": {

"label": "regent1",

"description": "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.",

"type": "string",

"required": false

},

"years1": {

"label": "years1",

"description": "Time regent1 served. Should only contain years, not days or months.",

"type": "string",

"required": false

},

"regent2": {

"label": "regent2",

"type": "string",

"required": false

},

"years2": {

"label": "years2",

"type": "string",

"required": false

},

"regent3": {

"label": "regent3",

"type": "string",

"required": false

},

"years3": {

"label": "years3",

"type": "string",

"required": false

},

"regent4": {

"label": "regent4",

"type": "string",

"required": false

},

"years4": {

"label": "years4",

"type": "string",

"required": false

},

"regent5": {

"label": "regent5",

"type": "string",

"required": false

},

"years5": {

"label": "years5",

"type": "string",

"required": false

},

"regent6": {

"label": "regent6",

"type": "string",

"required": false

},

"years6": {

"label": "years6",

"type": "string",

"required": false

},

"regent7": {

"label": "regent7",

"type": "string",

"required": false

},

"years7": {

"label": "years7",

"type": "string",

"required": false

},

"regent8": {

"label": "regent8",

"type": "string",

"required": false

},

"years8": {

"label": "years8",

"type": "string",

"required": false

},

"alongside": {

"label": "alongside",

"description": "This parameter is reserved for political positions where two people share power, such as US senators.",

"type": "string",

"required": false

},

"under": {

"label": "under",

"description": "This parameter is reserved for political positions that are subordinate to others.",

"type": "string",

"required": false

},

"with": {

"label": "with",

"description": "For use when an office is shared with one or more others.",

"type": "string",

"required": false

},

"with2": {

"label": "with2",

"type": "string",

"required": false

},

"with3": {

"label": "with3",

"type": "string",

"required": false

},

"with4": {

"label": "with4",

"type": "string",

"required": false

},

"with5": {

"label": "with5",

"type": "string",

"required": false

},

"with6": {

"label": "with6",

"type": "string",

"required": false

},

"with7": {

"label": "with7",

"type": "string",

"required": false

},

"with8": {

"label": "with8",

"type": "string",

"required": false

},

"with9": {

"label": "with9",

"type": "string",

"required": false

},

"with10": {

"label": "with10",

"type": "string",

"required": false

},

"with11": {

"label": "with11",

"type": "string",

"required": false

},

"with12": {

"label": "with12",

"type": "string",

"required": false

},

"with13": {

"label": "with13",

"type": "string",

"required": false

},

"with14": {

"label": "with14",

"type": "string",

"required": false

},

"with15": {

"label": "with15",

"type": "string",

"required": false

},

"with16": {

"label": "with16",

"type": "string",

"required": false

},

"with17": {

"label": "with17",

"type": "string",

"required": false

},

"with18": {

"label": "with18",

"type": "string",

"required": false

},

"with19": {

"label": "with19",

"type": "string",

"required": false

},

"with20": {

"label": "with20",

"type": "string",

"required": false

},

"with21": {

"label": "with21",

"type": "string",

"required": false

},

"with22": {

"label": "with22",

"type": "string",

"required": false

},

"with23": {

"label": "with23",

"type": "string",

"required": false

},

"with24": {

"label": "with24",

"type": "string",

"required": false

},

"with25": {

"label": "with25",

"type": "string",

"required": false

},

"lords": {

"label": "lords",

"description": "Designates that the person was a member of the House of Lords. The dates they served in the house should be specified.",

"type": "string",

"required": false

},

"rows": {

"label": "rows",

"description": "Number of table rows this entry should span.",

"type": "string",

"required": false

}

},

"format": "block"

}

See also

Documentation for creating succession boxes can be found at Template:S-start/doc.

{{Sandbox other||

Category:Succession templates

}}