Template:KeyDescription

Template documentation

This documentation is transcluded from Template:KeyDescription/doc. (Edit | history)
Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.
This template has a sandbox (Edit) and testcases (Edit) for editors to experiment.

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 = | status = | statuslink = }}	rendered icon     website                   status	The key name in native language     May not work if osmcarto-rendering-size is not set Usually 14

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. For better code readability, it is recommended to copy the page title from the file page instead of from URL:

  File:OpenStreetMap logo 2011 - social circle.svg (the same as the file page title)

  File:OpenStreetMap_logo_2011_-_social_circle.svg (use spaces instead of underscores)

  Image:OpenStreetMap_logo_2011_-_social_circle.svg (use File: instead of Image:)

• description: a short description of the feature in question. Description is preferable to a single word, as it reduces chances for miscommunication - author of a definition is unable to assess whatever one specific word is ambiguous to all readers. Should start with a capital letter and end with a period. Must not contain any wiki markup or HTML. Must be less than 250 symbols. (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). Use lower case.
• 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:

content template

• 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 ⁽¹⁾
• imported is used for a tag which was added from an external database
• 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 ⁽¹⁾
• undefined or  (empty): unclear situation (this may be actually useful in case where data item has invalid value and it is not entirely clear which one should be used and someone is not interested in editing data items)
• voting: the feature is currently being voted on as part of the approval process

Notes:

1. 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.
2. 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.
3. 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

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}}
| 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
Status: imaginary
dessert=* More details at taginfo More details at taginfo
Tools for this tag
taginfo · AD · AT · BR · BY · CH · CN · CZ · DE · DK · FI · FR · GB · GR · HU · IN · IR · IT · LI · LU · JP · KP · KR · NL · PL · PT · RU · ES · AR · MX · CO · TW · UA · US · VN overpass-turbo OSM Tag History

• (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
| description = Место розничной торговли или оказания услуг.
| group       = 
| onNode      = yes
| onWay       = no
| onArea      = yes
| onRelation  = no
| requires    =
| implies     = 
| combination =
* {{Tag|name}}
* {{Tag|opening_hours}}
| seeAlso     = 
| status      = de facto
| lang        = ru
}}

• (debug) Category:RU:Описания ключей по группе, sorted as "shop".

• (debug) Category:RU:Описания ключей, sorted as "shop".

• (debug) Category:RU:Описание ключей со статусом "де-факто", 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      = undefined
| 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=*
Status: undefined
openplaques:id=* More details at taginfo More details at taginfo
Tools for this tag
taginfo · AD · AT · BR · BY · CH · CN · CZ · DE · DK · FI · FR · GB · GR · HU · IN · IR · IT · LI · LU · JP · KP · KR · NL · PL · PT · RU · ES · AR · MX · CO · TW · UA · US · VN overpass-turbo OSM Tag History

• (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".

TemplateData

This template provides a description box suitable for keys.

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
key	key	key of the feature Example highway	String	required
image	image	image of the feature Example File:...	File	suggested
description	description	a short description of the feature	String	required
onNode	onNode	If the feature can be used on a node. Example yes, no	String	suggested
onWay	onWay	If the feature can be used on a way. Example yes, no	String	suggested
onArea	onArea	If the feature can be used on a way. Example yes, no	String	suggested
onRelation	onRelation	If the feature can be used on a relation. Example yes, no	String	suggested
combination	combination	A bulleted-list of example tag(s) that can be used in combination with this feature. Example * {{Key|surface}} * {{Key|lit}}	Unknown	optional
implies	implies	A list of tag(s) that the feature implies in its defention. Example * {{Key|paved}} * {{Key|vehicle}}	String	optional
group	group	The name of the broader group to which this feature belongs. Please use lower-case names from Category:Features or from your namespaced (Category:DE:Features) or l10n version. Example amenities	Page name	suggested
seeAlso	seeAlso	a list of similar tags Example {{Key|cycleway}}	String	optional
status	status	The [[approval status]] of this feature Example abandoned, approved, de facto, deprecated, discardable, draft, in use, obsolete, proposed, rejected, undefined, voting	String	suggested
language	lang	the ISO 639-2 code 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 not set, language of page or namespace will be used. Example es, de	Unknown	optional
class	class	the CSS class of the HTML table used to form the description box	String	optional
float	float	the CSS float value of the table: set to none to disable the standard right float Example left, right, none	String	optional
style	style	the CSS style to be applied to the HTML table	String	optional
statuslink	statuslink	The name of the proposal page, for linking.	String	optional
osmcarto-rendering	osmcarto-rendering	an image showing a suggested rendering on a map; alternatively a page name/anchor to link to more detailed description	File	optional
osmcarto-rendering-size	osmcarto-rendering-size	The size of the image set in osmcarto-rendering Example 28px	String	optional
osmcarto-rendering-node	osmcarto-rendering-node	an image showing a suggested rendering on a map for a node object; alternatively a page name/anchor to link to more detailed	File	optional
osmcarto-rendering-node-size	osmcarto-rendering-node-size	The size of the image set in osmcarto-rendering-node Example 28px	String	optional
osmcarto-rendering-way	osmcarto-rendering-way	an image showing a suggested rendering on a map for a node object; alternatively a page name/anchor to link to more detailed	File	optional
osmcarto-rendering-way-size	osmcarto-rendering-way-size	The size of the image set in osmcarto-rendering-way Example 28px	String	optional
osmcarto-rendering-area	osmcarto-rendering-area	an image showing a suggested rendering on a map for a node object; alternatively a page name/anchor to link to more detailed	File	optional
osmcarto-rendering-area-size	osmcarto-rendering-area-size	The size of the image set in osmcarto-rendering-area Example 28px	String	optional
requires	requires	A list of tag(s) which are necessary (often higher/lower in hierarchy) for this tag and must be set to give its actual meaning Example * {{Tag|key name|value}}	Unknown	optional
languagelinks	languagelinks	If the langauge links should appear Example no	String	optional

See also

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