Template: Marriage/doc
From Break Into Chat - BBS wiki
40px | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
Usage
{{Marriage}} takes up to three unnamed parameters – plus either, both or neither of the named parameters |()=
and |end=
– to produce output such as the following:
- Jane Doe (m. 1895–1905)
- Fred Smith (m. 2010)
- Jack Ripper (m. 1885; d. 1888)
- Frank Lee & Aynee Text (m. 2002–13)
The above were produced by:
{{marriage |[[John Doe|Jane Doe]] |1 January 1895 |December 31, 1905}}
{{marriage |Fred Smith |()=smaller |2010}}
{{marriage |Jack Ripper |1885 |July 27, 1888 |end=d.}}
{{marriage|()=small |Frank Lee & Aynee Text |2002 |2013}}
Syntax and parameters
{{marriage [| ()= ]| <text> | <start date> | <end date> [| end= ]}}
Parameter Description () Set |()=small
or |()=smaller
to reduce the font-size used for the parenthesis. (See second and fourth examples above.) <text> Some text – usually a spouse's name – preceding the parenthesis carrying the marriage date/s, etc.
- <start date>
- <end date>
Only the year within each of these will be displayed. If either has more information (e.g., month, day), it is given via a tooltip; i.e., {{Abbr}}. (See first and third examples above.) end Reason for marriage's end.
d, d., or died includes d. within the parentheses if the marriage ended on the death of the spouse.
div, div., or divorced includes div. within the parentheses.
Otherwise, |end=item
includes customised text. For example:
{{marriage |Miss Doe |January 1, 1882 |December 31, 1905 |end=annulled}}
which produces: Miss Doe (m. 1882; annulled 1905)
TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Marriage in articles based on its TemplateData.
TemplateData for Marriage
<templatedata>{
"description": "insert description here",
"params": {
"1": {
"label": "Spouse's name",
"description": "Name of the person to whom the subject is married.",
"type": "string",
"default": "",
"required": true,
"aliases": [ "spouse" ]
},
"2": {
"label": "Date married",
"description": "Date the marriage began.",
"type": "string",
"default": "",
"required": true,
"aliases": [ "date" ]
},
"3": {
"label": "Date ended",
"description": "Date the marriage was dissolved or the spouse of the article's subject died.",
"type": "string",
"default": "",
"required": false,
"aliases": [ "end" ]
}
}
}</templatedata>