Template:Birth date and age/doc: Difference between revisions

    From Nonbinary Wiki
    (tidy)
    (Modernising the /doc header and footer.)
    Line 1: Line 1:
    <includeonly>{{template doc page transcluded|Template:Birth date and age}}</includeonly>
    {{Documentation subpage}}
    <noinclude>{{template doc page viewed directly}}</noinclude>
    <includeonly>{{high-use}}</includeonly>
    <!--  
    <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
        PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE
        YOU CAN EDIT THE TEMPLATE DOCUMENTATION BELOW THIS COMMENT
    -->
    {{high-use}}
     
    === Usage ===


    These templates ('''{{tl|Birth date}}''' and '''{{tl|Birth date and age}}''') return a person’s date of birth and optionally his/her age. The latter also has the shortcuts '''{{tl|bda}}''' and '''{{tl|dob}}'''.
    These templates ('''{{tl|Birth date}}''' and '''{{tl|Birth date and age}}''') return a person’s date of birth and optionally his/her age. The latter also has the shortcuts '''{{tl|bda}}''' and '''{{tl|dob}}'''.
    Line 15: Line 9:
    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.
    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.


    ===Syntax===
    === Syntax ===


    ====To display the birth date only ====
    ==== To display the birth date only ====


    :<nowiki>{{Birth date|year of birth|month of birth|day of birth|additional parameters}}</nowiki>
    :<nowiki>{{Birth date|year of birth|month of birth|day of birth|additional parameters}}</nowiki>


    ====To display a birth date with calculated age====
    ==== To display a birth date with calculated age ====


    :<nowiki>{{Birth date and age|year of birth|month of birth|day of birth|additional parameters}}</nowiki>
    :<nowiki>{{Birth date and age|year of birth|month of birth|day of birth|additional parameters}}</nowiki>
    Line 27: Line 21:
    The parameter names 'year', 'month', and 'day' can be used instead of the first, second, and third parameters for 'Birth date and age' only. These parameter names are not available for the 'Birth date' template.
    The parameter names 'year', 'month', and 'day' can be used instead of the first, second, and third parameters for 'Birth date and age' only. These parameter names are not available for the 'Birth date' template.


    ===={{tl|Bda}} is a redirect to {{tl|Birth date and age}}====
    ==== {{tl|Bda}} is a redirect to {{tl|Birth date and age}} ====


    :<nowiki>{{Bda|year of birth|month of birth|day of birth|additional parameters}}</nowiki>
    :<nowiki>{{Bda|year of birth|month of birth|day of birth|additional parameters}}</nowiki>
    Line 47: Line 41:
    :<nowiki>{{Birth date and age|1993|2|24|df=yes}}</nowiki> returns {{Birth date and age|1993|2|24|df=yes}}
    :<nowiki>{{Birth date and age|1993|2|24|df=yes}}</nowiki> returns {{Birth date and age|1993|2|24|df=yes}}


    ===Month First (mf) and Day First (df) options===
    === Month First (mf) and Day First (df) options ===
     
    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. '''df=yes''' or '''mf=y'''.


    Line 66: Line 61:
    :<nowiki>{{Birth date and age | 1993 | 2 | 24 | mf=yes }}</nowiki> displays "February 24, 1993 (age {{Age|1993|2|24}})".
    :<nowiki>{{Birth date and age | 1993 | 2 | 24 | mf=yes }}</nowiki> displays "February 24, 1993 (age {{Age|1993|2|24}})".


    ===hCard microformat===
    === hCard microformat ===


    The templates also return the date, hidden by CSS, in the [[ISO 8601]] format needed by [[HCard|hCard microformat]]s. for example:
    The templates also return the date, hidden by CSS, in the [[ISO 8601]] format needed by [[HCard|hCard microformat]]s. for example:
    Line 76: Line 71:
    See [[WP:UF|the microformats project]] for details.
    See [[WP:UF|the microformats project]] for details.


    ===Notes===
    === Notes ===


    When only the 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 and death for privacy reasons, use the templates {{tl|Birth year and age}} and {{tl|Death year and age}} instead.
    When only the 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 and death for privacy reasons, use the templates {{tl|Birth year and age}} and {{tl|Death year and age}} instead.
    Line 84: Line 79:
    '''Note:''' Do not use this template inside of the [[WP:PERSONDATA|Persondata]] template as it can interfere with data extraction.
    '''Note:''' Do not use this template inside of the [[WP:PERSONDATA|Persondata]] template as it can interfere with data extraction.


    ===See also===
    === See also ===
     
    *[[Wikipedia:Age calculation templates]]
    *[[Wikipedia:Age calculation templates]]
    *{{tl|BirthDeathAge}} &ndash; carries out the functions of this template and all the following ones
    *{{tl|BirthDeathAge}} &ndash; carries out the functions of this template and all the following ones
    Line 94: Line 90:


    <includeonly>
    <includeonly>
     
    <!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
    <!-- PLEASE ADD CATEGORIES BELOW THIS LINE, THANKS. -->
     
    [[Category:Date mathematics templates|{{PAGENAME}}]]
    [[Category:Date mathematics templates|{{PAGENAME}}]]


    <!-- PLEASE ADD INTERWIKIS BELOW THIS LINE, THANKS. -->
    [[bg:Шаблон:Дата на раждане и години]]
    [[bg:Шаблон:Дата на раждане и години]]
    [[ca:Plantilla:Data naixement i edat]]
    [[ca:Plantilla:Data naixement i edat]]

    Revision as of 03:21, 12 February 2009

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


    These templates ({{Birth date}} and {{Birth date and age}}) return a person’s date of birth and optionally his/her age. The latter also has the shortcuts {{bda}} and {{dob}}.

    Do NOT use this template when the person's exact date of birth is disputed or unknown.

    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.

    Syntax

    To display the birth date only

    {{Birth date|year of birth|month of birth|day of birth|additional parameters}}

    To display a birth date with calculated age

    {{Birth date and age|year of birth|month of birth|day of birth|additional parameters}}

    The parameter names 'year', 'month', and 'day' can be used instead of the first, second, and third parameters for 'Birth date and age' only. These parameter names are not available for the 'Birth date' template.

    {{Bda}} is a redirect to {{Birth date and age}}

    {{Bda|year of birth|month of birth|day of birth|additional parameters}}

    Examples:

    {{Birth date|1993|2|4|df=yes}} returns "(1993-02-04)4 February 1993"
    {{Birth date|1993|2|4|mf=yes}} returns "(1993-02-04)February 4, 1993"
    {{Birth date|1993|2|04|df=yes}} returns "(1993-02-04)4 February 1993"
    {{Birth date|1993|2|04|mf=yes}} returns "(1993-02-04)February 4, 1993"
    {{Birth date|1993|2|24|df=yes}} returns "(1993-02-24)24 February 1993"
    {{Birth date|1993|2|24|mf=yes}} returns "(1993-02-24)February 24, 1993"
    {{Birth date and age|1993|2|4|mf=yes}} returns (1993-02-04) February 4, 1993 (age 31)
    {{Birth date and age|1993|2|4|df=yes}} returns (1993-02-04) 4 February 1993 (age 31)
    {{Birth date and age|1993|2|04|mf=yes}} returns (1993-02-04) February 4, 1993 (age 31)
    {{Birth date and age|1993|2|04|df=yes}} returns (1993-02-04) 4 February 1993 (age 31)
    {{Birth date and age|1993|2|24|mf=yes}} returns (1993-02-24) February 24, 1993 (age 31)
    {{Birth date and age|1993|2|24|df=yes}} returns (1993-02-24) 24 February 1993 (age 31)

    Month First (mf) and Day First (df) options

    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 default output of this template is to display the month before the day. This default may not be appropriate 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.

    Examples:

    {{Birth date | 1993 | 2 | 24 | df=yes }} displays "24 February 1993".
    {{Birth date and age | 1993 | 2 | 24 | df=yes }} displays "24 February 1993 (age 31)".
    {{Birth date | 1993 | 2 | 24 | mf=yes }} displays "February 24, 1993".
    {{Birth date and age | 1993 | 2 | 24 | mf=yes }} displays "February 24, 1993 (age 31)".

    hCard microformat

    The templates also return the date, hidden by CSS, in the ISO 8601 format needed by hCard microformats. 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).

    See the microformats project for details.

    Notes

    When only the 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 and death for privacy reasons, use the templates {{Birth year and age}} and {{Death year and age}} instead.

    Note: The template will appear broken when the parameters are left blank (as seen above).

    Note: Do not use this template inside of the Persondata template as it can interfere with data extraction.

    See also