Template:ValueDescription

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

This template provides a description box suitable for key/value pairs.

Usage

Full parameter set in vertical format
Vertical list Prerequisites Brief instructions / notes
{{ValueDescription
| key           = 
| value         = 
| image         = 
| description   = 
| group         = 
| onNode        = 
| onWay         = 
| onArea        = 
| onRelation    = 
| combination   = 
| implies       = 
| seeAlso       = 
| status        = 
| statuslink    = 
| lang          = 
| class         = 
| float         = 
| style         = 
| languagelinks = 
}}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
status
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
  • value: the value 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. Please use names from Category:Features or from your namespaced (Category:DE:Features) or l10n version. Working example can be found in Tag:amenity=bbq and Category:Amenities. Namespaced category will be generated from Template:Feature. Just use template Template:Feature at your l10n page (for ex. DE:Busse) and it will create category Category:DE:Busse for you. Right now it works by creating namespaced categories, we need to further improve Template:Feature and add support for l10n names as parameter in Feature template.

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 (unclosed) 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

  • 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

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 shown, as their values are too specific to use them as examples.

{{ValueDescription
| 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
}}
Public-images-osm logo.svg dessert = cheesecake
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.
Used on these elements
may be used on nodes
should not be used on ways
use on areas unspecified
may be used on relations
Useful combination
Implies
See also
The dessert=gateau tag is sometimes confused with this one.
Status: Imaginary Help translate this into your language!
{{ValueDescription
| 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|name]]
*[[Key:oneway|oneway]]
| implies       = 
| seeAlso       = 
| status        = Approved
| lang          = 
}}
Public-images-osm logo.svg highway = residential
Residential.jpg
Description
Road in a residential area
Used on these elements
should not be used on nodes
may be used on ways
should not be used on areas
use on relations unspecified
Useful combination
Status: Approved
{{ValueDescription
| 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
| class         = 
| float         = left
| style         = 
| languagelinks = no
}}
Public-images-osm logo.svg power = generator
Kraftwerk Staudinger von Limes-B.jpg
Beschreibung
Kraftwerk - dient der Erzeugung von Strom oder Wärme
für diese Elemente
Kann Punkten zugeordnet werden
Kann Linien zugeordnet werden
Kann Flächen zugeordnet werden
use on relations unspecified 
Sinnvolle Kombinationen
Status: Unbestimmt

See also