View source for Template:KeySuffixDescription/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->

== Parameters ==
* <code>suffix</code> &mdash; the suffix described by the template (without the *:)
: Example:
 <nowiki>{{KeySuffixDescription</nowiki>
 | suffix = ''[[Key:*:lanes|lanes]]''
 }}
* for other parameters see [[Template:KeyDescription]]

=== TemplateData ===
{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"suffix": {
			"description": "key suffix",
			"example": "lane",
            "required": true,
			"type": "string"
		},
		"image": {
			"description": "image of the feature suffix or namespace",
            "example": "File:...",
			"type": "wiki-file-name"
		},
		"description": {
			"description": "a short description of the suffix or namespace",
            "required": true,
			"type": "string"
		},
		"group": {
			"description": "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": "highways",
            "suggested": true,
			"type": "wiki-page-name"
		},
		"onNode": {
			"description": "If the feature can be used on a node.",
			"example": "yes, no",
            "suggested": true,
			"type": "string"
		},
		"onWay": {
			"description": "If the feature can be used on a way.",
			"example": "yes, no",
            "suggested": true,
			"type": "string"
		},
		"onArea": {
			"description": "If the feature can be used on an area.",
			"example": "yes, no",
            "suggested": true,
			"type": "string"
		},
		"onRelation": {
			"description": "If the feature can be used on a relation.",
			"example": "yes, no",
            "suggested": true,
			"type": "string"
		},
		"combination": {
			"description": "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}}"
		},
		"implies": {
			"description": "A list of tag(s) that the feature implies in its definition.",
			"example": "* {{Tag|key name|value}} * {{Tag|key name|value}}",
			"type": "string"
		},
		"requires": {
			"description": "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}}"
		},
		"seeAlso": {
			"description": "a list of similar tags",
			"example": "{{Tag|key name|value}}",
			"type": "string"
		},
		"status": {
			"description": "The [[approval status]] of this feature",
			"example": "approved, de facto, deprecated, discardable, in use, obsolete, proposed, undefined, voting",
            "suggested": true,
			"type": "string"
		},
		"statuslink": {
			"description": "The name of the proposal page, for linking.",
			"type": "string"
		},
		"lang": {
			"label": "language",
			"example": "es, de",
			"description": "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."
		},
		"class": {
			"description": "The CSS class of the HTML table used to form the description box. (Not used in most cases.)",
			"type": "string"
		},
		"float": {
			"description": "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",
			"type": "string"
		},
		"style": {
			"description": "The CSS style to be applied to the HTML table. (Not used in most cases.)",
			"type": "string"
		},
		"languagelinks": {
			"description": "If the langauge links should not appear. (Not used in most cases.)",
			"example": "no",
			"type": "string"
		}
	},
	"description": "This template provides a description box suitable for key prefixes (or namespace keys).",
	"format": "block",
	"paramOrder": [
		"suffix",
		"image",
		"description",
		"group",
		"onNode",
		"onWay",
		"onArea",
		"onRelation",
		"combination",
		"implies",
		"requires",
		"seeAlso",
		"status",
		"statuslink",
		"lang",
		"class",
		"float",
		"style",
		"languagelinks"
	]
}
</templatedata>

== Examples ==
<pre style="float:left;margin:2px 0;width:30em">
{{KeySuffixDescription
| suffix        = both_ways
| image         = 
| description   = The *:both_ways keys are used to specify properties for lanes or similar features running in both directions of a way. 
| group         = 
| onNode        = no
| onWay         = yes
| onArea        = no
| onRelation    = no
| status        = approved
| statuslink    = Proposed_features/Suffix_both_ways
}}</pre>
{{KeySuffixDescription
| suffix        = both_ways
| image         = 
| description   = The *:both_ways keys are used to specify properties for lanes or similar features running in both directions of a way. 
| group         = 
| onNode        = no
| onWay         = yes
| onArea        = no
| onRelation    = no
| status        = approved
| statuslink    = Proposed_features/Suffix_both_ways
| lang          = en
| float         = right
| languagelinks = no
| debug         = yes
}}{{clear|both}}

== See also ==
This template was introduced with [[Proposal:Documentation of key prefixes & suffixes]].
* {{T|Description}}
* {{T|KeyDescription}}
* {{T|ValueDescription}}
* {{T|RelationDescription}}
* {{T|KeyPrefixDescription}}

<includeonly>
<!-- CATEGORIES HERE, THANKS -->
[[Category:Features template]]
[[Category:Template with translation strings]]
</includeonly>