Template:Marriage/doc: Difference between revisions

From Gerald R. Lucas
(Created page with "{{Documentation subpage}} <!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see Wikipedia:Wikidata) --> {{high-use| 32957 }} ==...")
m (1 revision imported)
 
(No difference)

Latest revision as of 11:39, 8 February 2020

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⁠–⁠1905)
John Doe
(m. 1885; died 1888)
Jane Doe (m. 2002)
John Q. Public (m. 2002⁠–⁠2010)
John Q. Citizen
(m. 2002; div. 2010)
John Q. Taxpayer
(m. 2002, divorced)
Joe Blow (div. 2010)
Joe the Plumber (before 2010)

The above were produced by:

{{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. Taxpayer |2002|end=div}}
{{marriage |Joe Blow| |2010|end=div}}
{{marriage |Joe the Plumber| |2010}}

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

In an infobox

Spouse(s)
  • 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)
  • John Q. Taxpayer
    (m. 2002, divorced)
  • Joe Blow (div. 2010)
  • Joe the Plumber (before 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. Taxpayer |2002|end=div}}
* {{marriage |Joe Blow| |2010|end=div}}
* {{marriage |Joe the Plumber| |2010}}}}
}}

Syntax and parameters

{{marriage |<text> |<start date> |<end date> [|end= ]}}

Parameter Description
<text> Some text—usually a spouse's name—preceding the parenthesis carrying the marriage date/s, etc.
  • <start date>
  • <end date>
Only the year within each of these will be displayed. If either has more information (e.g., month, day), it is given via a tooltip; i.e., {{Hover title}}. (See first and third examples above.)
end Reason for marriage's end.

d, d., or died includes died within the parentheses if the marriage ended on the death of the spouse.

div, div., or divorced includes div. or divorced within the parentheses.

Otherwise, |end=item includes customised text. For example:

{{marriage |Miss Doe |January 1, 1882 |December 31, 1905 |end=annulled}} which produces:
Miss Doe
(m. 1882; annulled 1905)
Use of the values w, w., wid, wid., widow, or widowed is deprecated. See Category:Marriage template errors.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Marriage

insert description here

Template parameters

ParameterDescriptionTypeStatus
Spouse's name1

Name of the person to whom the subject is married.

Default
Stringrequired
Date married2

Date the marriage began.

Default
Stringsuggested
Date ended3

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

Default
Stringoptional
Reason endedend reason

Reason for marriage's end.

Default
Stringoptional