View source for Template:Succession table monarch/doc

{{documentation subpage}}
{{Lua|Module:Succession table monarch}}
This template is intended to standardise monarchical succession tables.

A full listing of parameters follows, with X being replaced by the appropriate row number.

<pre>
{{Succession table monarch
| nameX       = <!-- Mandatory otherwise entire row will not display. -->
| nicknameX   = 
| nativeX     = 
| lifeX       = 
| reignstartX = 
| reignendX   = 
| notesX      = 
| familyX     = 
| imageX      = Example.jpg
| altX        = 
| refX        =
}}</pre>

==Name==
The ''name'' parameter is mandatory when adding a new row otherwise the entire row will not display. If the name is unknown but other information is, simply enter "Unknown" as the name. It is recommended that the name by which the monarch is generally known be bolded.

===East Asian monarchs===
For East Asian monarchies, where sovereigns customarily had several names, use the sub-template {{tl|Succession table monarch/Orient}} in the ''name'' parameter. 

Parameters in this sub-template follow:
<pre>{{Succession table monarch/Orient
| ReignName    = <!-- Reign name -->
| ReignNameNa  = <!-- Reign name in native language -->
| TempleName   = <!-- Temple name -->
| TempleNameNa = <!-- Temple name in native language -->
| KhanName     = <!-- Khan name -->
| KhanNameNa   = <!-- Khan name in native language -->
| CourtName    = <!-- Courtesy name -->
| CourtNameNa  = <!-- Courtesy name in native language -->
| EraName      = <!-- Era name -->
| EraNameNa    = <!-- Era name in native language -->
| PostName     = <!-- Posthumous name -->
| PostNameNa   = <!-- Posthumous name in native language -->
| GivenName    = <!-- Personal name -->
| GivenNameNa  = <!-- Personal name in native language -->
| PsName       = <!-- Pseudonym -->
| PsNameNa     = <!-- Pseudonym in native language -->
}}</pre>

===Egypt===
For Egypt and related states, use the sub-template {{tl|Succession table monarch/Egypt}} in the ''name'' parameter. 

Parameters in this sub-template follow.
<pre>{{Succession table monarch/Egypt
| Common       = <!-- Name in general usage -->
| Horus        = <!-- Horus name -->
| Nebty        = <!-- Nebty (Two Ladies) name -->
| GoldHorus    = <!-- Golden Horus name -->
| Praenomen    = <!-- Praenomen or Throne name -->
| Nomen        = <!-- Nomen or Personal name -->
}}</pre>

==Optional parameters==
; ''nicknameX''
: The person's main nickname. It is automatically italicised.

; ''nativeX''
: The person's name in their native language or languages. Where appropriate, use a [[:Category:Wikipedia multilingual support templates|multilingual support template]] such as {{tl|Lang-no}} or {{tl|Lang-uz}}.

; ''lifeX''
: For preference, use an [[Wikipedia:Age calculation templates|age calculation template]] here rather than bare dates.

; ''reignstartX''
: Date or year the person's reign commenced. Otherwise enter "unknown".

; ''reignendX''
: Date or year the person's reign ended. Otherwise, enter "unknown" or "incumbent", as applicable.

; ''notesX''
: This space is mainly for succession information, but other significant data can be added as long as it is succinct. For longer notes, either use ref tags to create a ''Notes'' section later in the article, or add it to the appropriate article rather than here.
: Examples of information that can be added:
:::"Son of..."
:::"Elected after disputed succession"
:::"Second reign"
:::"First female sovereign"

; ''familyX''
: Name of dynasty/house/family. Can be used in cases of elective succession as well as the commoner dynastic succession.

; ''imageX''
: Image size is set at 80px. Square brackets are not needed.

; ''altX''
: Alternative text for image.

