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

    From Nonbinary Wiki
    (→‎Examples: show additional examples which work in this template after it was converted to use Module:Age)
    m (Remove <includeonly> from {{high-risk}} template, since works correctly on /doc pages now. Update template name to avoid redirect.)
    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 and age}} instead.''}}<includeonly>
    {{Warning|''Do '''NOT''' use this template when the exact date of birth is disputed or unknown; consider {{tlp|Birth year and age}} instead.''}}
    {{High-risk|520,000+}}</includeonly>
    {{High-use| 520,000 }}
    {{Template shortcut|bda}}
    {{Template shortcut|bda}}
    {{Lua|Module:Age}}
    {{Lua|Module:Age}}

    Revision as of 03:51, 2 November 2018

    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.

    Template:Birth date and age will return a living person's date of birth and age. 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.

    This template is intended for use in an article about a living person. For an article about a dead person, use {{Birth date}} with {{Death date and age}}.

    Usage

    Unnamed parameters for year, month, day
    {{Birth date and age|year of birth|month of birth|day of birth|additional parameters}}
    {{bda|year of birth|month of birth|day of birth|additional parameters}}
    Named parameters for year, month, day
    {{Birth date and age|year=year of birth|month=month of birth|day=day of birth|additional parameters}}
    {{bda|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=yes or mf=y.

    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.

    Error tracking

    Some kinds of invalid input are tracked in Category:Pages using age template with invalid date.

    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.

    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 and age|1993|2|24}} 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)"
    {{Birth date and age|1993|2|24|mf=yes}} returns " (1993-02-24) February 24, 1993 (age 31)"
    Named parameters for year, month, day
    {{Birth date and age|year=1993|month=2|day=24}} returns " (1993-02-24) February 24, 1993 (age 31)"
    {{Birth date and age|year=1993|month=2|day=24|df=yes}} returns " (1993-02-24) 24 February 1993 (age 31)"
    {{Birth date and age|year=1993|month=2|day=24|mf=yes}} returns " (1993-02-24) February 24, 1993 (age 31)"

    Using month name instead of number

    The following examples use a parameter value that will not work in the {{Birth date}}, {{Death date}}, or {{Death date and age}} templates.

    Unnamed parameters for year, month name, day
    {{Birth date and age|1993|Feb|24}} returns " (1993-Feb-24) February 24, 1993 (age 31)Expression error: Unrecognized word "feb"."
    {{Birth date and age|1993|Feb|24|df=yes}} returns " (1993-Feb-24) 24 February 1993 (age 31)Expression error: Unrecognized word "feb"."
    {{Birth date and age|1993|Feb|24|mf=yes}} returns " (1993-Feb-24) February 24, 1993 (age 31)Expression error: Unrecognized word "feb"."
    Named parameters for year, month name, day
    {{Birth date and age|year=1993|month=Feb|day=24}} returns " (1993-Feb-24) February 24, 1993 (age 31)Expression error: Unrecognized word "feb"."
    {{Birth date and age|year=1993|month=Feb|day=24|df=yes}} returns " (1993-Feb-24) 24 February 1993 (age 31)Expression error: Unrecognized word "feb"."
    {{Birth date and age|year=1993|month=Feb|day=24|mf=yes}} returns " (1993-Feb-24) February 24, 1993 (age 31)Expression error: Unrecognized word "feb"."

    Using full date in one parameter

    The following examples use a parameter value that will not work in the {{Birth date}}, {{Death date}}, or {{Death date and age}} templates.

    The date format entered does not change the date format displayed, which is MDY by default or DMY if |df=y (to display the date in the same format it was entered, use {{Birth-date and age}}).

    Unnamed parameter for full date (output in MDY format)
    {{Birth date and age|1993-2-24}} returns " (1993-2-24-{{{month}}}-{{{day}}}) Expression error: Unrecognized punctuation character "{"., 1993-2-24 (age Error: Need valid year, month, day)Expression error: Unrecognized punctuation character "{".Expression error: Unrecognized punctuation character "{"."
    {{Birth date and age|Feb 24, 1993}} returns " (Feb 24, 1993-{{{month}}}-{{{day}}}) Expression error: Unrecognized punctuation character "{"., Feb 24, 1993 (age Error: Need valid year, month, day)Expression error: Unrecognized word "feb".Expression error: Unrecognized punctuation character "{".Expression error: Unrecognized punctuation character "{"."
    {{Birth date and age|24 Feb 1993}} returns " (24 Feb 1993-{{{month}}}-{{{day}}}) Expression error: Unrecognized punctuation character "{"., 24 Feb 1993 (age Error: Need valid year, month, day)Expression error: Unrecognized word "feb".Expression error: Unrecognized punctuation character "{".Expression error: Unrecognized punctuation character "{"."
    Unnamed parameter for full date (output in DMY format)
    {{Birth date and age|1993-2-24|df=y}} returns " (1993-2-24-{{{month}}}-{{{day}}}) Expression error: Unrecognized punctuation character "{". 1993-2-24 (age Error: Need valid year, month, day)Expression error: Unrecognized punctuation character "{".Expression error: Unrecognized punctuation character "{"."
    {{Birth date and age|24 Feb 1993|df=y}} returns " (24 Feb 1993-{{{month}}}-{{{day}}}) Expression error: Unrecognized punctuation character "{". 24 Feb 1993 (age Error: Need valid year, month, day)Expression error: Unrecognized word "feb".Expression error: Unrecognized punctuation character "{".Expression error: Unrecognized punctuation character "{"."
    {{Birth date and age|Feb 24, 1993|df=y}} returns " (Feb 24, 1993-{{{month}}}-{{{day}}}) Expression error: Unrecognized punctuation character "{". Feb 24, 1993 (age Error: Need valid year, month, day)Expression error: Unrecognized word "feb".Expression error: Unrecognized punctuation character "{".Expression error: Unrecognized punctuation character "{"."
    Output as compared to {{Birth-date and age}}
    {{Birth date and age|24 February 1993}} returns " (24 February 1993-{{{month}}}-{{{day}}}) Expression error: Unrecognized punctuation character "{"., 24 February 1993 (age Error: Need valid year, month, day)Expression error: Unrecognized word "february".Expression error: Unrecognized punctuation character "{".Expression error: Unrecognized punctuation character "{"."
    {{Birth-date and age|24 February 1993}} returns "24 February 1993 (1993-02-24) (age 31)"
    {{Birth date and age|Feb. 24, 1993}} returns " (Feb. 24, 1993-{{{month}}}-{{{day}}}) Expression error: Unrecognized punctuation character "{"., Feb. 24, 1993 (age Error: Need valid year, month, day)Expression error: Unrecognized word "feb".Expression error: Unrecognized punctuation character "{".Expression error: Unrecognized punctuation character "{"."
    {{Birth-date and age|Feb. 24, 1993}} returns "Feb. 24, 1993 (1993-02-24) (age 31)"

    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 and age

    This template will return a living person's date of birth and age. 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

    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.

    See also