Template:Marriage/doc: Difference between revisions
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 | {{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== | ||
{{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| | |||
{{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=" | <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> | ||
* 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.}} | {{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== | ==Tracking categories== | ||
*{{Category link with count|Marriage template errors}} | * {{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|| | <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
This is a documentation subpage for Template:Marriage It may contain usage information, categories and other content that is not part of the original template page. |
This template employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, or your user space before changing anything here. |
This template is used on approximately 81,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
Lua error: callParserFunction: function "#translation" was not found.
Usage
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Spouse's name | 1 | Name of the person to whom the subject married. May be omitted, typically for remarriages to the same spouse. | String | suggested |
Date married | 2 | Date the marriage began. | Date | suggested |
Date ended | 3 | Date the marriage was dissolved or the spouse of the article's subject died. | Date | optional |
Reason marriage ended | end 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.
| String | optional |
Examples and usage notes
{{Infobox person}} | |
---|---|
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 deathorher deathfor 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, orwidowedis no longer supported and will display an error message.
Tracking categories
- Category:Marriage template errors (10)†
- Category:Pages using Marriage with duplicate parameters (0) ‡
- Category:Pages using Marriage with unknown parameters (1) ‡
- Category:Pages using Marriage with deprecated parameters (0) ‡
- † Populated by template logic; contains invalid/missing dates and unsupported parameters/values.
- ‡ Populated via parameter validation.