Difference between revisions of "Template:Marriage/doc"

From blackwiki
Jump to navigation Jump to search
(As per issue with divorced, the subject of dying is also ambiguous; change example accordingly)
imported>Frietjes
 
(111 intermediate revisions by 20 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- 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]]) -->
 +
{{high-use| 32957 }}
 +
{{Uses Wikidata|P21|P570}}
  
 
==Usage==
 
==Usage==
{{tl|Marriage}} takes up to three unnamed parameters&nbsp;plus either, both or neither of the named parameters {{para|()}} and {{para|end}}&nbsp;to produce output such as the following:
+
This template is intended for use in infoboxes; specifically {{tl|Infobox person}} and [[:Category:Templates calling Infobox person|templates calling Infobox person]].
: {{marriage |[[John Doe|Jane Doe]] |1 January 1895 |December 31, 1905}}
+
 
: {{marriage |Fred Smith |()=smaller |2010}}
+
{{tl|Marriage}} takes up to three unnamed parameters (name, start date, end date)&mdash;plus an optional named parameter {{para|end}}&mdash;to produce output such as the following:
: {{marriage |Jack Ripper |1885 |July 27, 1888}}
+
 
: {{marriage|()=small |Frank Lee & Aynee Text |2002 |2013}}
+
{{block indent|{{xtn| {{aligned table|style=line-height:1.5|col1style=padding-right:2em;
 +
| 1= {{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}}}}
 +
| 2= {{plainlist |
 +
* {{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=<!--unknown-->}}
 +
* {{marriage |Joe Schmo |end=div}}
 +
* {{marriage |Juan Perez |2010|<!--uncertain-->}}}} }}
 +
}}}}
  
 
The above were produced by:
 
The above were produced by:
: <code><nowiki>{{marriage |[[John Doe|Jane Doe]] |1 January 1895 |December 31, 1905}}</nowiki></code>
+
: <syntaxhighlight inline=1 lang="html">{{marriage |John Smith |1 January 1895 |December 31, 1905}}</syntaxhighlight>
: <code><nowiki>{{marriage |Fred Smith |()=smaller |2010}}</nowiki></code>
+
: <syntaxhighlight inline=1 lang="html">{{marriage |John Doe |1885 |July 27, 1888 |end=d.}}</syntaxhighlight>
: <code><nowiki>{{marriage |Jack Ripper |1885 |July 27, 1888}}</nowiki></code>
+
: <syntaxhighlight inline=1 lang="html">{{marriage |Jane Doe |2002}}</syntaxhighlight>
: <code><nowiki>{{marriage|()=small |Frank Lee & Aynee Text |2002 |2013}}</nowiki></code>
+
: <syntaxhighlight inline=1 lang="html">{{marriage |John Q. Public |2002|2010}}</syntaxhighlight>
 +
: <syntaxhighlight inline=1 lang="html">{{marriage |John Q. Citizen |2002|2010|end=div}}</syntaxhighlight>
 +
: <syntaxhighlight inline=1 lang="html">{{marriage |<!--John Q. Citizen-->|2012}}</syntaxhighlight>
 +
: <syntaxhighlight inline=1 lang="html">{{marriage |John Q. Taxpayer |2002|end=div}}</syntaxhighlight>
 +
: <syntaxhighlight inline=1 lang="html">{{marriage |Joe Blow|<!--unknown-->|2010|end=div}}</syntaxhighlight>
 +
: <syntaxhighlight inline=1 lang="html">{{marriage |Joe Bloggs|<!--unknown-->|2010}}</syntaxhighlight>
 +
: <syntaxhighlight inline=1 lang="html">{{marriage |Joe Sixpack|<!--unknown-->|2010|end=<!--unknown-->}}</syntaxhighlight>
 +
: <syntaxhighlight inline=1 lang="html">{{marriage |Joe Schmo |end=div}}</syntaxhighlight>
 +
: <syntaxhighlight inline=1 lang="html">{{marriage |Juan Perez |2010|<!--uncertain-->}}</syntaxhighlight>
 +
 
 +
Use of {{para|end}} 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 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=<!--unknown-->}}
 +
* {{marriage |Joe Schmo |end=div}}
 +
* {{marriage |Juan Perez |2010|<!--uncertain-->}} }}
 +
}}
 +
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">
 +
{{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=<!--unknown-->}}
 +
* {{marriage |Joe Schmo |end=div}}
 +
* {{marriage |Juan Perez |2010|<!--uncertain-->}} }}
 +
}}
 +
</syntaxhighlight>
  
 
==Syntax and parameters==
 
