Template:KeyDescription/doc

 · Help

Available languages — KeyDescription/doc

• Afrikaans • Alemannisch • aragonés • asturianu • azərbaycanca • Bahasa Indonesia • Bahasa Melayu • Bân-lâm-gú • Basa Jawa • Baso Minangkabau • bosanski • brezhoneg • català • čeština • dansk • Deutsch • eesti • English • español • Esperanto • estremeñu • euskara • français • Frysk • Gaeilge • Gàidhlig • galego • Hausa • hrvatski • Igbo • interlingua • Interlingue • isiXhosa • isiZulu • íslenska • italiano • Kiswahili • Kreyòl ayisyen • kréyòl gwadloupéyen • kurdî • latviešu • Lëtzebuergesch • lietuvių • magyar • Malagasy • Malti • Nederlands • Nedersaksies • norsk • norsk nynorsk • occitan • Oromoo • oʻzbekcha/ўзбекча • Plattdüütsch • polski • português • română • shqip • slovenčina • slovenščina • Soomaaliga • suomi • svenska • Tiếng Việt • Türkçe • Vahcuengh • vèneto • Wolof • Yorùbá • Zazaki • српски / srpski • беларуская • български • қазақша • македонски • монгол • русский • тоҷикӣ • українська • Ελληνικά • Հայերեն • ქართული • नेपाली • मराठी • हिन्दी • অসমীয়া • বাংলা • ਪੰਜਾਬੀ • ગુજરાતી • ଓଡ଼ିଆ • தமிழ் • తెలుగు • ಕನ್ನಡ • മലയാളം • සිංහල • ไทย • မြန်မာဘာသာ • ລາວ • ភាសាខ្មែរ • ⵜⴰⵎⴰⵣⵉⵖⵜ • አማርኛ • 한국어 • 日本語 • 中文（简体）‎ • 吴语 • 粵語 • 中文（繁體）‎ • ייִדיש • עברית • اردو • العربية • پښتو • سنڌي • فارسی • ދިވެހިބަސް

Other languages — Help us translate this wiki

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 gray 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.

All data item logic is done by Module:DescriptionFromDataItem Lua code.

Usage

Full parameter set in vertical format

Vertical list	Prerequisites	Brief instructions / notes
{{KeyDescription | key = | image = | image_caption = | description = | group = | website = | url_pattern = | onNode = | onWay = | onArea = | onRelation = | requires = | implies = | combination = | seeAlso = | wikidata = | status = | statuslink = | lang = | class = | float = | style = | languagelinks = }}	image       website                     status	Qnnnn     en, de, fr, ja, etc. (not needed in normal pages with correct language code prefix)   set |float=none to inhibit floating   don't set this in standard description pages

• 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).
• image: the name of an image to be used to illustrate the feature (optional, a "no image" will be displayed if not specified).
• image_caption: the description of the image used to illustrate the feature (optional).
• description: a short description of the feature in question (required).
• group: the name of the broader group 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 (unclosed) 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).
• wikidata: identifier (Qnnn) of data element used in Wikidata (optional); if not specified, a link to a Wikidata search tool will be displayed to find it.
• status: the approval status of this feature (optional but recommended, the absence means "unspecified"); possible values include:
  • inuse: the feature is in use;
  • approved: the feature has successfully competed the approval process;
  • rejected: the feature was rejected during the approval process;
  • voting: the feature is currently being voted on as part of the approval process;
  • proposed: the feature has been formally proposed;
  • draft: the feature has a draft proposal being written;
  • abandoned: the approval process for this feature has been terminated before completion;
  • defacto: the tag is in widespread use, but no formal proposal process has taken place.
• statuslink: name of the proposal page, for linking (optional but should be set for approved/rejected status). Example.

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
}}

dessert
Description
A dessert is a sweet dish, typically served towards the end of a meal.
Group: Cuisine
Used on these elements
Implies
edible=yes
Useful combination
meal=dinner sweet=yes
See also
dessert=cheesecake dessert=gateau
Wikidata
Search Wikidata
Status: imaginary
Tools for this tag
taginfo · CH · CZ · FR · GB · HU · IE · IN · JP · PL overpass-turbo

• (debug) Category:Key descriptions by group, sorted as "dessert".

• (debug) Category:Key descriptions, sorted as "dessert".

• (debug) Category:Key descriptions with status "imaginary", sorted as "dessert".

{{KeyDescription
| key         = shop
| image       = File:Geograph shop.jpg
| image_caption = Geograph shop.
| 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
}}

shop
Geograph shop.
Описание
Место розничной торговли или оказания услуг.
Группа: Shops
Используется на элементах
Задокументировано значений: 221
Полезные сочетания
name=* opening_hours=*
Викиданные
Q213441
Статус: де-факто
Инструменты
taginfo · CH · CZ · FR · GB · HU · IE · IN · JP · PL overpass-turbo

• (debug) Category:RU:Key descriptions, sorted as "shop".

• (debug) Category:RU:Key descriptions with status "de facto", sorted as "shop".

{{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
}}

openplaques:id
Description
For plaques listed on OpenPlaques.org.
Group: Historic
Website
http://openplaques.org/
URL pattern
http://openplaques.org/plaques/[value]
Used on these elements
Requires
memorial=plaque
Implies
historic=memorial
Useful combination
name=*
Wikidata
Search Wikidata
Status: unspecified
Tools for this tag
taginfo · CH · CZ · FR · GB · HU · IE · IN · JP · PL overpass-turbo

• (debug) Category:Key descriptions for group "historic", sorted as "openplaques:id".

• (debug) Category:Key descriptions, sorted as "openplaques:id".

• (debug) Category:Key descriptions with no status specified, sorted as "openplaques:id".

See also

• {{Description}}
• {{ValueDescription}}
• {{RelationDescription}}