Template:KeyDescription

From OpenStreetMap Wiki
Jump to: navigation, search
[edit] [purge] Template-info.svg Template documentation
Available languages

This template provides a description box suitable for keys.

Usage

Full parameter set in vertical format
Vertical list Prerequisites Brief instructions / notes
{{KeyDescription
| key           = 
| image         = 
| description   = 
| group         = 
| onNode        = 
| onWay         = 
| onArea        = 
| onRelation    = 
| combination   = 
| implies       = 
| seeAlso       = 
| status        = 
| statuslink    = 
| website       = 
| url_pattern   = 
| wikidata      = 
| lang          = 
| class         = 
| float         = 
| style         = 
| languagelinks = 
}}
 
 
 
 
 
 
 
 
 
 
 
 
 
status
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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:

Feature description

  • key: the key being described
  • image: the name of an image to be used to illustrate the feature
  • description: a short description of the feature in question
  • 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 relation elements, no otherwise

Additional information

  • combination: a list of additional tags which are useful in combination with this one; see below for examples
  • implies: a list of tags which are implied by this tag; see below for examples
  • seeAlso: references to additional pages which may be of interest
  • status: the approval status of this feature; 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. Example.
  • 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

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.
| 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
}}
{{KeyDescription
| key           = shop
| image         = File:Geograph shop.jpg
| description   = Место розничной торговли или \
оказания услуг.
| group         = shop
| onNode        = yes
| onWay         = no
| onArea        = yes
| onRelation    = 
| combination   = * {{Template:RU:Tag|name}}
* {{Template:RU:Tag|opening_hours}}
| implies       = 
| seeAlso       = 
| status        = 
| lang          = ru
}}

See 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
| lang        = en
}}

See also