Template:Information/doc

Revision as of 21:30, 17 August 2013 by Rillke (talk | contribs) (adding type string/line per talk)

Please give full information for the date, source and author fields. The date of a photograph must be when the original photograph was created, and not the date of upload, nor the date of any scan or other derivative action. If the photographic image has been modified please give author, date and license for each modification. Please use template {{Artwork}} if the image is of a painting, sculpture or other artwork and {{Book}} if the image is a part of a complete set of page scans of a book (or in the case of DjVu and PDF, one file may comprise all the page).

This template is used to provide formatting to the basic information for files (file content, license, authorship information etc.). This template is automatically inserted by the JavaScript-aided upload tool too.

For a full usage description of the template, see Commons:First steps/Quality and description.

Usage

{{Information
 |description =
 |date =
 |source =
 |author =
 |permission =
 |other_versions =
}}

Template parameters

ParameterDescriptionDefaultStatus
descriptionDescriptionDescription of the image or other media file. Content of the description should provide brief (if possible) but complete information about the image. It should:
  • Identify subject like notable people (use {{Depicted person}} template), animals, objects, cars, weapons, etc.
  • Identify location (if relevant) by text, like: city, country, building name or address, etc.
  • Note that location coordinates are not directly included as separate field in the "Information" template. Template {{Location}} (for camera location and heading, preferred) and/or {{Object location}} (for the depicted objects) should be used. Template {{Location}} should be placed directly above or below {{Information}}.
    Note: some users prefer to include location template(s) into the „Description“ field of {{Information}} template in order to group all location information together – this solution is fully serviceable but objections are in point of graphic design not ideal adjusted for such use. See this and this discussion.
  • In general description should provide information to support all subject categories of the file.
  • In case of group pictures or other images where image details might warrant separate description please use image annotations, but remember that those annotations might not be visible on Wikipedias which did not adopt the gadget to display them.


Description format should use:

  • Multilingual templates like {{En}} or {{De}} to specify the language of the description.
  • Wikilinks to Wikipedia articles. This helps with disambiguation and allows shorter format.
