Template:RelationDescription

Template documentation[View] [edit] [history] [Purge]

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

Usage

Copiable example with only required and suggested parameters

{{RelationDescription
| type          = 
| image         = 
| description   = 
| group         = 
| members       = 
| combination   = 
| implies       = 
| seeAlso       = 
| status        = 
| statuslink    = 
}}

Full parameter set in vertical format

Vertical list	Prerequisites	Brief instructions / notes
{{RelationDescription | type = | image = | description = | group = | members = | combination = | implies = | seeAlso = | status = | statuslink = | class = | float = | style = | languagelinks = }}	image             status	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:

Language support

• [redundant parameter] 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. If this parameter is not specified or empty, the default language to use will be determined from the current page by {{Langcode}}

Feature description

• type: the relation type 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
• members: the element types and roles of members of the relation

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:
  • approved: the feature has successfully competed the approval process
  • de facto or defacto: the tag is in widespread use, but no formal proposal process has taken place
  • deprecated: deprecated tags that will not be used anymore
  • discardable: a few features not carrying any meaning anymore like Tag:odbl=clean
  • in use or inuse: the feature is in use
  • obsolete: a feature which is no longer found in the database
  • proposed: the feature has been formally proposed
  • unspecified or undefined or unknown or  (empty): unclear situation, a potentially abandoned draft of a proposal and some usage only
  • voting: the feature is currently being voted on as part of the approval process
• statuslink: name of the proposal page, for linking

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 (this is only used within this documentation page for showing the examples below)

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.

{{RelationDescription
| type          = multipolygon
| image         = File:Multipolygon Illustration 6.svg
| description   = The multipolygon relation is used to represent complex areas.
| group         = Properties
| status        = approved
| members       =
* {{IconWay}} – outer
* {{IconWay}} – inner
| seeAlso       = [[Relation:boundary]]
}}

• (debug) Category:Relation descriptions, sorted as "multipolygon".

• (debug) Category:Relation descriptions with status "approved", sorted as "multipolygon".

• (debug) Category:Statuslink not set for approved tag

Multipolygons, ways which are not areas and other traps

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

See also

• {{Description}}
• {{KeyDescription}}
• {{ValueDescription}}

The above documentation is transcluded from Template:RelationDescription/doc. (edit | history)
Editors can experiment in this template's sandbox (Create | mirror) and testcases (Create) pages.
Add categories to the /doc subpage. Subpages of this template.