==All parameters==
{{collapse top|title=The template with all parameters numbered}}
<pre>{{Succession table monarch
| name1       = 
| nickname1   = 
| native1     = 
| life1       = 
| reignstart1 = 
| reignend1   = 
| notes1      = 
| family1     = 
| image1      = 
| alt1        = 

| name2       = 
| nickname2   = 
| native2     = 
| life2       = 
| reignstart2 = 
| reignend2   = 
| notes2      = 
| family2     = 
| image2      = 
| alt2        = 

| name3       = 
| nickname3   = 
| native3     = 
| life3       = 
| reignstart3 = 
| reignend3   = 
| notes3      = 
| family3     = 
| image3      = 
| alt3        = 

| name4       = 
| nickname4   = 
| native4     = 
| life4       = 
| reignstart4 = 
| reignend4   = 
| notes4      = 
| family4     = 
| image4      = 
| alt4        = 

| name5       = 
| nickname5   = 
| native5     = 
| life5       = 
| reignstart5 = 
| reignend5   = 
| notes5      = 
| family5     = 
| image5      = 
| alt5        = 

| name6       = 
| nickname6   = 
| native6     = 
| life6       = 
| reignstart6 = 
| reignend6   = 
| notes6      = 
| family6     = 
| image6      = 
| alt6        = 

| name7       = 
| nickname7   = 
| native7     = 
| life7       = 
| reignstart7 = 
| reignend7   = 
| notes7      = 
| family7     = 
| image7      = 
| alt7        = 

| name8       = 
| nickname8   = 
| native8     = 
| life8       = 
| reignstart8 = 
| reignend8   = 
| notes8      = 
| family8     = 
| image8      = 
| alt8        = 

| name9       = 
| nickname9   = 
| native9     = 
| life9       = 
| reignstart9 = 
| reignend9   = 
| notes9      = 
| family9     = 
| image9      = 
| alt9        = 

| name10       = 
| nickname10   = 
| native10     = 
| life10       = 
| reignstart10 = 
| reignend10   = 
| notes10      = 
| family10     = 
| image10      = 
| alt10        = 

| name11       = 
| nickname11   = 
| native11     = 
| life11       = 
| reignstart11 = 
| reignend11   = 
| notes11      = 
| family11     = 
| image11      = 
| alt11        = 

| name12       = 
| nickname12   = 
| native12     = 
| life12       = 
| reignstart12 = 
| reignend12   = 
| notes12      = 
| family12     = 
| image12      = 
| alt12        = 

| name13       = 
| nickname13   = 
| native13     = 
| life13       = 
| reignstart13 = 
| reignend13   = 
| notes13      = 
| family13     = 
| image13      = 
| alt13        = 

| name14       = 
| nickname14   = 
| native14     = 
| life14       = 
| reignstart14 = 
| reignend14   = 
| notes14      = 
| family14     = 
| image14      = 
| alt14        = 

| name15       = 
| nickname15   = 
| native15     = 
| life15       = 
| reignstart15 = 
| reignend15   = 
| notes15      = 
| family15     = 
| image15      = 
| alt15        = 

| name16       = 
| nickname16   = 
| native16     = 
| life16       = 
| reignstart16 = 
| reignend16   = 
| notes16      = 
| family16     = 
| image16      = 
| alt16        = 

| name17       = 
| nickname17   = 
| native17     = 
| life17       = 
| reignstart17 = 
| reignend17   = 
| notes17      = 
| family17     = 
| image17      = 
| alt17        = 

| name18       = 
| nickname18   = 
| native18     = 
| life18       = 
| reignstart18 = 
| reignend18   = 
| notes18      = 
| family18     = 
| image18      = 
| alt18        = 

| name19       = 
| nickname19   = 
| native19     = 
| life19       = 
| reignstart19 = 
| reignend19   = 
| notes19      = 
| family19     = 
| image19      = 
| alt19        = 

| name20       = 
| nickname20   = 
| native20     = 
| life20       = 
| reignstart20 = 
| reignend20   = 
| notes20      = 
| family20     = 
| image20      = 
| alt20        = 

| name21       = 
| nickname21   = 
| native21     = 
| life21       = 
| reignstart21 = 
| reignend21   = 
| notes21      = 
| family21     = 
| image21      = 
| alt21        = 

| name22       = 
| nickname22   = 
| native22     = 
| life22       = 
| reignstart22 = 
| reignend22   = 
| notes22      = 
| family22     = 
| image22      = 
| alt22        = 

| name23       = 
| nickname23   = 
| native23     = 
| life23       = 
| reignstart23 = 
| reignend23   = 
| notes23      = 
| family23     = 
| image23      = 
| alt23        = 

| name24       = 
| nickname24   = 
| native24     = 
| life24       = 
| reignstart24 = 
| reignend24   = 
| notes24      = 
| family24     = 
| image24      = 
| alt24        = 

| name25       = 
| nickname25   = 
| native25     = 
| life25       = 
| reignstart25 = 
| reignend25   = 
| notes25      = 
| family25     = 
| image25      = 
| alt25        = 

| name26       = 
| nickname26   = 
| native26     = 
| life26       = 
| reignstart26 = 
| reignend26   = 
| notes26      = 
| family26     = 
| image26      = 
| alt26        = 

| name27       = 
| nickname27   = 
| native27     = 
| life27       = 
| reignstart27 = 
| reignend27   = 
| notes27      = 
| family27     = 
| image27      = 
| alt27        = 

| name28       = 
| nickname28   = 
| native28     = 
| life28       = 
| reignstart28 = 
| reignend28   = 
| notes28      = 
| family28     = 
| image28      = 
| alt28        = 

| name29       = 
| nickname29   = 
| native29     = 
| life29       = 
| reignstart29 = 
| reignend29   = 
| notes29      = 
| family29     = 
| image29      = 
| alt29        = 

| name30       = 
| nickname30   = 
| native30     = 
| life30       = 
| reignstart30 = 
| reignend30   = 
| notes30      = 
| family30     = 
| image30      = 
| alt30        = 
}}</pre>
{{collapse bottom}}

