Template:S-ttl/doc

From Roovet Articles
Jump to navigation Jump to search

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

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.
  • 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)

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

{{{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 (in succession box, rows=2)

Preceded by
{{{before}}}
{{{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}}})
Succeeded by
{{{after}}}
Preceded by
{{{before}}}
Succeeded by
{{{after}}}

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
Earl of Cornwall
7th creation
4 March 1857 – 21 January 1861
Succeeded by

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
Preceded by Senator from Mississippi (Class 1)
March 4, 1857 – January 21, 1861
Served alongside: Albert G. Brown
Succeeded by

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
Preceded by 28th President of the United States
1913–1921
Succeeded by

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this 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.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
titletitle

Text to be displayed for title.

Stringrequired
orderorder

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
Stringoptional
districtdistrict

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

Stringoptional
dynastydynasty

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

Stringoptional
creationcreation

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

Stringoptional
yearsyears

Years served in office, typically a range of dates.

Stringsuggested
regent1regent1

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.

Stringoptional
years1years1

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

Stringoptional
regent2regent2

no description

Stringoptional
years2years2

no description

Stringoptional
regent3regent3

no description

Stringoptional
years3years3

no description

Stringoptional
regent4regent4

no description

Stringoptional
years4years4

no description

Stringoptional
regent5regent5

no description

Stringoptional
years5years5

no description

Stringoptional
regent6regent6

no description

Stringoptional
years6years6

no description

Stringoptional
regent7regent7

no description

Stringoptional
years7years7

no description

Stringoptional
regent8regent8

no description

Stringoptional
years8years8

no description

Stringoptional
alongsidealongside

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

Stringoptional
underunder

This parameter is reserved for political positions that are subordinate to others.

Stringoptional
withwith

For use when an office is shared with one or more others.

Stringoptional
with2with2

no description

Stringoptional
with3with3

no description

Stringoptional
with4with4

no description

Stringoptional
with5with5

no description

Stringoptional
with6with6

no description

Stringoptional
with7with7

no description

Stringoptional
with8with8

no description

Stringoptional
with9with9

no description

Stringoptional
with10with10

no description

Stringoptional
with11with11

no description

Stringoptional
with12with12

no description

Stringoptional
with13with13

no description

Stringoptional
with14with14

no description

Stringoptional
with15with15

no description

Stringoptional
with16with16

no description

Stringoptional
with17with17

no description

Stringoptional
with18with18

no description

Stringoptional
with19with19

no description

Stringoptional
with20with20

no description

Stringoptional
with21with21

no description

Stringoptional
with22with22

no description

Stringoptional
with23with23

no description

Stringoptional
with24with24

no description

Stringoptional
with25with25

no description

Stringoptional
lordslords

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

Stringoptional
rowsrows

Number of table rows this entry should span.

Stringoptional

See also

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