Template:Description
From OpenStreetMap Wiki
![]() |
Status: unspecified |
This documentation is transcluded from Template:Description/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 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] |
This template provides a description box suitable for keys, key/value pairs and potentially other features.
Contents
Usage
Vertical list | Prerequisites | Brief instructions / notes |
---|---|---|
{{Description | type = | key = | value = | image = | description = | osmcarto-rendering = | osmcarto-rendering-size = | group = | onNode = | onWay = | onArea = | onRelation = | requires = | implies = | combination = | seeAlso = | status = | statuslink = | website = | url_pattern = | wikidata = | lang = | class = | float = | style = | languagelinks = | templatename = }} |
osmcarto-rendering status |
'key' or 'value' ignored if |type=key File:Name.png for an image/icon; page or #anchor link to a detailed description e.g. 14px for an icon ; text to display for just a link Qnnnn en, de, fr, ja, etc. set |float=none to inhibit floating |
- 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:
Description type
- type: set to
key
to describe a single key; set tovalue
to describe a key/value pair
Feature description
- key: the key being described
- value: if
type=value
, the value being described, otherwise ignored - image: the name of an image to be used to illustrate the feature
- description: a short description of the feature in question
- osmcarto-rendering: an optional image (e.g. "File:Name.png") showing a suggested rendering on a map; alternatively a page name/anchor to link to more detailed description
- osmcarto-rendering-size: if
osmcarto-rendering
is set, a size for an image (e.g. "14px" for an icon); or alternatively a short text displayed for the link to a detailed description - group: the name of the broader group to which this feature belongs
Feature usage
- 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 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,no
otherwise
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;
- implies: a list of tags/values which are assumed when absent; see below for examples; tag them explicitly for exceptions
- combination: a list of additional tags which are useful in combination with this one; see below for examples
- seeAlso: references to additional pages which may be of interest
- status:
- status of feature based on de facto presence in db, users and software:
-
inuse
: the feature is in use -
defacto
: the tag is in widespread use, but no formal proposal process has taken place -
obsolete
: feature (without proposal) obsolete by newer feature proposal -
discardable
: feature will be discarded by major editors
- the approval status of this feature (based on Proposal process results):
-
draft
: the feature has a draft proposal being written -
proposed
: the feature has been formally proposed -
abandoned
: the approval process for this feature has been terminated before completion -
voting
: the feature is currently being voted on as part of the approval process -
approved
: the feature has successfully competed the approval process -
rejected
: the feature was rejected during the approval process
- statuslink: name of the proposal page, for linking
- website: the main website(s) associated with this feature
- url_pattern: pattern to generate deep-link URLs for instances of this feature
Language support
- 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
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 - templatename: name of the page which the navlinks should act on
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.
{{Description | type = value | key = dessert | value = cheesecake | image = File:Cheesecake image.jpg | description = Cheesecake is a type of cake with two layers: a soft, deep top layer, typically made with some sort of cheese, and a firm, often biscuit-based bottom layer. | onNode = yes | onWay = no | onArea = | onRelation = yes | combination = * {{tag|meal|dinner}} * {{tag|flavour|lemon}} * {{tag|origin|New York}} | implies = * {{tag|edible|yes}} * {{tag|sweet|yes}} | seeAlso = The {{tag|dessert|gateau}} tag is sometimes confused with this one. | status = imaginary | lang = en | wikidata = Q215348 }}
![]() |
![]() |
Description |
---|
Cheesecake is a type of cake with two layers: a soft, deep top layer, typically made with some sort of cheese, and a firm, often biscuit-based bottom layer. |
Used on these elements |
Implies |
Useful combination |
See also |
Wikidata |
Q215348 |
Status: imaginary |
|
Tools for this tag |
|
- (debug) Category:Tag descriptions by group, sorted as "dessert cheesecake".
- (debug) Category:Tag descriptions by key, sorted as "dessert cheesecake".
- (debug) Category:Tag descriptions, sorted as "dessert cheesecake".
- (debug) Category:Tag descriptions by value, sorted as "cheesecake dessert".
- (debug) Category:Tag descriptions with status "imaginary", sorted as "dessert cheesecake".
{{Description | type = key | key = dessert | image = | description = A dessert is a sweet dish, typically served towards the end of a meal. | onNode = yes | onWay = no | onArea = | onRelation = yes | combination = * {{tag|meal|dinner}} * {{tag|sweet|yes}} | implies = * {{tag|edible|yes}} | seeAlso = * {{tag|dessert|cheesecake}} * {{tag|dessert|gateau}} | status = imaginary | lang = en }}
![]() |
![]() |
Description |
---|
A dessert is a sweet dish, typically served towards the end of a meal. |
Used on these elements |
Implies |
Useful combination |
See also |
Wikidata |
Search Wikidata |
Status: imaginary |
|
Tools for this tag |
|
- (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".
{{Description | type = value | key = highway | value = residential | image = Image:Residential.jpg | description = Road in a residential area | onNode = no | onWay = yes | onArea = no | onRelation = | combination = * {{Key|name}} * {{Key|oneway}} | implies = | seeAlso = | status = approved | lang = }}
![]() |
![]() |
Description |
---|
Road in a residential area |
Used on these elements |
Useful combination |
Wikidata |
Search Wikidata |
Status: approved |
|
Tools for this tag |
|
- (debug) Category:Tag descriptions by group, sorted as "highway residential".
- (debug) Category:Tag descriptions for key "highway", sorted as "highway residential".
- (debug) Category:Tag descriptions, sorted as "highway residential".
- (debug) Category:Tag descriptions by value, sorted as "residential highway".
- (debug) Category:Tag descriptions with status "approved", sorted as "highway residential".
{{Description | type = value | key = power | value = generator | image = File:Kraftwerk Staudinger von Limes-B.jpg | description = Kraftwerk - dient der Erzeugung von Strom oder Wärme | onNode = yes | onWay = yes | onArea = yes | onRelation = | combination = * {{Key|generator:source|kl=DE}} * {{Key|generator:method|kl=DE}} * {{Key|generator:output|kl=DE}} * {{Tag|name|kl=DE}} * {{Tag|operator|kl=DE}} | implies = | seeAlso = | status = | lang = de }}
![]() |
![]() |
Beschreibung |
---|
Kraftwerk - dient der Erzeugung von Strom oder Wärme |
Für diese Elemente |
Sinnvolle Kombinationen |
Wikidata |
Durchsuche Wikidata |
Status: unbestimmt |
|
Werkzeuge für diesen Tag |
- (debug) Category:DE:Beschreibungen der Attribute nach Gruppe, sorted as "power generator".
- (debug) Category:DE:Beschreibungen der Attribute nach Schlüssel, sorted as "power generator".
- (debug) Category:DE:Beschreibungen der Attribute, sorted as "power generator".
- (debug) Category:DE:Beschreibungen der Attribute nach Wert, sorted as "generator power".
- (debug) Category:DE:Tag descriptions with no status specified, sorted as "power generator".
{{Description | type = key | key = shop | image = File:Geograph shop.jpg | description = Место розничной торговли или оказания услуг. | onNode = yes | onWay = no | onArea = yes | onRelation = | combination = * {{Template:RU:Tag|name}} * {{Template:RU:Tag|opening_hours}} | implies = | seeAlso = | status = | lang = ru }}
![]() |
![]() |
Описание |
---|
Место розничной торговли или оказания услуг. |
Используется на элементах |
Задокументировано значений: 221 |
Полезные сочетания |
|
Викиданные |
Поиск Викиданных |
Статус: неизвестен |
|
Инструменты |
- (debug) Category:RU:Key descriptions, sorted as "shop".
- (debug) Category:RU:Key descriptions with no status specified, sorted as "shop".
{{Description | type = value | key = highway | value = tertiary | image = Image:OHZ-K3-Werschenrege.jpg | description = A road linking small settlements, or the local centres of a large town or city. | onNode = no | onWay = yes | onArea = no | onRelation = | combination = * {{Key|lanes}} * {{Key|oneway}} * {{Key|name}} * {{Key|ref}} | implies = * {{Tag|access||yes}} | seeAlso = | status = approved | statuslink = Proposed features/highway=tertiary | lang = en }}
![]() |
![]() |
Description |
---|
A road linking small settlements, or the local centres of a large town or city. |
Used on these elements |
Implies |
|
Useful combination |
Wikidata |
Search Wikidata |
Status: approved![]() |
|
Tools for this tag |
|
- (debug) Category:Tag descriptions by group, sorted as "highway tertiary".
- (debug) Category:Tag descriptions for key "highway", sorted as "highway tertiary".
- (debug) Category:Tag descriptions, sorted as "highway tertiary".
- (debug) Category:Tag descriptions by value, sorted as "tertiary highway".
- (debug) Category:Tag descriptions with status "approved", sorted as "highway tertiary".
See also
- {{KeyDescription}}
- {{ValueDescription}}
- {{RelationDescription}}
- {{DescriptionLang}} to translate this template