Editing Template:Marriage/doc

{{Documentation subpage}}
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{esoteric}}
{{high-use}}
{{Lua|Module:Check for unknown parameters|Module:Parameter validation}}
{{Uses Wikidata|P21|P570}}
{{Uses TemplateStyles|Template:Marriage/styles.css}}

==Usage==
{{TemplateData header}}
<templatedata>{
	"format": "inline",
	"description": "Intended for use in Infoboxes, specifically {{Infobox person}} and templates calling Infobox person.\n\n{{Marriage}} 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.",
    "params": {
		"1": {
			"label": "Spouse's name",
			"description": "Name of the person to whom the subject married. May be omitted, typically for remarriages to the same spouse.",
			"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 marriage 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"
			]
		}
	}
}</templatedata>

===Examples and usage notes===
{{Infobox person|name={{tl|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-->}} }}
}}
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">
{{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-->}} }}
}}
</syntaxhighlight>

* 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.
* Use of the first two parameters with {{para|end}} ({{para|reason}}) will cause a line break between the name and the start date.
* Use of {{dc|his death}} or {{dc|her death}} for this purpose has been deprecated ([[Template talk:Marriage/Archive 5#Use "(m. 1900)" and do not fill in an end date|see discussion]]).
* If the marriage ended with the death of the article's subject, {{insource|"Omission per Template:Marriage instructions"|do {{em|not}} provide a date}}.
* For either date parameter, only the year will be displayed; if a full date is provided, it is included via a tooltip; i.e., {{tla|Tooltip}}. 
{{qnote|Use of the values {{dcr|w}}, {{dcr|w.}}, {{dcr|wid}}, {{dcr|wid.}}, {{dcr|widow}}, or {{dcr|widowed}} is [[Template talk:Marriage/Archive 4#Who is widowed - topic or topic's spouse?|no longer supported]] and will display an error message.}}
==Tracking categories==
* {{Category link with count|Marriage template errors}}{{sup|†}}
* {{Category link with count|Pages using Marriage with duplicate parameters}} {{sup|‡}}
* {{Category link with count|Pages using Marriage with unknown parameters}} {{sup|‡}}
* {{Category link with count|Pages using Marriage with deprecated parameters}} {{sup|‡}}

{{plainlist|
* {{small|{{sup|†}} Populated by template logic; contains invalid/missing dates and unsupported parameters/values.}}
* {{small|{{sup|‡}} Populated via [[Module:Parameter_validation|parameter validation]].}}
}}

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Text-specific formatting and function templates‎]]
[[Category:Marriage templates]]
[[Category:Templates that add a tracking category|{{PAGENAME}}]]

}}</includeonly>