Template:Marriage/doc
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 uses Lua: |
This template uses TemplateStyles: |
Usage[edit source]
This template is intended for use in infoboxes; specifically {{Infobox personnel}}.
{{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–Expression error: Unexpected < operator.) |
{{marriage |John Doe |1885 |July 27, 1888 |end=d.}} |
John Doe
(m. 1885; died Expression error: Unexpected < operator.) |
{{marriage |Jane Doe |2002}} |
Jane Doe
(m. 2002) |
{{marriage |John Q. Public |2002|2010}} |
John Q. Public
(m. 2002–Expression error: Unrecognized punctuation character "[".) |
{{marriage |John Q. Citizen |2002|2010|end=div}} {{marriage |<!--John Q. Citizen-->|2012}} |
John Q. Citizen
(m. 2002; div. Expression error: Unrecognized punctuation character "[".)
(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. Expression error: Unrecognized punctuation character "[".) |
{{marriage |Joe Bloggs|<!--unknown-->|2010}} |
Joe Bloggs
(before Expression error: Unrecognized punctuation character "[".) |
{{marriage |Joe Sixpack|<!--unknown-->|2010|end=<!--uncertain-->}} |
Joe Sixpack
(until Expression error: Unrecognized punctuation character "[".) |
{{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[edit source]
Template:Infobox person 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 |spouse = {{Plainlist|
* {{marriage |John Smith |1 January 1895 |December 31, 1905}}
* {{marriage |John Doe |1885 |July 27, 1888 |end=d.}}
* {{marriage |Jane Doe |2002}}
* {{marriage |John Q. Public |2002|2010}}
* {{marriage |John Q. Citizen |2002|2010|end=div}}
* {{marriage |<!--John Q. Citizen-->|2012}}
* {{marriage |John Q. Taxpayer |2002|end=div}}
* {{marriage |Joe Blow|<!--unknown-->|2010|end=div}}
* {{marriage |Joe Bloggs|<!--unknown-->|2010}}
* {{marriage |Joe Sixpack|<!--unknown-->|2010|end=<!--uncertain-->}}
* {{marriage |Joe Schmo |end=div}}
* {{marriage |Juan Perez |2010|reason=<!--earliest-->}} }}
}}
Syntax and parameters[edit source]
{{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).
|
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[edit source]
Categories populated via template logic[edit source]
- Category:Marriage template errors (0): invalid or missing dates; unsupported parameters or values
- Category:Marriage template deprecations (0)
- [[:Category:Template:Str right|Category:Template:Str right]] (0)
Categories populated via parameter validation[edit source]
- 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[edit source]
TemplateData for Marriage
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Spouse's name | 1 | Name of the person to whom the subject is married. | String | suggested |
Date married | 2 | Date the marriage began. | Date | suggested |
Date ended | 3 | Date the marriage was dissolved or the spouse of the article's subject died. | Date | optional |
Reason ended | end reason | Reason for marriage's end. If the marriage ended because of the death of the article's subject, do not provide a reason.
| String | optional |