==Examples==
Basic examples of this template's usage follow. Note the use of the ''nickname'' and ''native'' parameters.

<pre>{{Succession table monarch
| name1       = '''[[Elizabeth I]]'''
| nickname1   = The Virgin Queen
| life1       = {{Birth date|1533|9|7|df=y}} - {{Death date and age|1603|3|24|1533|9|7|df=y}}
| reignstart1 = 17 November 1558
| reignend1   = 1603
| notes1      = Daughter of [[Henry VIII]] and [[Anne Boleyn]]
| family1     = [[Tudor dynasty|Tudor]]
| image1      = Elizabeth I in coronation robes.jpg
| alt1        = Elizabeth I
| name2       = '''[[Jigme Khesar Namgyel Wangchuck|Jigme Khesar Namgyel]]'''
| native2     = {{lang-dz|འཇིགས་མེད་གེ་སར་རྣམ་རྒྱལ་དབང་ཕྱུག་}}
| life2       = b. 21 February 1980
| reignstart2 = 14 December 2006
| reignend2   = ''incumbent''
| notes2      = Son of [[Jigme Singye Wangchuck|Jigme Singye]]
| family2     = [[House of Wangchuck|Wangchuck]]
| image2      = 
| alt2        = 
}}</pre>
{{Succession table monarch
| name1       = '''[[Elizabeth I]]'''
| nickname1   = The Virgin Queen
| life1       = {{Birth date|1533|9|7|df=y}} - {{Death date and age|1603|3|24|1533|9|7|df=y}}
| reignstart1 = 17 November 1558
| reignend1   = 1603
| notes1      = Daughter of [[Henry VIII of England|Henry VIII]] and [[Anne Boleyn]]
| family1     = [[Tudor dynasty|Tudor]]
| image1      = Elizabeth I in coronation robes.jpg
| alt1        = Elizabeth I
| name2       = '''[[Jigme Khesar Namgyel Wangchuck|Jigme Khesar Namgyel]]'''
| native2     = {{lang-dz|འཇིགས་མེད་གེ་སར་རྣམ་རྒྱལ་དབང་ཕྱུག་}}
| life2       = b. 21 February 1980
| reignstart2 = 14 December 2006
| reignend2   = ''incumbent''
| notes2      = Son of [[Jigme Singye Wangchuck|Jigme Singye]]
| family2     = [[House of Wangchuck|Wangchuck]]
| image2      = 
| alt2        = 
}}

