Difference between revisions of "Template:Marriage/doc"
en>DrKay (→Syntax and parameters: not an abbr) |
(No difference)
|
Revision as of 09:21, 10 December 2018
This is a documentation subpage for Template:Marriage. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 19,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
Usage
This template is intended for use in infoboxes; specifically {{Infobox person}} and templates calling Infobox person.
{{Marriage}} takes up to three unnamed parameters (name, start date, end date)—plus an optional named parameter |end=
—to produce output such as the following:
- Fred Smith (m. 2010)
- Jane Smith
(m. 1885; died 1888) - Frank Lee (m. 2002–2013)
The above were produced by:
{{marriage |[[John Doe|Jane Doe]] |1 January 1895 |December 31, 1905}}
{{marriage |Fred Smith |2010}}
{{marriage |Jane Smith |1885 |July 27, 1888 |end=d.}}
{{marriage |Frank Lee |2002 |2013}}
In an infobox
Infobox person | |
---|---|
Spouse(s) |
|
Infoboxes already reduce text size to 88%, and MOS:FONTSIZE sets a lower limit for text size at 85% of the normal page font size, so it is not appropriate to use font size reduction when this template is used in an infobox. The example here is produced by:
{{Infobox person|name=Infobox person |spouse = {{Unbulleted list | {{marriage |[[John Doe|Jane Doe]] |1 January 1895 |December 31, 1905}} | {{marriage |Fred Smith |2010}} | {{marriage |Jane Smith |1885 |July 27, 1888 |end=d.}} | {{marriage |Frank Lee |2002 |2013}} }} }}
Syntax and parameters
{{marriage | <text> | <start date> | <end date> [| end= ]}}
Parameter | Description |
<text> | Some text—usually a spouse's name—preceding the parenthesis carrying the marriage date/s, etc. |
| 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., {{Hover title}}. (See first and third examples above.) |
end | Reason for marriage's end.
Otherwise,
w , w. , wid , wid. , widow , or widowed is deprecated. See Category:Marriage template errors. |
TemplateData
TemplateData for Marriage
insert description here
Parameter | Description | Type | Status | |
---|---|---|---|---|
Spouse's name | 1 | Name of the person to whom the subject is married.
| String | required |
Date married | 2 | Date the marriage began.
| String | optional |
Date ended | 3 | Date the marriage was dissolved or the spouse of the article's subject died.
| String | optional |
Reason ended | end reason | Reason for marriage's end.
| String | optional |