Template:Map/doc

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

Infobox template for map images. Supports both user created maps, historical maps (user scanned or acquired through galleries, libraries, archives, and/or museums)

Usage

{{Map
 |title             =
 |description       =
 |legend            =
 |author            =
 |image             =
 |date              =
 |source            =
 |permission        =
 |map date          =
 |location          =
 |type              =
 |projection        =
 |scale             =
 |zoom              =
 |heading           =
 |latitude          =
 |longitude         =
 |warp status       =
 |warp url          =
 |set               =
 |sheet             =
 |book author       =
 |book title        =
 |volume            =
 |page              =
 |language          =
 |publication place =
 |publisher         =
 |printer           =
 |print date        =
 |institution       =
 |accession number  =
 |dimensions        =
 |scan resolution   =
 |medium            =
 |credit line       =
 |inscriptions      =
 |notes             =
 |other versions    =
 |references        =
}}

Template parameters

ParameterDescriptionDefaultStatus
title
Title
titleTitle of the map. Skip and use description field if map has no title. Use Language templates when translating and boldface the original-language title, for example:
  • {{en|'''The Title of the Map'''.}}
emptyoptional
wikidata title
Wikidata title
wikidata_title
Wikidata_title
wikidata titleWikidata entity corresponding to the map. Entered like "Q123"emptyoptional
description
Description
descriptionDescription of the map. Required (unless a title was provided)
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.
  • emptyoptional
    legend
    Legend
    legendMap legendemptyoptional
    author
    Author
    authorOriginal 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
    image
    Image
    image generationCan be used for simple descriptions about the generation of that map. See Image generation below.
    Can also be used like other fields to pass the more complicated {{Igen|+|....}}. .
    emptyoptional
    date
    Date
    dateDate of creation of the original source (digital file, or original artwork) by one of the following ways:
  • for simple dates use ISO 8601 format, e.g. "1234" or "2006-01-15" for "15 January 2006". The following formats are recognized:
    • YYYY
    • YYYY-MM
    • YYYY-MM-DD
    • YYYY-MM-DD hh:mm
    • YYYY-MM-DD hh:mm:ss
  • for all other dates use {{Date}} or {{Other date}}
  • emptyoptional
    source
    Source
    sourceInformation about source of the map. Possible values:
  • {{Own}} for works uploaded by the author.
  • {{Derived from}} when it is derived from other files.
  • If image was found on the internet include original URLs (preferably two, embedding web page and image).
  • If image was provided by an institution then provide desired credit line (and if possible URL to the file)
  • If it is a scan from a book than include the book references where you scanned it from (preferably with ISBN and page)
  • emptyrequired
    permission
    Permission
    license
    License
    permissionLicense 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.emptyoptional
    map date
    Map date
    map_date
    Map_date
    map dateThe time or era that the map depicts. Preferably use an ISO date or {{Other date}}emptyoptional
    location
    Location
    locationThe location that the map depicts.emptyoptional
    wikidata location
    Wikidata location
    wikidata_location
    Wikidata_location
    wikidata locationThe wikidata entity for the depicted place (at that time). Entered like "Q123"emptyoptional
    type
    Type
    typeMap type: city map, street map, topographic map, road atlas, nautical chart, thematic mapemptyoptional
    projection
    Projection
    projectionMap projection. Some standard projection names are recognized and displayed in users language. Those include:
  • Miller cylindrical or Miller
  • Albers
  • Mercator
  • Transverse Mercator
  • equirectangular
  • See {{I18n/map projection}}.
    emptyoptional
    scale
    Scale
    scaleMap scale of the printed map. Number "N" specifies the desired map scale as 1:N. See here for more info. If "scale" is not a number than it will be displayed as text.emptyoptional
    zoom
    Zoom
    zoom levelZoom level for 512 x 512 OSM map that could contain the boundaries of this mapemptyoptional
    heading
    Heading
    heading
    Use abbreviations shown in this image
    Map heading to be used to select closest north pointer map symbol. In most maps up-pointing vector follows central vertical longitude line and points North. If that is the case use "N", otherwise provide the compass direction of up-pointing vector as degree values 0-360 (clockwise with north as 0) or a compass point abbreviation (up to 3 letters) as defined in Boxing the compass. Example: heading=NW. See {{Compass rose file}}.
    emptyoptional
    latitude
    Latitude
    latitudeLatitude used to describe geographic limits or range. Parameters "latitude" and "longitude" can take several forms, differentiated by number of values provided. The values are separated by "/":
    • 4 values: Latitude and longitude of four corners of the map. Corners have to be in the counter-clockwise order starting with lower left corner, so they are in lower left, lower right, upper right and upper left corner order.
    • 2 values: Latitude and longitude of each edge of the map. Parameter "latitude" will store South/North latitudes of lower/upper edge and parameter "longitude" will store West/East longitudes of left/right edge
    • 1 value: Latitude and longitude of map center.
    emptyoptional
    longitude
    Longitude
    longitudeLongitude used to describe geographic limits or range. See "latitude" for detailsemptyoptional
    warp status
    Warp status
    warp_status
    Warp_status
    warp statusIndicates if the map has been georeferenced in the Wikimaps Warper. Allowed values are:
  • skip: The map is not suited for the warper;
  • help: An invitation to import the map into the warper;
  • unwarped: The map is in the warper but not rectified;
  • warped: The map is in the warper where it has been rectified.
  • external: A rectified map exists in an external georeferencer.
  • emptyoptional
    warp url
    Warp url
    warp_url
    Warp_url
    warp urlURL for the map if it has external georeferencingemptyoptional
    set
    Set
    setContaining publication (set/atlas/series)emptyoptional
    wikidata set
    Wikidata set
    wikidata_set
    Wikidata_set
    wikidata setWikidata entity corresponding to the set or atlas. Entered as "Q234"emptyoptional
    sheet
    Sheet
    sheetSheet reference (in the set e.g. page number/grid square) or Single sheet map.emptyoptional
    book author
    Book author
    book_author
    Book_author
    book authorAuthor of book (if different from creator of map)emptyoptional
    wd book author
    Wd book author
    wd_book_author
    Wd_book_author
    wikidata book authorWikidata entity corresponding to the book author. Entered as "Q234"emptyoptional
    book title
    Book author
    book_author
    Book_author
    book titleTitle of book (as an alternative to set, or if the map set is bound into a larger book)emptyoptional
    wikidata book
    Wikidata book
    wikidata_book
    Wikidata_book
    wikidata bookWikidata entity corresponding to the book. Entered as "Q234"emptyoptional
    volume
    Volume
    volumeVolume of bookemptyoptional
    page
    Page
    pagePage of bookemptyoptional
    language
    Language
    languageLanguage of the map (most of the time, but not always ISO codes). See mw:Extension:CLDR for details. Do not use the {{Language}} template, it is already coded into this template.emptyoptional
    publication place
    Publication place
    publication_place
    Publication_place
    publication placeplace of publicationemptyoptional
    publisher
    Publisher
    publishermap's publisheremptyoptional
    printer
    Printer
    printermap's printeremptyoptional
    print date
    Print date
    print_date
    Print_date
    print dateYear of map publication if different from date/year of creation. Use {{Other date}} for approximate datesemptyoptional
    ISBNISBNInternational Standard Book Numberemptyoptional
    LCCNLCCNLibrary of Congress Control Number: Authority data from the Library of Congress.emptyoptional
    OCLCOCLCTitle authority data from Online Computer Library Center.emptyoptional
    institution
    Institution
    institutionArchive, museum or collection owning the map. Use:
  • collapsible institution templates such as {{Institution:Louvre}} which displays as
  • Louvre Museum   wikidata:Q19675  (Inventory)
    Louvre Museum
    Native name Louvre Museum Edit this at Wikidata
    Location
    Coordinates 48° 51′ 40″ N, 2° 20′ 09″ E Link to OpenStreetMap Link to Google Maps Edit this at Wikidata
    Established 10 August 1793 Edit this at Wikidata
    Website www.louvre.fr
    Authority file
    institution QS:P195,Q19675

    Those tags are based on {{Institution}} and occupy Institution: namespace.

    emptyoptional
    accession number
    Accession number
    accession_number
    Accession_number
    id
    Id
    ID
    uri
    Uri
    URI
    accession numberMuseum's accession/id number or URI/URN or some other inventory or identification number. Provide also link to museum database if available.emptyoptional
    dimensions
    Dimensions
    size
    Size
    dimensionsDimensions of the artwork: 1D (length), 2D (width × height) or 3D (width × height × depth). Please use {{Size}} formatting template, such as:
  • {{Size|unit=cm|width=76.7|height=83.5}} <— gives height: 83.5 cm (32.8 in); width: 76.7 cm (30.1 in)
    dimensions QS:P2048,83.5U174728
    dimensions QS:P2049,76.7U174728
  • or {{Size|in|32.2|34.87}} <— gives 32.2 × 34.8 in (81.7 × 88.5 cm), if sizes are given in inches
  • Avoid using Language templates
  • emptyoptional
    scan resolution
    Scan resolution
    scan_resolution
    Scan_resolution
    scan resolutionResolution of the scan, eg: 200 dpiemptyoptional
    medium
    Medium
    technique
    Technique
    mediumMedium (technique and materials) used to create map. Use, when possible:
  • {{Technique}} template
  • multilingual Technique tags, like {{Oil on canvas}}
  • {{Reproduction}} template to distinguish between the technique of a reproduction and of the original map
  • emptyoptional
    credit line
    Credit line
    credit_line
    Credit_line
    credit LineDescribes how the artwork came into the museum's collection, or how it came to be on view at the museum, for instance: Gift of the Friends of the Louvre Society, 1961—an important information for museological research. This line may also be part of the museum's obligations to the donor. Not to be confused with credit line attributing the photographer required by CC licensesemptyoptional
    inscriptions
    Inscriptions
    inscriptionsDescription of: inscriptions, watermarks, captions, coats of arm, etc. Use {{Inscription}}emptyoptional
    notes
    Notes
    notesAdditional information about the map.emptyoptional
    other versions
    Other versions
    other_versions
    Other_versions
    other 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
    references
    References
    referencesBooks and websites with information about the artwork. Please use {{Cite book}} and {{Cite web}} templates.emptyoptional
    demodemo"demo=1" will show all the fields used by the template empty or not. Meant to be used only in template: namespace when demonstrating template fields. Usual form is "demo=<noinclude>1</noinclude>".emptyoptional
    adjacent sheetsAdjacent sheetsMap sheets (or tiles) bordering this one. Easiest way is to fill with a specific template, like {{Neighboring sheets Swisstopo Dufourkarte|id}} that populates {{Neighboring maptiles}}.emptyoptional
    sheet indexSheet indexIndex of all map sheets of this set, ideally an index map.emptyoptional
    other fields
    other_fields
    Other fields
    Other_fields
    other fieldsAdditional table fields. Easiest way to use it is through {{Information field|name=Field Name|value=Field Value}}.
    There are also other_fields_1,2,3,4,5 for placing fields in other locations.
    emptyoptional
    <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.


    Wikipedia's help about TemplateDataCommons-specific information

    Infobox template for map images. Supports both user created maps, historical maps (user scanned or acquired through galleries, libraries, archives, and/or museums)

    Template parameters

    This template prefers block formatting of parameters.

    ParameterDescriptionTypeStatus
    ISBNISBN

    International Standard Book Number

    Stringoptional
    LCCNLCCN

    Library of Congress Control Number

    Stringoptional
    OCLCOCLC

    Online Computer Library Center Number

    Stringoptional
    accession numberaccession number Accession number accession_number Accession_number id Id ID uri Uri URI

    Museum's accession/id number or URI/URN or some other inventory or identification number. Provide also link to museum database if available.

    Stringoptional
    Adjacent sheetsadjacent sheets

    Map sheets (or tiles) bordering this one. Easiest way is to fill with a specific template, like {{Neighboring sheets Swisstopo Dufourkarte|id}} that populates {{Neighboring maptiles}}.

    Stringoptional
    authorauthor Author

    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.

    Stringrequired
    book authorbook author Book author book_author Book_author

    Author of book (if different from creator of map)

    Stringoptional
    book titlebook title Book author book_author Book_author

    Title of book (as an alternative to <code>set</code>, or if the map set is bound into a larger book)

    Stringoptional
    credit Linecredit line Credit line credit_line Credit_line

    Information about source of the file or the photographer. Possible values: If image was found on the internet include original URLs (preferably two, embedding web page and image). If it is a scan from a book than include the book references where you scanned it from (preferably with ISBN and page) If it is your own or someone else photograph than provide the name of the photographer Some examples: ArtRenewal.org : Gallery : Info : Pic, Milner, John: Mondrian, p. 35 - <span lang="en" dir="ltr">[[:en:ISBN|<span lang="en" dir="ltr">ISBN</span>]]</span>&nbsp;[[Special:BookSources/0714831670|0714831670]], Be aware what for 2D works like paintings only copyrights of the original artist are important so if the artist died more than 70 years ago most images found on the web or scanned from art books are OK. However in case of sculptures and other 3D works information about the photographer is important to justify the license.

    Stringoptional
    datedate Date

    Date of creation, when the original source (digital file, or original artwork) was created. Use ISO dates or {{other date}}

    Stringoptional
    demodemo

    "demo=1" will show all the fields used by the template empty or not. Meant to be used only in template: namespace when demonstrating template fields.

    Stringoptional
    descriptiondescription Description

    Description of the map. Please use multilingual templates like {{en|1=}}. This field is required (unless a title was provided).

    Stringoptional
    dimensionsdimensions Dimensions size Size

    Dimensions or size of the artwork. Use {{Size}} when possible

    Stringoptional
    headingheading Heading

    Map heading to be used to select closest north pointer map symbol. In most maps up-pointing vector follows central vertical longitude line and points North. If that is the case use N, otherwise provide the compass direction of up-pointing vector as degree values 0-360 (clockwise with north as 0) or a compass point abbreviation (up to 3 letters).

    Stringoptional
    image generationimage Image

    Can be used for '''simple''' descriptions about the generation of that map. See [[#Image generation|Image generation]] below.<br />Can also be used like <code>other fields</code> to pass the more complicated <code>{{Igen|+|....}}</code>. .

    Unknownoptional
    inscriptionsinscriptions Inscriptions

    Description of: inscriptions, watermarks, captions, coats of arm, etc. Use {{inscription}}

    Stringoptional
    institutioninstitution Institution

    Archive, museum or collection owning the map. Use: institution templates such as {{Institution:Louvre}}. For private collection use {{Private collection}}

    Stringoptional
    languagelanguage Language

    Language of the map (most of the time, but not always ISO 639-3 codes).

    Stringoptional
    latitudelatitude Latitude

    Latitude used to describe geographic limits or range. Parameters "latitude" and "longitude" can take several forms, differentiated by number of values provided. The values are separated by "/":

    • 4 values: Latitude and longitude of four corners of the map. Corners have to be in the counter-clockwise order starting with lower left corner, so they are in lower left, lower right, upper right and upper left corner order.
    • 2 values: Latitude and longitude of each edge of the map. Parameter "latitude" will store South/North latitudes of lower/upper edge and parameter "longitude" will store West/East longitudes of left/right edge
    • 1 value: Latitude and longitude of map center.

    Stringoptional
    legendlegend Legend

    Map legend

    Stringoptional
    locationlocation Location

    The location that the map depicts.

    Stringoptional
    longitudelongitude Longitude

    Longitude used to describe geographic limits or range. See "latitude" for details

    Stringoptional
    map datemap date Map date map_date Map_date

    The time or era that the map depicts. Preferably use an ISO date or {{other date}}

    Stringoptional
    mediummedium Medium technique Technique

    Medium (technique and materials) used to create the map.

    Stringoptional
    notesnotes Notes

    Additional information about the map.

    Stringoptional
    other fieldsother fields other_fields Other fields Other_fields

    Additional table fields. Easiest way to use it is through {{Information field|name=Field Name|value=Field Value}}.<br />There are also other_fields_1, 2, 3, 4, 5 for placing fields in other locations.

    Stringoptional
    other versionsother versions Other versions other_versions Other_versions

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

    Stringoptional
    pagepage Page

    Page of book

    Stringoptional
    permissionpermission Permission license License

    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
    print dateprint date Print date print_date Print_date

    Year of map publication if different from date/year of creation. Use {{other date}} for approximate dates

    Stringoptional
    printerprinter Printer

    map's printer

    Stringoptional
    projectionprojection Projection

    Map projection. Some standard projection names are recognized and displayed in users language. See Template:I18n/map projection for more information.

    Stringoptional
    publication placepublication place Publication place publication_place Publication_place

    place of publication

    Stringoptional
    publisherpublisher Publisher

    map's publisher

    Stringoptional
    referencesreferences References

    Books and websites with information about the artwork.

    Stringoptional
    scalescale Scale

    Map scale of the printed map. Number "N" specifies the desired map scale as 1:N. If "scale" is not a number than it will be displayed as text.

    Stringoptional
    scan resolutionscan resolution Scan resolution scan_resolution Scan_resolution

    Resolution of the scan, eg: 200 dpi

    Stringoptional
    setset Set

    Containing publication (set/atlas/series)

    Stringoptional
    sheetsheet Sheet

    Sheet reference (in the set e.g. page number/grid square) or Single sheet map.

    Stringoptional
    Sheet indexsheet index

    Index of all map sheets of this set, ideally an index map.

    Stringoptional
    sourcesource Source

    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 using {{Derived from}}. For images provided by institutions give then desired credit line (and if possible URL to the file)

    Stringrequired
    titletitle Title

    Title of the map. Skip and use description field if map has no title.

    Stringoptional
    typetype Type

    Map type: city map, street map, topographic map, road atlas, nautical chart, thematic map

    Stringoptional
    volumevolume Volume

    Volume of book

    Stringoptional
    warp statuswarp status Warp status warp_status Warp_status

    Indicates if the map has been georeferenced in the Wikimaps Warper. Allowed values are skip/help/unwarped/warped.

    Stringoptional
    warp urlwarp url Warp url warp_url Warp_url

    URL for the map if it has external georeferencing

    Stringoptional
    wikidata book authorwd book author Wd book author wd_book_author Wd_book_author

    Wikidata entity corresponding to the book author. Entered as "Q234"

    Stringoptional
    wikidata bookwikidata book Wikidata book wikidata_book Wikidata_book

    Wikidata entity corresponding to the book. Entered as "Q234"

    Stringoptional
    wikidata locationwikidata location Wikidata location wikidata_location Wikidata_location

    The wikidata entity for the depicted place (at that time). Entered like "Q123"

    Stringoptional
    wikidata setwikidata set Wikidata set wikidata_set Wikidata_set

    Wikidata entity corresponding to the set or atlas. Entered as "Q234"

    Stringoptional
    wikidata titlewikidata title Wikidata title wikidata_title Wikidata_title

    Wikidata entity corresponding to the map. Entered like "Q123"

    Stringoptional
    zoom levelzoom Zoom

    Zoom level for 512 x 512 OSM map that could contain the boundaries of this map

    Stringoptional

    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

    Placement: At the top of the page

    Relies on:
    {{I18n/map}} (field name translations), {{I18n/map projection}} (translations and Wikipedia links for selected map projections), {{Compass rose file}} (file displayed in header field), {{Map/bbox}} (bounding box)

    Localization

    To add your language to the list of languages supported by this template, please edit the template and add a row to the "{{LangSwitch|}}" construct. It takes the form "|xx= Your translation " (xx being the code of your language)

    Translations are handled by {{I18n/map}} and {{I18n/map headers}} templates

    Image generation

    Every vector or raster graphic image should be provided by a statement about its development. This can be done with the template Igen as a value of other fields, or in a very short form with an argument for image. This argument can be

    • two values separated by a slash: the first and the second parameter for template Image generation, e.g.
    • A/0 for valid Adobe   (I/0 or /12 can be written simply as one value 0 or 12)
    • D/3 for CorelDraw, invalid due to 3 errors
    • GIMP/n for a raster image created with GIMP
    • when more or other parameters are needed, use the standard form |image={{igen|A|+|<|gd|&|s=m|...

    The following specifications are equivalent:

    • |image=Q/0
    • |image={{Igen/map|Q/0}}
    • |image={{Igen/map|Q|0}}
    • |image={{Igen|Q|+}}
    • |image={{Igen|QGIS|+|s=m}} or even more complicated