Template:Marriage/doc

From Jaroussky Wiki
Jump to navigation Jump to search

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=—to produce output such as the following:

John Smith
(m. 1895⁠–⁠Expression error: Unexpected < operator.)
John Doe
(m. 1885; died Expression error: Unexpected < operator.)
Jane Doe
(m. 2002)
John Q. Public
(m. 2002⁠–⁠Expression error: Unexpected < operator.)
John Q. Citizen
(m. 2002; div. Expression error: Unexpected < operator.)
(m. 2012)
John Q. Taxpayer
(m. 2002, divorced)
Joe Blow
(div. Expression error: Unexpected < operator.)
Joe Bloggs
(m. before Expression error: Unexpected < operator.)
Joe Sixpack
(m. until Expression error: Unexpected < operator.)
Joe Schmo
(divorced)
Juan Perez
(m. after 2010)

The above were produced by:

<syntaxhighlight inline=1 lang="html">
John Smith
(m. 1895⁠–⁠Expression error: Unexpected < operator.)

</syntaxhighlight>

<syntaxhighlight inline=1 lang="html">
John Doe
(m. 1885; died Expression error: Unexpected < operator.)

</syntaxhighlight>

<syntaxhighlight inline=1 lang="html">
Jane Doe
(m. 2002)

</syntaxhighlight>

<syntaxhighlight inline=1 lang="html">
John Q. Public
(m. 2002⁠–⁠Expression error: Unexpected < operator.)

</syntaxhighlight>

<syntaxhighlight inline=1 lang="html">
John Q. Citizen
(m. 2002; div. Expression error: Unexpected < operator.)

</syntaxhighlight>

<syntaxhighlight inline=1 lang="html">
(m. 2012)

</syntaxhighlight>

<syntaxhighlight inline=1 lang="html">
John Q. Taxpayer
(m. 2002, divorced)

</syntaxhighlight>

<syntaxhighlight inline=1 lang="html">
Joe Blow
(div. Expression error: Unexpected < operator.)

</syntaxhighlight>

<syntaxhighlight inline=1 lang="html">
Joe Bloggs
(m. before Expression error: Unexpected < operator.)

</syntaxhighlight>

<syntaxhighlight inline=1 lang="html">
Joe Sixpack
(m. until Expression error: Unexpected < operator.)

</syntaxhighlight>

<syntaxhighlight inline=1 lang="html">
Joe Schmo
(divorced)

</syntaxhighlight>

<syntaxhighlight inline=1 lang="html">
Juan Perez
(m. after 2010)

</syntaxhighlight>

Use of |end= will cause a line break between the name and the start date.

In an infobox

Spouse(s)
John Smith
(m. 1895⁠–⁠Expression error: Unexpected < operator.)
John Doe
(m. 1885; died Expression error: Unexpected < operator.)
Jane Doe
(m. 2002)
John Q. Public
(m. 2002⁠–⁠Expression error: Unexpected < operator.)
John Q. Citizen
(m. 2002; div. Expression error: Unexpected < operator.)
(m. 2012)
John Q. Taxpayer
(m. 2002, divorced)
Joe Blow
(div. Expression error: Unexpected < operator.)
Joe Bloggs
(m. before Expression error: Unexpected < operator.)
Joe Sixpack
(m. until Expression error: Unexpected < operator.)
Joe Schmo
(divorced)
Juan Perez
(m. 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="html">

Marriage/doc
Spouse(s)
John Smith
(m. 1895⁠–⁠Expression error: Unexpected < operator.)
John Doe
(m. 1885; died Expression error: Unexpected < operator.)
Jane Doe
(m. 2002)
John Q. Public
(m. 2002⁠–⁠Expression error: Unexpected < operator.)
John Q. Citizen
(m. 2002; div. Expression error: Unexpected < operator.)
(m. 2012)
John Q. Taxpayer
(m. 2002, divorced)
Joe Blow
(div. Expression error: Unexpected < operator.)
Joe Bloggs
(m. before Expression error: Unexpected < operator.)
Joe Sixpack
(m. until Expression error: Unexpected < operator.)
Joe Schmo
(divorced)
Juan Perez
(m. 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., {{Hover title}}. (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., {{Hover title}}. (See first and second examples above.) If the marriage ended because of the death of the article's subject, do not provide a date.
|end= or |reason= Reason for marriage's end. If the marriage ended because of the death of the article's subject, do not provide a reason; use of his death or her death for this purpose has been deprecated (see discussion).
  • d, d., or died includes died within the parentheses if the marriage ended on the spouse's death.
  • div, div., or divorced includes div. or divorced within the parentheses.
  • Otherwise, |end=value includes customized text. For example:
<syntaxhighlight lang="text" class="" id="" style="" inline="1">{{marriage |Miss Doe |January 1, 1882 |December 31, 1905 |end=annulled}}</syntaxhighlight> which produces:
Miss Doe
(m. 1882; annulled Expression error: Unexpected < operator.)
Note: Use of the values w, w., wid, wid., widow, or widowed is no longer supported and will display an error message.

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

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 based on this TemplateData.

TemplateData for Marriage

Unexpected property "params.end.suggestedvalues".