Template:Description

Status: undefined

Template documentation

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

Usage

Usually, this template is not used directly on tag pages, but one of the specific templates for keys, values, prefixes, suffixes or relations:

{{KeyDescription}} {{ValueDescription}} {{KeyPrefixDescription}} {{KeySuffixDescription}} {{RelationDescription}}

Those specific templates use Module:DescriptionFromDataItem to compare the parameters between the wiki page and the corresponding data item. That module in turn uses this template here to display the box and do the styling.

Parameters

Full parameter set in vertical format

Vertical list	Prerequisites	Brief instructions / notes
{{Description | type = | key = | prefix = | suffix = | value = | image = | description = | osmcarto-rendering = | osmcarto-rendering-size = | osmcarto-rendering-node = | osmcarto-rendering-node-size = | osmcarto-rendering-way = | osmcarto-rendering-way-size = | osmcarto-rendering-area = | osmcarto-rendering-area-size = | group = | onNode = | onWay = | onArea = | onRelation = | requires = | implies = | combination = | seeAlso = | status = | statuslink = | website = | url_pattern = | lang = | class = | float = | style = | languagelinks = | templatename = }}	type=key-prefix type=key-suffix type=value       osmcarto-rendering                                 status	key / key-prefix / key-suffix / value   instead of |key= instead of |key= ignored if |type=key File:Name of the file.png   File:X.png for an image; page or #anchor link to a detailed desc. e.g. 28px for an icon; text to display for just a link see above, but optional and explicit for nodes see above, but optional and explicit for node-size see above, but optional and explicit for ways see above, but optional and explicit for way-size see above, but optional and explicit for areas see above, but optional and explicit for areas-size                           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 in detail

The following parameters are recognised:

Description type

• type: set to key to describe a single key; set to value to describe a key/value pair; set to key-prefix to describe a prefix key or namespace; set to key-suffix to describe a suffix key

Feature description

• key: the key being described
• prefix: if type=key-prefix, the prefix key or namespace being described, use instead of "key"
• suffix: if type=key-suffix, the suffix key being described, use instead of "key"
• value: if type=value, the value being described, otherwise ignored, use in combination with "key"
• 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 the current rendering in the OpenStreetMap Carto map style; 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. "28px" for an icon); or alternatively a short text displayed for the link to a detailed description
• osmcarto-rendering-node: an optional image (e.g. "File:Name.png") showing the current rendering in the OpenStreetMap Carto map style for a node object; alternatively a page name/anchor to link to more detailed
• osmcarto-rendering-node-size: if osmcarto-rendering-node is set, a size for an image (e.g. "28px" for an icon); or alternatively a short text displayed for the link to a detailed description
• osmcarto-rendering-way: an optional image (e.g. "File:Name.png") showing the current rendering in the OpenStreetMap Carto map style for a linear way object; alternatively a page name/anchor to link to more detailed
• osmcarto-rendering-way-size: if osmcarto-rendering-way is set, a size for an image (e.g. "100px" for an area(way)); or alternatively a short text displayed for the link to a detailed description
• osmcarto-rendering-area: an optional image (e.g. "File:Name.png") showing the current rendering in the OpenStreetMap Carto map style for a area object; alternatively a page name/anchor to link to more detailed description
• osmcarto-rendering-area-size: if osmcarto-rendering-area is set, a size for an image (e.g. "100px" for an area); 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 a key or tag based on de facto use by mappers and software, and presence in the database:

  • in use: the key or tag is in use
  • de facto: the tag is in widespread use, but no formal proposal process has taken place
  • deprecated: deprecated tags that are discouraged from being used
  • obsolete: a key or tag which is no longer found in the database
  • discardable: tags that are so useless that editors remove them automatically, for example Tag:odbl=clean which will be discarded by major editors
  • unspecified or undefined or unknown or (empty): unclear situation, a potentially abandoned draft of a proposal and some usage only
  • imported: the key or tag was added from an external database

  The approval status of this key or tag (based on Proposal process results):

  • approved: the key or tag has successfully competed the approval process
  • proposed: the key or tag has been formally proposed
  • voting: the key or tag is currently being voted on as part of 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

Examples and previews can be found on the specific template documentations:

• See Template:KeyDescription/doc for keys.

• See Template:ValueDescription/doc for tags or values.

• See Template:KeyPrefixDescription/doc for key prefixes.

• See Template:KeySuffixDescription/doc for key suffixes.

See also

• {{KeyDescription}}
• {{ValueDescription}}
• {{RelationDescription}}
• {{KeyPrefixDescription}}
• {{KeySuffixDescription}}
• {{DescriptionLang}} to translate this template