Template:Marriage/doc

From lisamarieyoung.ca
Revision as of 19:07, 26 October 2023 by en>Neveselbert (Replaced curly quotes with straight with script per MOS:CQ.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

[[Category:Documentation subpages without corresponding pages{{#translation:}}]]

Template:Esoteric

Template:Lua

Lua error: callParserFunction: function "#translation" was not found.

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:Markup

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

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

</syntaxhighlight>

Syntax and parameters

Template:((marriage |Template:Thin space|Template:Thin space|Template:Thin space[|Template:Thin space]Template:))

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:
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. See a monthly parameter usage report for Template:Marriage in articles based on its TemplateData.

TemplateData for Marriage

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 provide the reason for the end of the marriage.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Spouse's name1

Name of the person to whom the subject is married.

Stringsuggested
Date married2

Date the marriage began.

Datesuggested
Date ended3

Date the marriage was dissolved or the spouse of the article's subject died.

Dateoptional
Reason endedend reason

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.

Suggested values
died divorced separated annulled
Stringoptional