Template:KeyDescription/doc

From OpenStreetMap Wiki
Jump to navigation Jump to search
Dialog-warning-yellow.svg Note: This template is used on a lot of pages. In order not to put too much load on the servers, edits should be kept to a bare minimum.
Please discuss proposed changes on the talk page first.
Editing a template causes all pages that use the template to be re-rendered. If the Template is used often, this can put a lot of load on the servers since it fills up the job queue. [statistics]

Intro

This template provides a description box suitable for keys. As of December 2018, a backing data item is created either by a bot or by hand for all pages that use this template. The bot copies many of the template parameters to the data item, making them available in a machine-readable format.

This template uses corresponding data item for some of the missing parameters (e.g. key, image, description, group, status, on*, ...), so in theory most of the template parameters are no longer needed, but they should not be deleted just yet -- some tools like TagInfo do not consume data items directly, but instead try to parse template parameters. Once TagInfo is updated, it will be ok to delete parameters -- just placing {{KeyDescription}} template without parameters to a properly named Key:* or Lang:Key:* page will show values from the data item in the correct language (for other pages key and lang parameters will still be needed).

To view or translate the data item, click the grey pencil icon next to the description, or click the OpenStreetMap Wiki item link in the left sidebar. If the description is different from the data item, it will also show a red pencil icon to edit the wiki page itself. They should be made identical. Description should be one or more complete sentences (start with a capitalized letter, ending with a period), max 250 symbols. Do not use any wiki markup. English label should be identical to the key (usually a lower case word). When translating, make sure to add description, but labels are optional. Do not copy English label if it is the same. Some languages like to add "nativekey" - a localized alternative to the original key. Lastly, add any number of alternative names for the key to the "also known as" (aliases) column. Some tools use aliases to offer a quick key search.

This template just calls Module:DescriptionFromDataItem Lua code, all handling of parameters and data items is happening there.

Usage

Full parameter set in vertical format
Vertical list Prerequisites Brief instructions / notes
{{KeyDescription
| key           = 
| nativekey     = 
| image         = 
| description   = 
| osmcarto-rendering      = 
| osmcarto-rendering-size = 
| group         = 
| website       = 
| url_pattern   = 
| onNode        = 
| onWay         = 
| onArea        = 
| onRelation    = 
| requires      = 
| implies       = 
| combination   = 
| seeAlso       = 
| wikidata      = 
| status        = 
| statuslink    = 
}}
 
 
 
 
 
 
rendered icon
 
 
website
 
 
 
 
 
 
 
 
 
 
status
 
 
 
The key name in native language
 
 
may not work if osmcarto-rendering-size is not set
usually 14
 
 
 
 
 
 
 
 
 
 
 
Qnnnn
 
 
  • If a field name is listed in the Prerequisites column it is a prerequisite for the field to the left.

Parameters

The following parameters are recognised:

Feature description

  • key: the key being described (required).
  • nativekey: the key name in native language.
  • image: the name of an image to be used to illustrate the feature (optional, a "no image" will be displayed if not specified).
  • description: a short description of the feature in question (required).
  • osmcarto-rendering: icon in the standard tile layer
  • osmcarto-rendering-size: size of the icon in pixels (usually 14)
  • group: the name of the broader group or category to which this feature belongs (optional).
  • website: the main website(s) associated with this feature (optional).
  • url_pattern: pattern to generate deep-link URLs for instances of this feature (optional).

Feature usage

The following parameters are optional. They are however recommended as their absence means that these uses have still not been decided or the use of the tag is still experimental.

  • onNode: yes if the feature being described is suitable for use on node elements, no otherwise.
  • onWay: yes if the feature being described is suitable for use on linear (non-area) way elements, no otherwise.
  • onArea: yes if the feature being described is suitable for use on area elements, no otherwise.
  • onRelation: yes if the feature being described is suitable for use on (non-multipolygon) relation elements.

Additional information

  • requires: a list of tags which are necessary (often higher/lower in hierarchy) for this tag and must be set to give its actual meaning (optional)
  • implies: a list of tags/values which are assumed when absent; see below for examples; tag them explicitly for exceptions (optional)
  • combination: a list of additional tags which are useful in combination with this one (optional); see below for examples
  • seeAlso: references to additional pages which may be of interest (optional)
  • status: the approval status of this feature (should be filled in); possible values include:
  • abandoned: the approval process for this feature has been terminated before completion and usage of this tagging is minimal
  • approved: the feature has successfully completed the approval process
  • de facto: the tag is in widespread use, it was not approved in a proposal process, it has a widespread acceptance among mappers
  • deprecated: deprecated tags that are discouraged from being used
  • discardable: tags that are so useless that editors remove them automatically, for example Tag:odbl=clean
  • draft: the feature has a draft proposal being written and usage of this tagging is minimal
  • in use: the feature is in use
  • obsolete: a feature which is no longer found in the database
  • proposed: the feature has been proposed to be used and usage of this tagging is minimal
  • rejected: the feature was rejected during the approval process and usage of this tagging is minimal
  • unspecified or undefined or unknown or  (empty): unclear situation
  • voting: the feature is currently being voted on as part of the approval process
  • Note that in use and de facto can be used for tags that are in use but have proposal in some stage that was not approved. For example accepted, heavily used tag with rejected proposal can have de facto status

