![]() |
VOOZH | about |
| 👁 Image | This is the template sandbox page for Template:KeyDescription (diff). See also the companion subpage for test cases. |
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 Data 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.
{{KeyDescription
| key =
| image =
| description =
| group =
| onNode =
| onWay =
| onArea =
| onRelation =
| requires =
| implies =
| combination =
| seeAlso =
| status =
| statuslink =
}}
| 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.
The following parameters are recognised:
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.
yes if the feature being described is suitable for use on node elements, no otherwise.yes if the feature being described is suitable for use on linear (non-area) way elements, no otherwise.yes if the feature being described is suitable for use on area elements, no otherwise.yes if the feature being described is suitable for use on (non-multipolygon) relation elements.approved: the key or tag has successfully completed the approval processde facto: the tag is in widespread use, and while it was not approved in a proposal process, it has a widespread acceptance among mappers (2)deprecated: deprecated tags that are discouraged from being useddiscardable: tags that are so useless that editors remove them automatically, for example Tag:odbl=cleanimported is used for a tag which was added from an external database, see also Import detailsin use: the key or tag is in use (2)obsolete: a key or tag which is no longer found in the databaseproposed: the key or tag has been proposed to be used (but not yet approved) and usage of this tagging is minimal (1)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 key or tag is currently being voted on as part of the approval processNotes:
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, a heavily used tag with rejected proposal can have de facto status.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.
none to disable the standard right float.|float= if present.no to inhibit links to corresponding pages in other languages (used for example on this documentation page).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
}}
| 👁 Image dessert |
| Description |
|---|
| A dessert is a sweet dish, typically served towards the end of a meal. |
| Group: cuisine |
| Used on these elements |
| Implies |
|
| Useful combination |
| See also |
| Status: imaginary |
| Tools for this tag |
{{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
}}
| 👁 Image shop |
| Описание |
|---|
| Место розничной торговли или оказания услуг. Error creating thumbnail: |
| Группа: магазины |
| Используется на элементах |
| Полезные сочетания |
|
| Статус: де-факто👁 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 = undefined
| lang = en
}}
| 👁 Image openplaques:id |
| Description |
|---|
| For plaques listed on OpenPlaques.org. Error creating thumbnail: |
| Group: historic |
| Website |
| http://openplaques.org/ |
| URL pattern |
| http://openplaques.org/plaques/[value] |
| Used on these elements |
| Requires |
| Implies |
| Useful combination |
|
| Status: undefined |
| Tools for this tag |
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| key | key | key of the feature
| String | required |
| image | image | image of the feature
| File | suggested |
| description | description | a short description of the feature | String | required |
| 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.
| Page name | suggested |
| onNode | onNode | If the feature can be used on a node.
| String | suggested |
| onWay | onWay | If the feature can be used on a way.
| String | suggested |
| onArea | onArea | If the feature can be used on a way.
| String | suggested |
| onRelation | onRelation | If the feature can be used on a relation.
| Boolean | suggested |
| 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
| Content | suggested |
| implies | implies | A list of tag(s) that the feature implies in its definition.
| Content | suggested |
| combination | combination | A bulleted-list of example tag(s) that can be used in combination with this feature.
| Unknown | suggested |
| seeAlso | seeAlso | a list of similar tags
| String | suggested |
| status | status | The [[approval status]] of this feature
| Line | suggested |
| statuslink | statuslink | The name of the proposal page, for linking. | Page name | 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.
| 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
| String | optional |
| style | style | the CSS style to be applied to the HTML table | 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
| 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
| 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
| 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
| String | suggested |
| url_pattern (URI) | url_pattern | URI (URL / URN) of the web resource; URL pattern; URI template from which $1 can be automatically replaced with the effective property value on items.
| URL | optional |
| languagelinks | languagelinks | If the langauge links should appear
| Line | optional |