The following examples demonstrate the use of {{tl|Succession table monarch/Orient}}.
<pre>{{Succession table monarch
| name1       = {{Succession table monarch/Orient
 | ReignName    = '''[[Guangxu Emperor|Guāngxù]]'''
 | ReignNameNa  = 光緒
 | TempleName   = Dézōng
 | TempleNameNa = 德宗
 | PostName     = Jǐngdì
 | PostNameNa   = 景帝
 | GivenName    = Zǎitián
 | GivenNameNa  = 載湉
 }}
| life1       = {{Birth date|1871|8|14|df=y}} - {{Death date and age|1908|11|14|1871|8|14|df=y}}
| reignstart1 = 25 February, 1875
| reignend1   = 14 November, 1908
| notes1      = Nephew of [[Empress Dowager Cixi]]
| family1     = [[Aisin Gioro|House of Aisin Gioro]]
| image1      = Emperor Guangxu.jpg
| alt1        = The Guangxu Emperor
| name2       = {{Succession table monarch/Orient
 | PostName     = '''[[Empress Genmei|Genmei]]'''
 | PostNameNa   = 元明天皇
 | GivenName    = Abe-hime
 }}
| life2       = 660 – {{Death date and age|721|12|29|660|2|4|df=y}}
| reignstart2 = 707
| reignend2   = 715
| notes2      = Daughter of [[Emperor Tenmu]]
| family2     = [[Imperial House of Japan|Yamato]]
| image2      = 
| alt2        = 
| name3       = {{Succession table monarch/Orient
 | TempleName   = '''[[Sejong the Great]]'''
 | TempleNameNa = 세종
 | GivenName    = Yi Do
 | GivenNameNa  = 이도
 }}
| life3       = {{Birth date|1397|5|7|df=y}} - {{death date and age|1450|5|18|1397|5|6|df=y}}
| reignstart3 = 18 September 1418
| reignend3   = 18 May 1450
| notes3      = Son of [[Taejong of Joseon|Taejong]].
| family3     = [[House of Yi|Yi]]
| image3      = 
| alt3        = 
| name4       = {{Succession table monarch/Orient
 | EraName      = '''[[Gia Long]]'''
 | PostName     = Thế Tổ Cao Hoàng đế
 | TempleName   = Nguyễn Thế Tổ
 | GivenName    = Nguyễn Phúc Ánh
 }}
| life4       = {{Birth date|1762|2|8|df=y}} – {{Death date and age|1820|2|3|1762|2|8|df=y}}
| reignstart4 = 1802
| reignend4   = 3 February, 1820
| notes4      = Established Nguyễn dynasty
| family4     = [[Nguyễn Dynasty|Nguyễn]]
| image4      = GiaLong.jpg
| alt4        = Gia Long
}}</pre>
{{Succession table monarch
| name1       = {{Succession table monarch/Orient
 | ReignName    = '''[[Guangxu Emperor|Guāngxù]]'''
 | ReignNameNa  = 光緒
 | TempleName   = Dézōng
 | TempleNameNa = 德宗
 | PostName     = Jǐngdì
 | PostNameNa   = 景帝
 | GivenName    = Zǎitián
 | GivenNameNa  = 載湉
 }}
| life1       = {{Birth date|1871|8|14|df=y}} - {{Death date and age|1908|11|14|1871|8|14|df=y}}
| reignstart1 = 25 February 1875
| reignend1   = 14 November 1908
| notes1      = Nephew of [[Empress Dowager Cixi]]
| family1     = [[Aisin Gioro|House of Aisin Gioro]]
| image1      = Emperor Guangxu.jpg
| alt1        = The Guangxu Emperor
| name2       = {{Succession table monarch/Orient
 | PostName     = '''[[Empress Genmei|Genmei]]'''
 | PostNameNa   = 元明天皇
 | GivenName    = Abe-hime
 }}
| life2       = 660 – {{Death date and age|721|12|29|660|2|4|df=y}}
| reignstart2 = 707
| reignend2   = 715
| notes2      = Daughter of [[Emperor Tenmu]]
| family2     = [[Imperial House of Japan|Yamato]]
| image2      = 
| alt2        = 
| name3       = {{Succession table monarch/Orient
 | TempleName   = '''[[Sejong the Great]]'''
 | TempleNameNa = 세종
 | GivenName    = Yi Do
 | GivenNameNa  = 이도
 }}
| life3       = {{Birth date|1397|5|7|df=y}} - {{death date and age|1450|5|18|1397|5|6|df=y}}
| reignstart3 = 18 September 1418
| reignend3   = 18 May 1450
| notes3      = Son of [[Taejong of Joseon|Taejong]].
| family3     = [[House of Yi|Yi]]
| image3      = 
| alt3        = 
| name4       = {{Succession table monarch/Orient
 | EraName      = '''[[Gia Long]]'''
 | PostName     = Thế Tổ Cao Hoàng đế
 | TempleName   = Nguyễn Thế Tổ
 | GivenName    = Nguyễn Phúc Ánh
 }}
| life4       = {{Birth date|1762|2|8|df=y}} – {{Death date and age|1820|2|3|1762|2|8|df=y}}
| reignstart4 = 1802
| reignend4   = 3 February 1820
| notes4      = Established Nguyễn dynasty
| family4     = [[Nguyễn Dynasty|Nguyễn]]
| image4      = GiaLong.jpg
| alt4        = Gia Long
}}

