Template:KeyPrefixDescription/doc

From OpenStreetMap Wiki
Jump to navigation Jump to search

Parameters

  • prefix — the prefix described by the template (without the :*)
Example:
{{KeyPrefixDescription
| prefix = demolished
}}

TemplateData

This is the TemplateData for this template used by VisualEditor.
TemplateData for KeyPrefixDescription

This template provides a description box suitable for key prefixes (or namespace keys).

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
prefixprefix

key prefix

Example
addr
Stringrequired
imageimage

image of the feature prefix or namespace

Example
File:...
Fileoptional
descriptiondescription

a short description of the prefix or namespace

Stringrequired
groupgroup

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.

Example
addresses
Page namesuggested
onNodeonNode

If the feature can be used on a node.

Example
yes, no
Stringsuggested
onWayonWay

If the feature can be used on a way.

Example
yes, no
Stringsuggested
onAreaonArea

If the feature can be used on an area.

Example
yes, no
Stringsuggested
onRelationonRelation

If the feature can be used on a relation.

Example
yes, no
Stringsuggested
combinationcombination

A bulleted-list of example tag(s) that can be used in combination with this feature.

Example
* {{Tag|key name|value}} * {{Tag|key name|value}}
Unknownoptional
impliesimplies

A list of tag(s) that the feature implies in its definition.

Example
* {{Tag|key name|value}} * {{Tag|key name|value}}
Stringoptional
requiresrequires

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

Example
* {{Tag|key name|value}}
Unknownoptional
seeAlsoseeAlso

a list of similar tags

Example
{{Tag|key name|value}}
Stringoptional
statusstatus

The [[approval status]] of this feature

Example
approved, de facto, deprecated, discardable, in use, obsolete, proposed, undefined, voting
Stringsuggested
statuslinkstatuslink

The name of the proposal page, for linking.

Stringoptional
languagelang

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.

Example
es, de
Unknownoptional
classclass

The CSS class of the HTML table used to form the description box. (Not used in most cases.)

Stringoptional
floatfloat

The CSS float value of the table: set to none to disable the standard right float. (Not used in most cases.)

Example
left, right, none
Stringoptional
stylestyle

The CSS style to be applied to the HTML table. (Not used in most cases.)

Stringoptional
languagelinkslanguagelinks

If the langauge links should not appear. (Not used in most cases.)

Example
no
Stringoptional

Examples

{{KeyPrefixDescription
| prefix        = addr
| image         = File:Housenumber-karlsruhe-de.png
| description   = The addr:* keys describe addresses.
| group         = addresses
| onNode        = yes
| onWay         = yes
| onArea        = yes
| onRelation    = yes
| seeAlso       = 
* {{Prefix|contact}}
| status        = de facto
| statuslink    = Proposed features/House numbers/Karlsruhe Schema
}}
Public-images-osm logo.svg Prefix addr:*
Housenumber-karlsruhe-de.png
Description
The addr:* keys describe addresses. Edit this description in the wiki page. Edit this description in the data item.
Group: addresses
Used on these elements
may be used on nodesmay be used on waysmay be used on areas (and multipolygon relations)may be used on relations
See also
Status: de factoPage for proposal
taginfo: addr:*

information sign

This page describes a key prefix rather than a simple key.

Multipolygons, ways which are not areas and other traps

Main article: Template:Description/doc/confusion caused by use on onArea parameter

See also

This template was introduced with Proposal:Documentation of key prefixes & suffixes.