Difference between revisions of "Template:Marriage/doc"

From blackwiki
Jump to navigation Jump to search
imported>Zyxw
(add {{TemplateData header}} before <templatedata>)
Line 16: Line 16:
  
 
==Syntax and parameters==
 
==Syntax and parameters==
<code>{{((}}marriage({{thinsp|{{!}}(){{=}}}}) {{!}}{{thinsp|[''Text'']}} {{!}}{{thinsp|[''start date'']}} {{!}}{{thinsp|[''end date'']}} ({{thinsp|{{!}}end{{=}}}}){{))}}
+
<code>{{((}}marriage&thinsp;[{{!}}{{thinsp|(){{=}}}}]{{!}}{{thinsp|<''text''>}}{{!}}{{thinsp|<''start date''>}}{{!}}{{thinsp|<''end date''>}}[{{!}}{{thinsp|end{{=}}}}]{{))}}
  
 
{{Aligned table |class=wikitable |style=line-height:1.35em;
 
{{Aligned table |class=wikitable |style=line-height:1.35em;
  |col1style=vertical-align:middle;text-align:center;padding-right:1.0em; |col2style=vertical-align:middle;padding-right:0.5em;
+
  | col1style=vertical-align:middle;text-align:center;padding-right:1.0em; |col2style=vertical-align:middle;padding-right:0.5em;
  |row1style=background:whitesmoke;vertical-align:middle;text-align:center;font-weight:bold;
+
  | row1style=background:whitesmoke;vertical-align:middle;text-align:center;font-weight:bold;
 
  | Parameter | Description
 
  | Parameter | Description
  
Line 26: Line 26:
 
  | Set {{para|()|small}} or {{para|()|smaller}} to reduce the font-size used for the parenthesis. (See second and fourth examples above.)
 
  | Set {{para|()|small}} or {{para|()|smaller}} to reduce the font-size used for the parenthesis. (See second and fourth examples above.)
  
  | ''Text''
+
  | <''text''>
 
  | Some text&nbsp;– usually a spouse's name&nbsp;– preceding the parenthesis carrying the marriage date/s, etc.
 
  | Some text&nbsp;– usually a spouse's name&nbsp;– preceding the parenthesis carrying the marriage date/s, etc.
  
  | ''start date''<br />''end date''
+
  | {{plainlist|
  | 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.)
+
*<''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., {{tla|Abbr}}. (See first and third examples above.)
  
 
  | end
 
  | end
 
  | Reason for marriage's end.
 
  | Reason for marriage's end.
: Set {{para|end}}"div", "div." or "divorced" (without quotemarks) to include "{{abbr|div.|divorced}}" within the parenthesis;
+
 
: &nbsp;or {{para|end}}[''item''] to use a customised text/tooltip/etc. For example:
+
<code>div<code>, <code>div.<code>, or <code>divorced<code> includes ''{{abbr|div.|divorced}}'' within the parentheses.
:: <code><nowiki>{{marriage |Miss Doe |January 1, 1882 |December 31, 1905 |end={{abbr|d.|died}}}}</nowiki></code><br />which produces: {{marriage |Miss Doe |January 1, 1882 |December 31, 1905 |end={{abbr|d.|died}}}}
+
 
 +
Otherwise, {{para|end|<var>item</var>}} includes customised text, tooltip, etc. For example:
 +
: <code><nowiki>{{marriage |Miss Doe |January 1, 1882 |December 31, 1905 |end={{abbr|d.|died}}}}</nowiki></code> which produces: {{marriage |Miss Doe |January 1, 1882 |December 31, 1905 |end={{abbr|d.|died}}}}
 
}}
 
}}
  

Revision as of 15:36, 9 February 2016

Usage

{{Marriage}} takes up to three unnamed parameters – plus either, both or neither of the named parameters |()= and |end= – to produce output such as the following:

Template:Str ≥ len
(m. 1895⁠–⁠Template:Str ≠ len)Template:Wbr
Fred Smith
Template:Str ≥ len
(m. 2010)Template:Wbr
Jack Ripper
Template:Str ≥ len
(m. 1885⁠–⁠Template:Str ≠ len)Template:Wbr
Frank Lee & Aynee Text
Template:Str ≥ len
(m. 2002⁠–⁠Template:Str ≠ len)Template:Wbr

The above were produced by:

{{marriage |[[John Doe|Jane Doe]] |1 January 1895 |December 31, 1905}}
{{marriage |Fred Smith |()=smaller |2010}}
{{marriage |Jack Ripper |1885 |July 27, 1888}}
{{marriage|()=small |Frank Lee & Aynee Text |2002 |2013}}

Syntax and parameters

{{marriage [|Template:Thinsp]|Template:Thinsp|Template:Thinsp|Template:Thinsp[|Template:Thinsp]}}

Script error: No such module "aligned table".

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 spouse

Name of the person to whom the subject is married.

Default
Stringrequired
Date married2 date

Date the marriage began.

Default
Stringrequired
Date ended3 end

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

Default
Stringoptional