The following example demonstrates the use of {{tl|Succession table monarch/Egypt}}.
<pre>{{Succession table monarch
| name1       = {{Succession table monarch/Egypt
 | Common       = '''[[Thutmose III]]'''
 | Horus        = Kanakht Khaemwaset
 | Nebty        = Wahnesytmireempet
 | GoldHorus    = Sekhempahtydsejerkhaw
 | Praenomen    = Menkheperre
 | Nomen        = Thutmose Neferkheperu
 }}
| life1       = d. 1425 BC
| reignstart1 = 1479 BC
| reignend1   = 1425 BC
| notes1      = Son of Thutmose II
| family1     = [[Eighteenth dynasty of Egypt|Thutmosid Dynasty]]
| image1      = TuthmosisIII-2.JPG
| alt1        = Thutmose III
}}</pre>
{{Succession table monarch
| name1       = {{Succession table monarch/Egypt
 | Common       = '''[[Thutmose III]]'''
 | Horus        = Kanakht Khaemwaset
 | Nebty        = Wahnesytmireempet
 | GoldHorus    = Sekhempahtydsejerkhaw
 | Praenomen    = Menkheperre
 | Nomen        = Thutmose Neferkheperu
 }}
| life1       = d. 1425 BC
| reignstart1 = 1479 BC
| reignend1   = 1425 BC
| notes1      = Son of Thutmose II
| family1     = [[Eighteenth dynasty of Egypt|Thutmosid Dynasty]]
| image1      = TuthmosisIII-2.JPG
| alt1        = Thutmose III
}}

<includeonly>{{Sandbox other||
<!-- Add categories below-->
[[Category:Succession templates]]
[[Category:Royalty and nobility templates]]
<!-- Add interwikis below-->

}}</includeonly>