Template:Marriage/doc
 | This is a documentation subpage for Template:Marriage. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 76,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
 | This template uses TemplateStyles: |
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= (also called |reason=)—to produce output such as the following:
| Template | Output |
|---|---|
{{marriage |John Smith |1 January 1895 |December 31, 1905}}
|
John Smith (m. 1895–1905) |
{{marriage |John Doe |1885 |July 27, 1888 |end=d.}}
|
John Doe
(m. 1885; died 1888) |
{{marriage |Jane Doe |2002}}
|
Jane Doe (m. 2002) |
{{marriage |John Q. Public |2002|2010}}
|
John Q. Public (m. 2002–2010) |
{{marriage |John Q. Citizen |2002|2010|end=div}}
{{marriage |<!--John Q. Citizen-->|2012}}
|
John Q. Citizen
(m. 2002; div. 2010)
(m. 2012) |
{{marriage |John Q. Taxpayer |2002|end=div}}
|
John Q. Taxpayer
(m. 2002, divorced) |
{{marriage |Joe Blow|<!--unknown-->|2010|end=div}}
|
Joe Blow (div. 2010) |
{{marriage |Joe Bloggs|<!--unknown-->|2010}}
|
Joe Bloggs (before 2010) |
{{marriage |Joe Sixpack|<!--unknown-->|2010|end=<!--uncertain-->}}
|
Joe Sixpack (until 2010) |
{{marriage |Joe Schmo |end=div}}
|
Joe Schmo (divorced) |
{{marriage |Juan Perez |2010|reason=<!--earliest-->}}
|
Juan Perez (after 2010) |
Use of the first two parameters with |end= (|reason=) will cause a line break between the name and the start date.
In an infobox
{{Infobox person}} | |
|---|---|
| Spouses | John Smith (m. 1895–1905)John Doe
(m. 1885; died 1888)Jane Doe (m. 2002)John Q. Public (m. 2002–2010)John Q. Citizen
(m. 2002; div. 2010)
(m. 2012)John Q. Taxpayer
(m. 2002, divorced)Joe Blow (div. 2010)Joe Bloggs (before 2010)Joe Sixpack (until 2010)Joe Schmo (divorced)Juan Perez (after 2010) |
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: <syntaxhighlight style="font-size:small;" lang="wikitext">
Marriage/doc | |
|---|---|
| Spouses | John Smith (m. 1895–1905)John Doe
(m. 1885; died 1888)Jane Doe (m. 2002)John Q. Public (m. 2002–2010)John Q. Citizen
(m. 2002; div. 2010)
(m. 2012)John Q. Taxpayer
(m. 2002, divorced)Joe Blow (div. 2010)Joe Bloggs (before 2010)Joe Sixpack (until 2010)Joe Schmo (divorced)Juan Perez (after 2010) |
</syntaxhighlight>
Syntax and parameters
{{marriage | <text> | <start date> | <end date> [| end= ]}}
| Parameter | Description |
| <text> | (First unnamed parameter) Some text—usually a spouse's name—preceding the parenthesis carrying the marriage date/s, etc. This parameter may be omitted, typically for a remarriage to the same spouse. |
| <start date> | (Second unnamed parameter) Year or full date when the marriage began. Only the year will be displayed. If a full date is provided, it is given via a tooltip; i.e., {{Tooltip}}. (See first and second examples above.) |
| <end date> | (Third unnamed parameter) Year or full date when the marriage ended. Only the year will be displayed. If a full date is provided, it is given via a tooltip; i.e., {{Tooltip}}. (See first and second examples above.) If the marriage ended because of the death of the article's subject, Template:Insource. |
|end= or |reason= | Reason for marriage's end. If the marriage ended because of the death of the article's subject, Template:Insource; use of Template:Dc or Template:Dc for this purpose has been deprecated (see discussion).
Miss Doe
(m. 1882; ann. 1905) |
None of the parameters are required on their own, but if a template is missing all three of start date, end date, and reason, an error message will be displayed.
Tracking categories
Categories populated via template logic
- Category:Marriage template errors (0): invalid or missing dates; unsupported parameters or values
Categories populated via parameter validation
- Category:Pages using Marriage with duplicate parameters (0)
- Category:Pages using Marriage with unknown parameters (0)
- Category:Pages using Marriage with deprecated parameters (0)
TemplateData
TemplateData for Marriage
<templatedata>{ "params": { "1": { "label": "Spouse's name", "description": "Name of the person to whom the subject is married.", "type": "string", "suggested": true }, "2": { "label": "Date married", "description": "Date the marriage began.", "type": "date", "suggested": true }, "3": { "label": "Date ended", "description": "Date the marriage was dissolved or the spouse of the article's subject died.", "type": "date", "required": false }, "end": { "label": "Reason ended", "description": "Reason for marriage's end. Suggested reasons are automatically abbreviated. If the marriage ended due to death of article's subject, do not provide a reason.", "type": "string", "required": false, "aliases": [ "reason" ], "suggestedvalues": [ "died", "divorced", "separated", "annulled" ] } }, "format": "inline",
"description": "Intended for use in infoboxes, specifically
Marriage/doc |
|---|
and templates calling Infobox person.\n\n
takes up to three unnamed parameters (name, start date, end date) plus an optional named parameter \"end=\" to provide the reason for the end of the marriage."
}</templatedata>