Template:Birth date/doc: Difference between revisions

    From Nonbinary Wiki
    m (Remove <includeonly> from {{high-risk}} template, since works correctly on /doc pages now. Update template name to avoid redirect. Update count.)
    (update examples, updates for Wikidata tracking)
    Line 1: Line 1:
    {{Documentation subpage}}<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
    {{Documentation subpage}}
    <!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
    {{Warning|''Do '''NOT''' use this template when the exact date of birth is disputed or unknown; consider {{tlp|Birth year}} instead.''}}
    {{Warning|''Do '''NOT''' use this template when the exact date of birth is disputed or unknown; consider {{tlp|Birth year}} instead.''}}
    {{High-use| 240,000 }}
    {{High-use|240000}}
    {{Template shortcut|dob}}
    {{Template shortcut|dob}}
    {{Tracks Wikidata|P569}}


    '''{{NAMESPACE}}:{{BASEPAGENAME}}''' will return a person's date of birth. Using this template rather than simply inserting the date into articles allows for the inclusion of hidden [[metadata]] about the date. This metadata can be used by web browsers and other software tools to extract the details, and display them using some other website or mapping tool, index, or search them.
    '''{{NAMESPACE}}:{{BASEPAGENAME}}''' will return a person's date of birth. Using this template rather than simply inserting the date into articles allows for the inclusion of hidden [[metadata]] about the date. This metadata can be used by web browsers and other software tools to extract the details, and display them using some other website or mapping tool, index, or search them.
    Line 10: Line 12:
    == Usage ==
    == Usage ==
    ; Unnamed parameters for year, month, day
    ; Unnamed parameters for year, month, day
    : <code><nowiki>{{</nowiki>Birth date|''year of birth''|''month of birth''|''day of birth''|''additional parameters''<nowiki>}}</nowiki></code>
    : <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|<var>year of birth</var>|<var>month of birth</var>|<var>day of birth</var>|<var>additional parameters</var><nowiki>}}</nowiki></code>
    : <code><nowiki>{{</nowiki>dob|''year of birth''|''month of birth''|''day of birth''|''additional parameters''<nowiki>}}</nowiki></code>


    ; Named parameters for year, month, day
    ; Named parameters for year, month, day
    : <code><nowiki>{{</nowiki>Birth date|year=''year of birth''|month=''month of birth''|day=''day of birth''|''additional parameters''<nowiki>}}</nowiki></code>
    : <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|year=<var>year of birth</var>|month=<var>month of birth</var>|day=<var>day of birth</var>|<var>additional parameters</var><nowiki>}}</nowiki></code>
    : <code><nowiki>{{</nowiki>dob|year=''year of birth''|month=''month of birth''|day=''day of birth''|''additional parameters''<nowiki>}}</nowiki></code>


    === Additional parameters ===
    === Additional parameters ===
    The '''df''' (day first) and '''mf''' (month first) parameters indicate the intended date format to display. The appropriate parameter should be set to "y" or "yes" e.g. '''df=yes''' or '''mf=y'''.
    The '''df''' (day first) and '''mf''' (month first) parameters indicate the intended date format to display. The appropriate parameter should be set to "y" or "yes", e.g. {{para|df|y}} or {{para|df|yes}}.


    The default output of this template is to display the month before the day. This default may not be appropriate for articles about people from parts of the world where the day precedes the month in a date. In such articles the parameter, "df", should be set to display the day before the month.
    The default output of this template is to display the month before the day. This default may not be appropriate for articles about people from parts of the world where the day precedes the month in a date. In such articles the parameter, "df", should be set to display the day before the month.
    Line 25: Line 25:


    Do not specify both "df" and "mf" parameters in the same use of the template, as these formats are mutually exclusive.
    Do not specify both "df" and "mf" parameters in the same use of the template, as these formats are mutually exclusive.
    === Error tracking ===
    Some kinds of invalid input are tracked in [[:Category:Pages using age template with invalid date]].


    === hCard microformat ===
    === hCard microformat ===
    Line 36: Line 33:


    For further information, visit [[Wikipedia:WikiProject Microformats|the microformats project]].
    For further information, visit [[Wikipedia:WikiProject Microformats|the microformats project]].
    {{Section references}}


    === Notes ===
    === Notes ===
    Line 43: Line 42:


    == Examples ==
    == Examples ==
    ; Unnamed parameters for year, month, day
    Unnamed parameters for year, month, day:
    : <code><nowiki>{{Birth date|1993|2|24}}</nowiki></code> returns "{{Birth date|1993|2|24}}"
    {{nowiki template demo|format=inline|code=<nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>|1993|2|24}}</nowiki>}}
    : <code><nowiki>{{Birth date|1993|2|24|df=yes}}</nowiki></code> returns "{{Birth date|1993|2|24|df=yes}}"
    {{nowiki template demo|format=inline|code=<nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>|1993|2|24|df=yes}}</nowiki>}}
    : <code><nowiki>{{Birth date|1993|2|24|mf=yes}}</nowiki></code> returns "{{Birth date|1993|2|24|mf=yes}}"
    {{nowiki template demo|format=inline|code=<nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>|1993|2|24|mf=yes}}</nowiki>}}


    ; Named parameters for year, month, day
    Named parameters for year, month, day:
    : <code><nowiki>{{Birth date|year=1993|month=2|day=24}}</nowiki></code> returns "{{Birth date|year=1993|month=2|day=24}}"
    {{nowiki template demo|format=inline|code=<nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>|year=1993|month=2|day=24}}</nowiki>}}
    : <code><nowiki>{{Birth date|year=1993|month=2|day=24|df=yes}}</nowiki></code> returns "{{Birth date|year=1993|month=2|day=24|df=yes}}"
    {{nowiki template demo|format=inline|code=<nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>|year=1993|month=2|day=24|df=yes}}</nowiki>}}
    : <code><nowiki>{{Birth date|year=1993|month=2|day=24|mf=yes}}</nowiki></code> returns "{{Birth date|year=1993|month=2|day=24|mf=yes}}"
    {{nowiki template demo|format=inline|code=<nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>|year=1993|month=2|day=24|mf=yes}}</nowiki>}}


    == TemplateData ==
    == TemplateData ==
    {{TemplateDataHeader}}
    {{TemplateData header}}
    <templatedata>
    <templatedata>
    {
    {
    Line 61: Line 60:
    "1": {
    "1": {
    "label": "Year of birth",
    "label": "Year of birth",
    "description": "The year in which the person was born",
    "description": "The year in which the person was born.",
    "type": "number",
    "type": "number",
    "example": "1993",
    "example": "1993",
    Line 71: Line 70:
    "2": {
    "2": {
    "label": "Month of birth",
    "label": "Month of birth",
    "description": "The month (number) in which the person was born",
    "description": "The month (number) in which the person was born.",
    "type": "number",
    "type": "number",
    "example": "2",
    "example": "2",
    Line 81: Line 80:
    "3": {
    "3": {
    "label": "Day of birth",
    "label": "Day of birth",
    "description": "The day (number) in which the person was born",
    "description": "The day (number) in which the person was born.",
    "type": "number",
    "type": "number",
    "example": "24",
    "example": "24",
    Line 91: Line 90:
    "df": {
    "df": {
    "label": "Day first",
    "label": "Day first",
    "description": "When set to 'y' or 'yes', the date of birth is output in a DMY format",
    "description": "When set to 'y' or 'yes', the date of birth is output in a DMY format.",
    "type": "string",
    "type": "string",
    "example": "y",
    "example": "y",
    Line 98: Line 97:
    "mf": {
    "mf": {
    "label": "Month first",
    "label": "Month first",
    "description": "When set to 'y' or 'yes', stresses that the default MDY date format is intended for the date of birth",
    "description": "When set to 'y' or 'yes', stresses that the default MDY date format is intended for the date of birth.",
    "type": "string",
    "type": "string",
    "example": "y",
    "example": "y",
    Line 107: Line 106:
    </templatedata>
    </templatedata>


    == References ==
    == Tracking categories ==
    {{reflist}}
    * {{clc|Pages using age template with invalid date}}
    * {{clc|Date of birth not in Wikidata}}
    * {{clc|Articles without Wikidata item}}


    == See also ==
    == See also ==
    Line 121: Line 122:
    [[Category:Date mathematics templates]]
    [[Category:Date mathematics templates]]
    [[Category:Templates generating microformat dates]]
    [[Category:Templates generating microformat dates]]
    [[Category:Templates that add a tracking category]]
    }}</includeonly>
    }}</includeonly>

    Revision as of 14:25, 24 January 2019

    VisualEditor - Icon - Advanced - white.svg This is a documentation subpage for Template:Birth date.
    It contains usage information, categories and other content that is not part of the original page.
    Shortcut

    Template:Birth date will return a person's date of birth. Using this template rather than simply inserting the date into articles allows for the inclusion of hidden metadata about the date. This metadata can be used by web browsers and other software tools to extract the details, and display them using some other website or mapping tool, index, or search them.

    For an article about a living person, consider using {{Birth date and age}} instead.

    Usage

    Unnamed parameters for year, month, day
    {{Birth date|year of birth|month of birth|day of birth|additional parameters}}
    Named parameters for year, month, day
    {{Birth date|year=year of birth|month=month of birth|day=day of birth|additional parameters}}

    Additional parameters

    The df (day first) and mf (month first) parameters indicate the intended date format to display. The appropriate parameter should be set to "y" or "yes", e.g. |df=y or |df=yes.

    The default output of this template is to display the month before the day. This default may not be appropriate for articles about people from parts of the world where the day precedes the month in a date. In such articles the parameter, "df", should be set to display the day before the month.

    The parameter "mf", while not actually used by the template, will indicate that month first format is intended. Using these parameters can assist bots or other automated processing to detect which date format is intended; leaving the format as default may lead an editor or bot to change the format to an unintended value.

    Do not specify both "df" and "mf" parameters in the same use of the template, as these formats are mutually exclusive.

    hCard microformat

    This template also returns the date, hidden by CSS, in the ISO 8601 standard.[1] [2] For example:

    (<span class="bday">1993-02-24</span>)

    Note: For the "foundation", "built" and similar set-up dates of companies, buildings etc., use {{start date}} (this will work for year-only or month-year dates). Because the ISO 8601 standard requires the Gregorian calendar, this template should not be used if the date is given in the Julian calendar.

    For further information, visit the microformats project.

    References

    1. ↑ "Date Design Pattern". Microformats Wiki. April 7, 2013.
    2. ↑ "hCalendar closed issues". Microformats Wiki. August 28, 2009. Specifically rejects supporting the Julian calendar.

    Notes

    • Do not use with non-Gregorian dates because the resulting hCard hidden date will be false.
    • The template will appear broken when the parameters are left blank.
    • When only the month or year of a person's birth and/or death are known, or if it is desired not to state a person's full dates of birth for privacy reasons, consider using the templates {{Birth year}} or {{Birth year and age}} instead.

    Examples

    Unnamed parameters for year, month, day:

    • {{Birth date|1993|2|24}} → (1993-02-24)February 24, 1993
    • {{Birth date|1993|2|24|df=yes}} → (1993-02-24)24 February 1993
    • {{Birth date|1993|2|24|mf=yes}} → (1993-02-24)February 24, 1993

    Named parameters for year, month, day:

    • {{Birth date|year=1993|month=2|day=24}} → (1993-02-24)February 24, 1993
    • {{Birth date|year=1993|month=2|day=24|df=yes}} → (1993-02-24)24 February 1993
    • {{Birth date|year=1993|month=2|day=24|mf=yes}} → (1993-02-24)February 24, 1993

    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 Birth date

    This template will return a person's date of birth. Using this template rather than simply inserting the date into articles allows for the inclusion of hidden metadata about the date. This metadata can be used by web browsers and other software tools to extract the details, and display them using some other website or mapping tool, index, or search them.

    Template parameters

    ParameterDescriptionTypeStatus
    Year of birth1 year

    The year in which the person was born.

    Example
    1993
    		Numberrequired
    Month of birth2 month

    The month (number) in which the person was born.

    Example
    2
    		Numberrequired
    Day of birth3 day

    The day (number) in which the person was born.

    Example
    24
    		Numberrequired
    Day firstdf

    When set to 'y' or 'yes', the date of birth is output in a DMY format.

    Example
    y
    		Stringoptional
    Month firstmf

    When set to 'y' or 'yes', stresses that the default MDY date format is intended for the date of birth.

    Example
    y
    		Stringoptional

    Tracking categories

    See also


    Retrieved from "https://nonbinary.wiki/index.php?title=Template:Birth_date/doc&oldid=31199"