View source for Template:S-bef/doc

{{documentation subpage}}
This template creates a single first-column succession box column to be used with [[Template:S-start/doc|succession boxes]].

==Usage==

The format is <code><nowiki>{{</nowiki>s-bef|before=''text''|''parameters''}}</code>, where ''text'' is replaced by the text to be displayed and ''parameters'' is replaced by one or more of the optional parameter names shown below.

; Parameter names
* '''before''' (required) — Predecessor
* '''before2''' (optional) — Second predecessor
* '''before3''' (optional) — Third predecessor
* '''before4''' (optional) — Fourth successor
* '''before5''' (optional) — Fifth predecessor
* '''as''' (optional) — Adds a title line beneath a predecessor's name to designate a change in title
* '''rows''' (optional) — Number of table rows to span

; Usage
<pre style="border: 1px #ccc dashed; background-color: #eee; margin-left: 2em; margin-right: 2em;">
{{S-bef | before= | before2= | before3= | before4= | before5= | as= | rows= }}
</pre>

; Output (raw)
<div style="border: 1px #ccc dashed; background-color: #eee; margin-left: 2em; margin-right: 2em; padding-left: 1em;">
{{Parameter names example | before | before2 | before3 | before4 | before5 | as | rows }}
</div>

; Output (as table cell)
<div style="border: 1px #ccc dashed; background-color: #eee; margin-left: 2em; margin-right: 2em;">
{{S-start}}
{{Parameter names example | before | before2 | before3 | before4 | before5 | as }}
{{S-end}}
</div>

; Output (in succession box, rows=2)
<div style="border: 1px #ccc dashed; background-color: #eee; margin-left: 2em; margin-right: 2em;">
{{S-start}}
{{Parameter names example | before | before2 | before3 | before4 | before5 | as | rows=2 }}
{{S-ttl}}
{{S-aft}}
{{S-ttl}}
{{S-aft}}
{{S-end}}
</div>

==Example==
From the [[Louis XIV of France]] article:

<pre style="width:95%; overflow:auto;">
{{s-start}}
{{s-reg}}
{{s-bef | before = [[Louis XIII of France|Louis XIII]]}}
{{s-ttl | title = [[List of French monarchs|King of France]] and [[List of Navarrese monarchs|Navarre]] | years = 14 May 1643 – 1 September 1715}}
{{s-aft | after = [[Louis XV of France|Louis XV]]}}
{{s-end}}
</pre>

{{s-start}}
{{s-reg}}
{{s-bef | before = [[Louis XIII of France|Louis XIII]]}}
{{s-ttl | title = [[List of French monarchs|King of France]] and [[List of Navarrese monarchs|Navarre]] | years = 14 May 1643 – 1 September 1715}}
{{s-aft | after = [[Louis XV of France|Louis XV]]}}
{{s-end}}

==TemplateData==
{{TemplateData header}}

<templatedata>
{
	"description": "Single first-column succession box column for predecessors.",
	"params": {
		"before": {
			"label": "before",
			"description": "Predecessor",
			"type": "string",
			"required": true
		},
		"before2": {
			"label": "before2",
			"description": "Second predecessor",
			"type": "string",
			"required": false
		},
		"before3": {
			"label": "before3",
			"description": "Third predecessor",
			"type": "string",
			"required": false
		},
		"before4": {
			"label": "before4",
			"description": "Forth predecessor",
			"type": "string",
			"required": false
		},
		"before5": {
			"label": "before5",
			"description": "Fifth predecessor",
			"type": "string",
			"required": false
		},
		"as": {
			"label": "as",
			"description": "Adds a title line beneath a predecessor's name to designate a change in title.",
			"type": "string",
			"required": false
		},
		"rows": {
			"label": "rows",
			"description": "Number of table rows to span",
			"type": "string",
			"required": false
		}
	},
	"format": "block"
}
</templatedata>

==See also==
Documentation for creating succession boxes can be found at [[Template:s-start/doc]].

<includeonly>
[[Category:Succession templates]]
[[Category:Exclude in print]]
</includeonly>