emptyrequired
dateDate of creationDate of creation, when the original source (such as photograph of 3-D scene, digital file, or original 2-D artwork) was created. Possible formats:
  • ISO 8601 is the preferred format, e.g. "2006-01-15" for "15 January 2006". Dates following this format are processed by {{ISOdate}}. The following formats are recognized:
    • YYYY
    • YYYY-MM
    • YYYY-MM-DD
    • YYYY-MM-DD hh:mm
    • YYYY-MM-DD hh:mm:ss
  • Use {{Other date}} for less precise dates, like: circa..., after..., spring of..., between..., etc.
  • It is possible to use {{Date}} template. For example "date=2008-06-09" is equivalent to "date={{date|2008|6|9}}", but ISO 8601 format is preferred.

  • In many cases multiple dates and/or extra explanations are required:

    • For photos, we have special templates {{Taken on}} and {{Taken in}} to indicate when the photograph was taken and to distinguish it from the creation date of the depicted work or from the creation date of the derivative work (modified or cropped photo, collage etc.). Those templates use ISO format (e. g. {{Taken on|YYYY-MM-DD hh:mm}} or {{Taken in|YYYY}}).
    • If date is missing but digital file has EXIF data then {{According to EXIF data}} template can be added (usually done by a bot). The templates use ISO format (e. g. {{According to EXIF data|YYYY-MM-DD}}).
    • If the creation date of a file moved from other project is unknown, {{Original upload date}} can be used — this template should be also used (in addition) if the first publication date (outside Commons) is relevant in relation to copyright. This template also uses the ISO format.
    • If the creation date of a file (not moved from other project) is unknown, {{Upload date}} can be used. This template also use the ISO format.
    • If the file is a modified or derivative work, both date of the original (source) work and date of the last version (derivative work) should be stated with appropriate comments or notes.
    • If the date has to be furnished with some specifying text, not covered by one of the above templates, (e. g. "date of creation", "date of the first publication", "date of modification" etc.) then dates have to be specified using {{ISOdate}} (i.e. {{ISOdate|2009-08-18}} (date of creation))) or {{Date}} (i.e. {{date|2008|6|9}} (date of modification)) templates.
    • If the file is not a simple copy of the depicted work, the date or year of the creation of the depicted work should be stated rather in the "description" field
    emptyrequired
    sourceSourceInformation about where the file is from (own files should be tagged with {{Own}}); if the file is based on other files then the original files should be also uploaded (if possible) and referenced. Possible content:
  • {{Own}} for works uploaded by the author.
  • URL where the file was found on the web.
  • {{Derived from}} when it is derived from other files.
  • Book reference (using {{Scan}} and {{Cite book}} templates) for images scanned from a book. If image was scanned by the uploader that should be mentioned too.
  • emptyrequired
    authorAuthorOriginal author of the file; where appropriate, use {{Creator:Name Surname}}. If the work is derived from or depicts works by someone other than the author, the author of the original work should also be mentioned. For example, for a photograph of a sculpture, make a mention of both the sculptor and the photographer. This field should not be used to specify the scanner, finder or uploader of the image; they are not the author.emptyrequired
    permissionPermissionLicense and other usage limitations and warnings. Due to the size of many license templates they are often placed in a separate section below {{Information}} template. In such a case please leave this field blank.
    The license is related primarily to the file itself. If need to state a license of the depicted (or other source) work, include it additionally with appropriate comment. If needed, use relevant. You can use {{Artwork}} instead of {{Information}} for simple copies of artworks.
    emptyoptional
    other_versionsOther versionsLinks to files with very similar content or derived files; use thumbnails or Gallery tags <gallery> </gallery>.

    {{F}} enables to show also small icons of these files.

    If appropriate, {{Derivative versions}} is useful.
    emptyoptional
    other_fieldsOther fieldsAdditional table fields added on the bottom of the template. You have to use {{Information field}} or similar template ({{Credit line}}, ...) to populate this field.emptyoptional
    Template data
    <templatedata>JSON</templatedata> ./. {{TemplateBox}}
    TemplateData

    TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


    Existing template documentation
    At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

    Newly created template documentation and imports
    Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

    Discussion
    There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


    Wikipedia's help about TemplateDataCommons-specific information

    This template is used to provide formatting to the basic information for files (file content, license, authorship information etc.). This template is automatically inserted by the JavaScript-aided upload tool too. For a full usage description of the template, see Commons:First steps/Quality and description.

    Template parameters

    This template prefers inline formatting of parameters.

    ParameterDescriptionTypeStatus
    Authorauthor

    Original author of the file; where appropriate, use {{Creator:Name Surname}}. If the work is derived from or depicts works by someone other than the author, the author of the original work should also be mentioned. For example, for a photograph of a sculpture, make a mention of both the sculptor and the photographer. This field should not be used to specify the scanner, finder or uploader of the image; they are not the author.

    Linerequired
    Date of creationdate

    Date of creation, when the original source (such as photograph of 3-D scene, digital file, or original 2-D artwork) was created.

    Linerequired
    Descriptiondescription

    Description of the image or other media file.

    Stringrequired
    Other fieldsother_fields

    Additional table fields added on the bottom of the template. You have to use {{Information field}} or similar template ({{Credit line}}, ...) to populate this field.

    Stringoptional
    Other versionsother_versions

    Links to files with very similar content or derived files; use thumbnails or Gallery tags.

    Stringoptional
    Permissionpermission

    License and other usage limitations and warnings. Due to the size of many license templates they are often placed in a separate section below {{information}} template. In such a case please leave this field blank.

    Stringoptional
    Sourcesource

    Information about where the file is from (own files should be tagged with {{own}}); if the file is based on other files then the original files should be also uploaded (if possible) and referenced.

    Linerequired

    Additional information

    The template is intended to be used in the following namespaces: the File namespace

    The template is intended to be used by the following user groups: all users

    Relies on:
    Template:ISOdate, Template:Parse source

    Localization

    This template is localized by utilizing MediaWiki namespace messages. These can be translated at translatewiki.net (current translations).

    Example usage

    Example for photograph

    For example the source code of the description of photograph File:Piers Sellers spacewalk.jpg is:

    {{Information
    |Description=
    {{de|Astronaut [[:de:Piers John Sellers|Piers Sellers]] bei einem Außenbordeinsatz während der Space-Shuttle-Mission [[:de:STS-121|STS-121]], bei dem er Reparaturtechniken für den Hitzeschutzschild der Raumfähre testet. Der Außenbordeinsatz dauerte 7 Stunden und 11 Minuten.}}
    {{en|Astronaut [[w:Piers Sellers|Piers Sellers]] during the third spacewalk of STS-121, a demonstration of orbiter heat shield repair techniques.}}
    {{fr|L'astronaute [[:fr:Piers Sellers|Piers Sellers]] durant sa troisième sortie dans l'espace au cours du vol STS-121, une démonstration des techniques de réparation du bouclier thermique.}}
    {{it|L'astronauta [[:it:Piers Sellers|]] durante la terza camminata nello spazio nel corso della missione STS-121 mentre esegue un test di riparazione delle mattonelle rinforzate carbonio-carbonio dello Shuttle.}}
    {{nds|De Astronaut [[Piers Sellers]] de drüdde Kehr, dat he mit’n Ruumantog in’n apen Weltruum togang weer. Sellers wiest Reparaturtechniken för den Hittschild von’n Orbiter.}}
    {{ru|Астронавт [[:ru:Селлерс, Пирс Джон|Пирс Селлерс]] во время третьего выхода в открытый космос (STS-121) при ремонте орбитального теплового экрана.}}
    {{fi|Astronautti [[:fi:Piers Sellers|Piers Sellers]] avaruussukkulalento STS-121:n kolmannella avaruuskävelyllä. Avaruuskävelyn tehtävänä oli kokeilla sukkulan lämpökilven korjaustekniikoita.}} 
    |Source=[http://www.nasa.gov/news/highlights/index.html NASA News & Events] – http://www.nasa.gov/externalflash/121_gallery/hi-resjpgs/14.jpg, from http://www.nasa.gov/externalflash/121_gallery/index_noaccess.html
    |Date=2006-07-12
    |Author=NASA, astronaut [[w:Michael E. Fossum|Michael Edward Fossum]]
    |Permission={{PD-USGov-NASA}}
    |other_versions=
    }}
    

    The code hereinbefore produces the following information table:

    Description
    Deutsch: Astronaut Piers Sellers bei einem Außenbordeinsatz während der Space-Shuttle-Mission STS-121, bei dem er Reparaturtechniken für den Hitzeschutzschild der Raumfähre testet. Der Außenbordeinsatz dauerte 7 Stunden und 11 Minuten.
    English: Astronaut Piers Sellers during the third spacewalk of STS-121, a demonstration of orbiter heat shield repair techniques.
    Français : L'astronaute Piers Sellers durant sa troisième sortie dans l'espace au cours du vol STS-121, une démonstration des techniques de réparation du bouclier thermique.
    Italiano: L'astronauta Piers Sellers durante la terza camminata nello spazio nel corso della missione STS-121 mentre esegue un test di riparazione delle mattonelle rinforzate carbonio-carbonio dello Shuttle.
    Plattdüütsch: De Astronaut Piers Sellers de drüdde Kehr, dat he mit’n Ruumantog in’n apen Weltruum togang weer. Sellers wiest Reparaturtechniken för den Hittschild von’n Orbiter.
    Русский: Астронавт Пирс Селлерс во время третьего выхода в открытый космос (STS-121) при ремонте орбитального теплового экрана.
    Suomi: Astronautti Piers Sellers avaruussukkulalento STS-121:n kolmannella avaruuskävelyllä. Avaruuskävelyn tehtävänä oli kokeilla sukkulan lämpökilven korjaustekniikoita.
    Date
    Source NASA News & Eventshttp://www.nasa.gov/externalflash/121_gallery/hi-resjpgs/14.jpg, from http://www.nasa.gov/externalflash/121_gallery/index_noaccess.html
    Author NASA, astronaut Michael Edward Fossum
    Permission
    (Reusing this file)
    Public domain This file is in the public domain in the United States because it was solely created by NASA. NASA copyright policy states that "NASA material is not protected by copyright unless noted". (See Template:PD-USGov, NASA copyright policy page or JPL Image Use Policy.)
    Warnings:

    Example other_fields

    Example using the other_fields parameter to display a credit line:

    {{Information
    | Description  = Description
    | Source       = {{own}}
    | Author       = John Doe
    | Date         = 2008-06-09
    | Other_fields = {{Credit line |Author = © John Doe | Other = Wikimedia Commons |License = CC-BY-3.0 & GFDL}}
    }}

    will produce:

    Description Description
    Date
    Source Own work
    Author John Doe
    Attribution
    (required by the license)
    InfoField
    © John Doe / Wikimedia Commons / 
    © John Doe / Wikimedia Commons

    Recommendations

    For many media it is desirable to use a geocoding template in addition to the Information template.

    Microformat

    This template also emits an hCalendar microformat marking the creation of the image as an event. To do this, it requires the {{Date}} template, and takes the file name as the "summary" property. Optionally, it can include the {{Creator}} as an attendee and an hCard microformat, and use the contents of {{Description}} as the hCalendar's "description" property. Coordinates may be included by use of {{Location}}, {{Location dec}} or {{Object location}}.

    See also Commons:Machine-readable data.

    See also