Template:Marriage/doc: Difference between revisions

From The Goon Show Depository
m (1 revision imported)
en>Pedantical
m (Use TemplateData_header instead of just TemplateData to provide additional report links and context.)
Line 2: Line 2:
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{esoteric}}
{{esoteric}}
{{high-use| 32957 }}
{{high-use}}
{{Lua|Module:Check for unknown parameters}}
{{Lua|Module:Check for unknown parameters|Module:Parameter validation}}
{{Uses Wikidata|P21|P570}}
{{Uses Wikidata|P21|P570}}
{{Uses TemplateStyles|Template:Marriage/styles.css}}


==Usage==
==Usage==
This template is intended for use in infoboxes; specifically {{tl|Infobox person}} and [[:Category:Templates calling Infobox person|templates calling Infobox person]].
{{TemplateData header}}
 
<templatedata>{
{{tl|Marriage}} takes up to three unnamed parameters (name, start date, end date)&mdash;plus an optional named parameter {{para|end}} ({{para|reason}})&mdash;to produce output such as the following:
"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.",
{{Markup
    "params": {
| style = font-size:small;
"1": {
| title = Examples
"label": "Spouse's name",
| col1 = Template | col2 = Output
"description": "Name of the person to whom the subject married. May be omitted, typically for remarriages to the same spouse.",
 
"type": "string",
| <nowiki>{{marriage |John Smith |1 January 1895 |December 31, 1905}}</nowiki>
"suggested": true
| {{marriage |John Smith |1 January 1895 |December 31, 1905}}
},
 
"2": {
| <nowiki>{{marriage |John Doe |1885 |July 27, 1888 |end=d.}}</nowiki>
"label": "Date married",
| {{marriage |John Doe |1885 |July 27, 1888 |end=d.}}
"description": "Date the marriage began.",
 
"type": "date",
| <nowiki>{{marriage |Jane Doe |2002}}</nowiki>
"suggested": true
| {{marriage |Jane Doe |2002}}
},
 
"3": {
| <nowiki>{{marriage |John Q. Public |2002|2010}}</nowiki>
"label": "Date ended",
| {{marriage |John Q. Public |2002|2010}}
"description": "Date the marriage was dissolved or the spouse of the article's subject died.",
 
"type": "date",
| <nowiki>{{marriage |John Q. Citizen |2002|2010|end=div}}
"required": false
{{marriage |<!--John Q. Citizen-->|2012}}</nowiki>
},
| {{marriage |John Q. Citizen |2002|2010|end=div}}
"end": {
{{marriage |<!--John Q. Citizen-->|2012}}
"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>


| <nowiki>{{marriage |John Q. Taxpayer |2002|end=div}}</nowiki>
===Examples and usage notes===
| {{marriage |John Q. Taxpayer |2002|end=div}}
{{Infobox person|name={{tl|Infobox person}}  
 
|spouse = {{Plainlist|
| <nowiki>{{marriage |Joe Blow|<!--unknown-->|2010|end=div}}</nowiki>
| {{marriage |Joe Blow|<!--unknown-->|2010|end=div}}
 
| <nowiki>{{marriage |Joe Bloggs|<!--unknown-->|2010}}</nowiki>
| {{marriage |Joe Bloggs|<!--unknown-->|2010}}
 
| <nowiki>{{marriage |Joe Sixpack|<!--unknown-->|2010|end=<!--uncertain-->}}</nowiki>
| {{marriage |Joe Sixpack|<!--unknown-->|2010|end=<!--uncertain-->}}
 
| <nowiki>{{marriage |Joe Schmo |end=div}}</nowiki>
| {{marriage |Joe Schmo |end=div}}
 
| <nowiki>{{marriage |Juan Perez |2010|reason=<!--earliest-->}}</nowiki>
| {{marriage |Juan Perez |2010|reason=<!--earliest-->}}
}}
 
Use of the first two parameters with {{para|end}} ({{para|reason}}) will cause a line break between the name and the start date.
 
===In an infobox===
{{Infobox person|name={{tl|Infobox person}} |spouse = {{Plainlist|
* {{marriage |John Smith |1 January 1895 |December 31, 1905}}
* {{marriage |John Smith |1 January 1895 |December 31, 1905}}
* {{marriage |John Doe |1885 |July 27, 1888 |end=d.}}
* {{marriage |John Doe |1885 |July 27, 1888 |end=d.}}
Line 70: Line 66:
}}
}}
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:
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">
<syntaxhighlight style="font-size:small;" lang="wikitext">
{{Infobox person |spouse = {{Plainlist|
{{Infobox person |spouse = {{Plainlist|
* {{marriage |John Smith |1 January 1895 |December 31, 1905}}
* {{marriage |John Smith |1 January 1895 |December 31, 1905}}
Line 87: Line 83:
</syntaxhighlight>
</syntaxhighlight>


==Syntax and parameters==
* 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.
<code>{{((}}marriage&thinsp;{{!}}{{thin space|<{{var|text}}>}}{{!}}{{thin space|<{{var|start date}}>}}{{!}}{{thin space|<{{var|end date}}>}}[{{!}}{{thin space|end{{=}}}}]{{))}}</code>
* 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]]).
{{Aligned table |class=wikitable |style=line-height:1.35em;
* If the marriage ended with the death of the article's subject, {{insource|"Omission per Template:Marriage instructions"|do {{em|not}} provide a date}}.
| col1style=vertical-align:middle;text-align:center;padding-right:1.0em; |col2style=vertical-align:middle;padding-right:0.5em;
* 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}}.
| row1style=background:whitesmoke;vertical-align:middle;text-align:center;font-weight:bold;
| Parameter | Description
 
| <{{var|text}}>
| (First unnamed parameter) Some text&mdash;usually a spouse's name&mdash;preceding the parenthesis carrying the marriage date/s, etc. This parameter may be omitted, typically for a remarriage to the same spouse.
 
| <{{var|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., {{tla|Hover title}}. ([[#In an infobox|See first and second examples above.]])
 
| <{{var|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., {{tla|Hover title}}. ([[#In an infobox|See first and second examples above.]]) If the marriage ended because of the death of the article's subject, {{insource|"Omission per Template:Marriage instructions"|do {{em|not}} provide a date}}.
 
| {{para|end}} or {{para|reason}}
| Reason for marriage's end. If the marriage ended because of the death of the article's subject, {{insource|"Omission per Template:Marriage instructions"|do {{em|not}} provide a reason}}; use of <i>{{dc|his death}}</i> or <i>{{dc|her death}}</i> for this purpose has been deprecated ([[Template talk:Marriage/Archive 5#Use "(m. 1900)" and do not fill in an end date|see discussion]]).
 
* {{bxtn|d}}, {{bxtn|d.}}, or {{bxtn|died}} includes {{xtn|died}} within the parentheses if the marriage ended on the spouse's death.
* {{bxtn|div}}, {{bxtn|div.}}, or {{bxtn|divorced}} includes {{abbr|{{xtn|div.}}|divorced}} or {{xtn|divorced}} within the parentheses.
* Otherwise, {{para|end|<var>value</var>}} includes customized text. For example:
: {{code|<nowiki>{{marriage |Miss Doe |January 1, 1882 |December 31, 1905 |end=annulled}}</nowiki>}} which produces:
{{block indent |style=margin-bottom:0.6em;
| {{marriage |Miss Doe |January 1, 1882 |December 31, 1905 |end=annulled}} }}
 
{{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.}}
{{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.}}
}}
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==
==Tracking categories==
*{{Category link with count|Marriage template errors}}: invalid or missing dates; unsupported parameters or values
* {{Category link with count|Marriage template errors}}{{sup|†}}
**{{Category link with count|Marriage template deprecations}}
* {{Category link with count|Pages using Marriage with duplicate parameters}} {{sup|‡}}
**{{Category link with count|Category:Marriage template anomalies}}
* {{Category link with count|Pages using Marriage with unknown parameters}} {{sup|‡}}
* {{Category link with count|Pages using Marriage with deprecated parameters}} {{sup|‡}}


==TemplateData==
{{plainlist|
{{TemplateData header}}
* {{small|{{sup|†}} Populated by template logic; contains invalid/missing dates and unsupported parameters/values.}}
<templatedata>{
* {{small|{{sup|‡}} Populated via [[Module:Parameter_validation|parameter validation]].}}
"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>


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

Revision as of 15:20, 4 April 2024

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

Usage

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 married. May be omitted, typically for remarriages to the same spouse.

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

Examples and usage notes

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-->}} }}
}}
  • 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 |end= (|reason=) will cause a line break between the name and the start date.
  • Use of his death or her death for this purpose has been deprecated (see discussion).
  • If the marriage ended with the death of the article's subject, do 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., {{Tooltip}}.
Note: Use of the values w, w., wid, wid., widow, or widowed is no longer supported and will display an error message.


Tracking categories

  • Populated by template logic; contains invalid/missing dates and unsupported parameters/values.
  • Populated via parameter validation.