==Syntax and parameters==
<code>{{((}}marriage&thinsp;[{{!}}{{thinsp|(){{=}}}}]{{!}}{{thinsp|<''text''>}}{{!}}{{thinsp|<''start date''>}}{{!}}{{thinsp|<''end date''>}}[{{!}}{{thinsp|end{{=}}}}]{{))}}
+
<code>{{((}}marriage&thinsp;{{!}}{{thin space|<{{var|text}}>}}{{!}}{{thin space|<{{var|start date}}>}}{{!}}{{thin space|<{{var|end date}}>}}[{{!}}{{thin space|end{{=}}}}]{{))}}</code>
  
 
{{Aligned table |class=wikitable |style=line-height:1.35em;
 
{{Aligned table |class=wikitable |style=line-height:1.35em;
Line 23: Line 83:
 
  | Parameter | Description
 
  | Parameter | Description
  
  | ()
+
  | <{{var|text}}>
| Set {{para|()|small}} or {{para|()|smaller}} to reduce the font-size used for the parenthesis. (See second and fourth examples above.)
+
| (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.
  
  | <''text''>
+
  | <{{var|start date}}>
  | Some text&nbsp;– usually a spouse's name&nbsp;– preceding the parenthesis carrying the marriage date/s, etc.
+
  | (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.]])
  
  | {{plainlist|
+
  | <{{var|end date}}>
*<''start 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}}.
*<''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., {{tla|Abbr}}. (See first and third examples above.)
 
  
  | end
+
  | {{para|end}} or {{para|reason}}
  | Reason for marriage's end.
+
  | 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]]).
  
<code>div<code>, <code>div.<code>, or <code>divorced<code> includes ''{{abbr|div.|divorced}}'' within the parentheses.
+
* {{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}} }}
  
Otherwise, {{para|end|<var>item</var>}} includes customised text, tooltip, etc. For example:
+
{{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.}}
: <code><nowiki>{{marriage |Miss Doe |January 1, 1882 |December 31, 1905 |end={{abbr|dis.|dissolution}}}}</nowiki></code> which produces: {{marriage |Miss Doe |January 1, 1882 |December 31, 1905 |end={{abbr|dis.|dissolution}}}}
 
 
}}
 
}}
 +
 +
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==
 +
*{{clc|Marriage template errors}}: invalid or missing dates; unsupported parameters or values
  
 
== TemplateData ==
 
== TemplateData ==
 
{{TemplateData header}}
 
{{TemplateData header}}
 
<templatedata>{
 
<templatedata>{
  "description": "insert description here",
 
 
   "params": {
 
   "params": {
 
     "1": {
 
     "1": {
Line 54: Line 119:
 
       "type": "string",
 
       "type": "string",
 
       "default": "",
 
       "default": "",
       "required": true,
+
       "suggested": true
      "aliases": [ "spouse" ]
 
 
     },
 
     },
 
     "2": {
 
     "2": {
Line 62: Line 126:
 
       "type": "string",
 
       "type": "string",
 
       "default": "",
 
       "default": "",
       "required": true,
+
       "suggested": true
      "aliases": [ "date" ]
 
 
     },
 
     },
 
     "3": {
 
     "3": {
 
       "label": "Date ended",
 
       "label": "Date ended",
 
       "description": "Date the marriage was dissolved or the spouse of the article's subject died.",
 
       "description": "Date the marriage was dissolved or the spouse of the article's subject died.",
 +
      "type": "string",
 +
      "default": "",
 +
      "required": false
 +
    },
 +
    "end": {
 +
      "label": "Reason ended",
 +
      "description": "Reason for marriage's end.",
 
       "type": "string",
 
       "type": "string",
 
       "default": "",
 
       "default": "",
 
       "required": false,
 
       "required": false,
       "aliases": [ "end" ]
+
       "aliases": [ "reason" ]
 
     }
 
     }
 
   }
 
   }
 
}</templatedata>
 
}</templatedata>
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+
<includeonly>{{sandbox other||
 
<!-- Categories below this line, please; interwikis at Wikidata -->
 
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia formatting and function templates]]
+
[[Category:Text-specific formatting and function templates‎]]
 +
[[Category:Marriage templates]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 18:23, 14 December 2020

Template:Uses Wikidata

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:

Script error: No such module "aligned table".

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. 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=<!--unknown-->}}
{{marriage |Joe Schmo |end=div}}
{{marriage |Juan Perez |2010|<!--uncertain-->}}

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

In an infobox

Spouse(s)
John Doe
(m. 1885; died Template:Str ≠ len)Template:Wbr
Jane Doe
Template:Str ≥ len
(m. 2002)Template:Wbr
John Q. Public
Template:Str ≥ len
(m. 2002⁠–⁠Template:Str ≠ len)Template:Wbr
John Q. Citizen
(m. 2002; div. Template:Str ≠ len)Template:Wbr
(m. 2012)Template:Wbr
John Q. Taxpayer
(m. 2002, divorced)Template:Wbr
Joe Schmo
Template:Str ≥ len
(divorced)Template:Wbr
Juan Perez
Template:Str ≥ len
(m. after 2010)Template:Wbr

Template:Wikidata image

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=<!--unknown-->}}
* {{marriage |Joe Schmo |end=div}}
* {{marriage |Juan Perez |2010|<!--uncertain-->}} }}
}}

Syntax and parameters

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

Script error: No such module "aligned table".

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 documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Marriage

No description.

Template parameters

ParameterDescriptionTypeStatus
Spouse's name1

Name of the person to whom the subject is married.

Default
Stringsuggested
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