Template:Marriage/doc

From Pantonian Republic Wiki
Jump to navigation Jump to search

Template:Esoteric

Script error: No such module "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= (|reason=)—to produce output such as the following:

Examples
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

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:

{{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

{{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., Template:Tla. (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., Template:Tla. (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).
{{marriage |Miss Doe |January 1, 1882 |December 31, 1905 |end=annulled}} which produces:
Miss Doe
(m. 1882; annulled 1905)
Template:Qnote

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

Categories populated via parameter validation

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this 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. If the marriage ended because of the death of the article's subject, do not provide a reason.", "type": "string", "required": false, "aliases": [ "reason" ], "suggestedvalues": [ "died", "divorced" ] } }, "format": "inline" }</templatedata>