Template:Marriage/doc: Difference between revisions
en>Neveselbert |
(No difference)
|
Revision as of 19:07, 26 October 2023
 | This is a documentation subpage for Template:Marriage. It contains usage information, categories and other content that is not part of the original Template page. |
[[Category:Documentation subpages without corresponding pages{{#translation:}}]]
 | This template is used on many pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
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:
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).
|
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
- Category:Marriage template errors (0): invalid or missing dates; unsupported parameters or values
Categories populated via parameter validation
- Category:Pages using Marriage with duplicate parameters (0)
- Category:Pages using Marriage with unknown parameters (0)
- Category:Pages using Marriage with deprecated parameters (0)
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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Spouse's name | 1 | Name of the person to whom the subject is married. | 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 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 |
