Template:PossibleSynonym2/doc
This is a documentation subpage for Template:PossibleSynonym2. It contains usage information, categories and other content or metadata that is not part of the original template. |
{{PossibleSynonym}} and {{PossibleSynonym2}} are both used to list common tagging mistakes. The latter is more compact, only showing the total count of elements with the tag.
Usage
Don't use this for rare tagging mistakes. In those cases, it makes more sense to correct them yourself or add Notes.
You can use this template simply by adding to the page one of the following syntaxes:
{{PossibleSynonym2|key}}
{{PossibleSynonym2|key|value}}
{{PossibleSynonym2|key|value|observation}}
{{PossibleSynonym2|key|value|observation|tagLink=no}}
{{PossibleSynonym2|key|value|observation|footer=no}}
{{PossibleSynonym2|key|value|observation|tagLink=no|footer=no}}
{{PossibleSynonym2|kl= lang |key|vl= lang |value}}
{{PossibleSynonym2|kl= lang |key|vl= lang |value|observation}}
You can optionally append a short observation in the first rendered line by adding the third parameter.
The optional parameters |kl = lang and |vl = lang may be used to specify explicitly the language code of the target pages for links in the rendered tags. Without them, this template will attempt to locate a translation in the same language as the current page (as determined by {{Langcode}}), or will link to the default page (usually in English) if there's still no translation available. This may be needed if there are too many costly parser calls (caused by tests of existences of translated pages), when you know that the target translated page exists (look at the links in rendered page to see if they point to the English page or a translation: if a language code prefix is present in the link, you may safely specify these parameters).
Examples
- {{PossibleSynonym2|contents}} to indicate the key contents=* is a possible synonym of the current page:
{{PossibleSynonym2|contents||Consider to use {{Key|content}} instead. [[File:Taginfo-icon-1.svg|12px|text-bottom|link=//taginfo.openstreetmap.org/compare/contents/content]] [https://taghistory.raifer.tech/#***/contents&***/content {{#invoke:char|char|0x1F4C8}}]|tagLink=yes}}
to indicate the tag contents=* is a possible synonym of the current page with the short observation:
- {{PossibleSynonym2|shop|car_wash}} to indicate the tag shop=car_wash is a possible synonym of the current page:
{{PossibleSynonym2|shop|car_wash|Consider to use {{Tag|amenity|car_wash}} instead. [[File:Taginfo-icon-1.svg|12px|text-bottom|link=//taginfo.openstreetmap.org/compare/shop=car_wash/amenity=car_wash]] [https://taghistory.raifer.tech/#***/shop/car_wash&***/amenity/car_wash {{#invoke:char|char|0x1F4C8}}]|tagLink=yes}}
to indicate the tag shop=car_wash is a possible synonym of the current page with the short observation:
{{PossibleSynonym2|shop|car_wash|This tag may also be this other tag.|footer=no}}
to indicate the tag shop=car_wash is a possible synonym of the current page with the short observation:
{{PossibleSynonym2|shop|car_wash|This tag may also be this other tag.|tagLink=yes}}
to indicate the tag shop=car_wash is a possible synonym of the current page with the short observation:
{{PossibleSynonym2|shop|car_wash|This tag may also be this other tag.|tagLink=no}}
to indicate the tag shop=car_wash is a possible synonym of the current page with the short observation:
{{PossibleSynonym2|shop|car_wash|This tag may also be this other tag.|tagLink=no|footer=no}}
to indicate the tag shop=car_wash is a possible synonym of the current page with the short observation:
Autocategorisation
This template categorizes automatically the pages using this template in Category:Tagging Mistakes (or one of its existing translated categories).
See also
For translating this template, see Template:PossibleSynonymLang
Template displays warning about possible synonym of this tag.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Key | 1 | Key (or key part of full tag) of possible synonym of the current page. | Line | required |
Value | 2 | Value of tag of possible synonym of the current page. | Line | optional |
Description | 3 | Short description. | Line | optional |
TagInfo link | tagLink | Hides link to TagInfo at bottom of template.
| Boolean | optional |
Footer | footer | Hides footer of a template.
| Boolean | optional |
Language | lang | Language code of preferred template rendering.
| String | optional |
Key page language | kl | Language code of preferred key page link.
| String | optional |
Value page language | vl | Language code of preferred value page link.
| String | optional |
Disable categorization | nocat | Assigning any value disables the template's category linking behavior
| Boolean | optional |