By "usage of this tagging is minimal" it is meant that there is minimal usage world wide, for example a tag that has been used 50 times. Note that depending on the tag low usage may be normal, generally properties will have a much higher usage than specific features.

  • inuse is sometimes applied instead in use, the same with defacto instead of de facto. It is highly preferable to avoid this.
  • statuslink: name of the proposal page, for linking
  • wikidata: the equivalent, top-level, item on Wikidata; if not specified, a link to a Wikidata search tool will be displayed to find it. (optional)

Language support

  • lang: (optional) the BCP 47 language tag (most often based on a ISO 639-1 alpha-2 language code, or ISO 639-2 alpha-3 technical language code, or ISO 639-3 alpha-3 language code otherwise, possibly followed by script/region/variant subtags) for the language used to document this feature: this will generate aspects of the description box in the specified language, if translations are available. If a language code is not specified, the default will be determined from the full name of the current page using {{Langcode}}.

Advanced formatting parameters

These parameters can generally be ignored by the majority of users. They are available for fine-tuning the presentation of the description box, and are useful for including in examples, or embedding in tutorial pages.

  • class: specify the CSS class of the HTML table used to form the description box.
  • float: specify the CSS float value of the table: set to none to disable the standard right float.
  • style: the CSS style to be applied to the HTML table: overrides |float= if present.
  • languagelinks: set to no to inhibit links to corresponding pages in other languages (used for example on this documentation page).

Examples

Note: In these examples, long lines have been wrapped for convenience. The advanced formatting parameters, class, float, style and languagelinks are not show, as their values are specific to use as examples.

{{KeyDescription
| key         = dessert
| image       = 
| description = A dessert is a sweet dish, typically served towards the end of a meal.
| group       = cuisine
| onNode      = yes
| onWay       = no
| onArea      =
| onRelation  = yes
| requires    =
| implies     =
* {{Tag|edible||yes}}
| combination =
* {{Tag|meal|dinner}}
* {{Tag|sweet||yes}}
| seeAlso     =
* {{Tag|dessert|cheesecake}}
* {{Tag|dessert|gateau}}
| wikidata    =
| status      = Imaginary
| lang        = en
}}
Public-images-osm logo.svg dessert
Osm element key.svg
Description
A dessert is a sweet dish, typically served towards the end of a meal.
Group: Cuisine
Used on these elements
may be used on nodesshould not be used on waysuse on areas unspecifiedmay be used on relations
Implies
Useful combination
See also
Status: imaginary

Wikidata
{{KeyDescription
| key         = shop
| image       = File:Geograph shop.jpg
| description = Место розничной торговли или оказания услуг.
| group       = shops
| onNode      = yes
| onWay       = no
| onArea      = yes
| onRelation  = no
| requires    =
| implies     = 
| combination =
* {{Tag|name}}
* {{Tag|opening_hours}}
| seeAlso     = 
| wikidata    = Q213441
| status      = de facto
| lang        = ru
}}
Public-images-osm logo.svg shop
Geograph shop.jpg
Описание
Место розничной торговли или оказания услуг. Edit or translate this description.
Группа: Shops
Используется на элементах
точки можно отмечать этим тегомлинии не принято отмечать этим тегомполигоны можно отмечать этим тегомотношения не принято отмечать этим тегом
Задокументировано значений: 260
Полезные сочетания
Статус: де-фактоPage for proposal

Викиданные
{{KeyDescription
| key         = openplaques:id
| description = For plaques listed on OpenPlaques.org.
| website     = http://openplaques.org/
| url_pattern = http://openplaques.org/plaques/[value]
| group       = historic
| onNode      = yes
| onWay       = no
| onArea      = no
| requires    =
* {{Tag|memorial|plaque}}
| implies     =
* {{Tag|historic|memorial}}
| combination =
* {{Tag|name}}
| seeAlso     =
| status      = unspecified
| lang        = en
}}
Public-images-osm logo.svg openplaques:id
Osm element key.svg
Description
For plaques listed on OpenPlaques.org. Edit or translate this description.
Group: Historic
Website
http://openplaques.org/
URL pattern
http://openplaques.org/plaques/[value]
Used on these elements
may be used on nodesshould not be used on waysshould not be used on areasshould not be used on relations
Requires
Implies
Useful combination
Status: unspecified

Wikidata

See also