Changes between Version 87 and Version 186 of TaggingPresets


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified
  • TaggingPresets

    v87 v186  
    1 [[TranslatedPages(outdated=The preset syntax has changed and the copy from XML files needs to be joined with normal description. Also the example should be changed because it uses key-value pairs which are uncommon in OSM and highways are usually NOT oneway.)]]
     1[[TranslatedPages]]
    22[[PageOutline(2-10,Table of Contents)]]
     3
     4''If you want to learn installation steps for presets, see [[JOSMImage(dialogs/propertiesdialog)]] [wikitr:/Help/Preferences/TaggingPresetPreference Tagging Presets] register in [[JOSMImage(preference)]] [wikitr:/Help/Action/Preferences Preferences]'' \\
     5''If you want to use presets or need complete reference of presets see [wikitr:/Presets Presets]''
     6
     7----
     8
    39= Tagging Presets =
    4 JOSM supports distributed tagging presets. This is a XML config file that describes a GUI for entering tags (or properties, annotations, sometimes called map features). The XML files can be placed anywhere in the web or at the users local file system. Presets can be added by the users at a central page [wiki:Presets].
    5 
    6 
    7 == Installing presets ==
    8 Either:
    9 * Click on main menu [Help/Menu/Presets Presets] and click on "Preset Preferences".
    10 * Open the [Help/Action/Preferences preferences window], click [[Image(source:trunk/images/preferences/map.png,20)]] map settings and select third tab [Help/Preferences/Map#TaggingPresets "Tagging Presets"].
     10JOSM supports distributed tagging presets. This is a XML config file that describes a GUI for entering tags (or properties, annotations, sometimes called map features).
     11
     12The presets can be placed anywhere in the web or at the users local file system. JOSM can be configured to use custom local or remote Presets.
    1113
    1214== Develop a new preset ==
    1315The tagging preset description is in a very simple XML format. Details see [#XML below].
    1416
    15 See the **[source:trunk/data/defaultpresets.xml defaultpresets.xml]** for an example covering most of the possibilities listed below.
    16 
    17 The full XSD schema is available at the namespace URI (http://josm.openstreetmap.de/tagging-preset-1.0) as well as [source:trunk/data/tagging-preset.xsd the source repository].
    18 
    19 To add the preset to the list of available presets see [[Presets#Createnewpresets]].
     17See the **[source:/trunk/resources/data/defaultpresets.xml defaultpresets.xml]** for an example covering most of the possibilities listed below.
    2018
    2119Example:
    22 [[Image(tagging_screenshot.png,align=right)]]
     20
     21[[Image(Change 1 object.png,right,link=,margin-left=15)]]
    2322
    2423{{{
    25 #!xml
     24#!preset
     25<?xml version="1.0" encoding="UTF-8"?>
    2626<presets xmlns="http://josm.openstreetmap.de/tagging-preset-1.0">
    27   <item name="Highway">
    28     <label text="Inserting a highway in UK" />
    29 
    30     <text key="name" text="Highway (e.g. M3)" />
    31     <combo key="highway" text="Type" values="major,minor" />
    32 
    33     <!-- Highways are usually oneway -->
     27  <item name="Oneway highway" type="way">
     28    <label text="Inserting a unidirectional highway" />
     29
     30    <combo key="highway" text="Type" values="trunk,motorway" />
     31    <text key="name" text="Name (e.g. Angel Road)" />
     32    <text key="ref" text="Ref (e.g. A406)" />
     33
     34    <!-- This is a oneway preset, so make oneway default -->
    3435    <check key="oneway" text="Oneway" default="on" />
    3536
    36     <!-- Always setting class=highway -->
    37     <key key="class" value="highway" />
     37    <!-- Always setting asphalt surface -->
     38    <key key="surface" value="asphalt" />
    3839  </item>
    3940</presets>
    4041}}}
    41 
    42 
    43 == XML Format description (outdated!) ==#XML
     42\\
     43
     44== XML Format description ==#XML
     45The full XSD schema is available at the namespace URI (https://josm.openstreetmap.de/tagging-preset-1.0) as well as [source:/trunk/resources/data/tagging-preset.xsd the source repository].
     46
    4447=== Tags ===
    45 ==== The document prolog ====
    46  '''<presets>'''::
    47    Has to be the main tag of the file. Supports following attributes
    48    * '''xmlns="http://josm.openstreetmap.de/tagging-preset-1.0"'''
    49    * '''author''' - the name of the author of the preset
    50    * '''version''' - the version number of the file. For automatical version adjustment of presets managed in this wiki you can use two internal variables: `[[revision]]` (the latest version number of the wiki page) and `[[date]]` (the date of the last edit).
    51    * '''description''' (i18n) - description what the file contains
    52    * '''shortdescription''' (i18n) - very short overview description i.e. the "name" of the preset
    53    * '''link''' (i18n) - web link to further details (optional)
    54    * '''icon''' - informational icon for the whole preset. (This is nedded to display the icon in the table at [[Presets]].)
    55 (i18n) means the values may also be localized (e.g. de.link).
     48==== The document prologue ====
     49 <presets>::
     50  Has to be the main tag of the file. Supports following attributes
     51  * '''xmlns="http://josm.openstreetmap.de/tagging-preset-1.0"'''
     52  * '''author''' - the name of the author of the preset
     53  * '''version''' - the version number of the file. For automatic version adjustment of presets managed in this wiki you have to use two internal variables: `[[revision]]` (the latest version number of the wiki page) and `[[date]]` (the date of the last edit), e.g. `version="1.[[revision]]_[[date]]"`.
     54  * '''description''' (i18n) - description what the file contains
     55  * '''shortdescription''' (i18n) - very short overview description i.e. the "name" of the preset
     56  * '''link''' (i18n) - web link to further details (optional)
     57  * '''icon''' - icon for the whole preset
     58  * '''baselanguage''' - when the base language is not English, specify it here (using non English preset texts will prevent automatic translation, once it is implemented (#11392))
     59
     60 (i18n) means the values may also be localized (e.g. `de.description`).
     61\\
     62
    5663==== Comments ====
    57  '''<!-- this is an example comment -->'''::
    58   The document can contain embedded comments.
    59 ==== Menu creation ====
    60  '''<group>'''::
    61    Used to group items in sub menus. ''name'' is required, ''icon'' is optional attribute.
    62  '''<item>'''::
    63    Every item is one annotation set to select from. ''name'' is required, ''type'' is recommended, ''icon'' is optional attribute.
    64  '''<separator/>'''::
     64 <!-- this is an example comment -->::
     65   The document can contain embedded comments.
     66\\
     67
     68==== Preset group creation ====
     69 <group>::
     70   Used to group items in sub menus. `name=""` is required, `icon=""` is optional attribute.
     71 <item>::
     72   Every item is one annotation set to select from. `name=""` is required, `type=""` and `preset_name_label=""` are recommended, `icon=""`, `name_template=""` and `match_expression=""` are optional attributes.
     73 <separator />::
    6574   Insert a line separator into the menu.
     75\\
     76
    6677==== Preset window layout ====
    67  '''<label>'''::
    68    Labels are static texts for display. ''text'' is a required attribute, ''icon'' and ''icon_size'' are optional.
    69  '''<space />'''::
    70    Add some space (ie a newline).
    71  '''<optional>'''::
    72    Used to group some optional elements of an item. The ''text'' attribute is optional. If used without ''text'' then this is equivalent to <space /><label text="Optional Attributes:"/><space />
    73  '''<item_separator />'''::
     78 <label />::
     79   Labels are static texts for display. `text=""` is a required attribute, `icon=""` and `icon_size=""` are optional.
     80 <space />::
     81   Add some space (i.e. a newline).
     82 <optional>::
     83   Used to group some optional elements of an item. The `text=""` attribute is optional. If used without `text=""` then this is equivalent to `<space /><label text="Optional Attributes:" /><space />`
     84 <item_separator />::
    7485   Add a horizontal separator line between items.
    75  '''<link>'''::
    76    Specify a web link for this feature or to anything else of use. The ''href'' attribute is required.
    77  '''<checkgroup>'''::
    78    To group checks. The ''columns'' attribute is required.
    79  '''<roles>'''::
    80    This is required around <role> and adds the heading ("Availible roles role count elements") to the table which is generated by several <role>.
    81  '''<role>'''::
    82    To specify possible roles of members in relations. The ''key'' attribute is required, ''text'', ''requisite'', ''count'', ''type'' and ''member_expression'' are optional.
    83  '''<preset_link>'''::
    84    Adds a link to an other preset. The ''preset_name'' attribute is required.
     86 <link />::
     87   Specify a web link for this feature or to anything else of use. Either the `wiki=""` (referring to an OSM wiki page, e.g. `"Tag:leisure=park"`) or the `href=""` (full URL) attribute is required. When the `wiki=""` attribute is used the link points to the wiki page of the language JOSM is set to. If it doesn't exist the English page is shown.
     88 <checkgroup>::
     89   To group checks. The `columns=""` attribute is required.
     90 <roles>::
     91   This is required around `<role />` and adds the heading ("Available roles role count elements") to the table which is generated by several `<role />`.
     92 <role />::
     93   To specify possible roles of members in relations. The `key=""` attribute is required, `text=""`, `requisite=""`, `count=""`, `type=""` and `member_expression=""` are optional.
     94 <preset_link />::
     95   Adds a link to an other preset with a label on top. The `preset_name=""` attribute is required, `text=""` to override the label (default is `"Edit also …"`) and `text_context=""` are optional. A sequence of `<preset_link />` without `text=""` or a identical `text=""` value are grouped below one label. \\
     96   **Watch out** for presets with identical **`name=""`** as it is not predictable to which preset the link will lead to, see #12716. \\
     97   Having the same tag in both presets does not work, see #18992. \\
     98   Using `<preset_link />` in presets opened from [wikitr:/Help/Dialog/RelationEditor relation editor] produces unexpected changes, see #19392.
     99\\
     100
    85101==== Set a fixed key value pair ====
    86  '''<key>'''::
    87    This tag will always set a key to a specific value. ''key'' is required and if ''value'' is present, the key will be set. If ''value'' attribute is ommited, the key is removed. The ''match'' attribute is optional.
    88 ==== Attribute entry and selection dialog boxes ====
    89  '''<text>'''::
    90    A text edit field to enter any arbitrary string from the user. ''key'' is mandatory, ''text'', ''default'', ''match'' and ''required'' is optional
    91  '''<combo>'''::
    92    Displays a multiple choice combo box. ''key'' and ''values'' are mandatory and ''text'', ''default'', ''editable'', ''match'' and ''required'' is optional.
    93    If editable is true (default), combo boxes can be edited as if they were text fields (additional to the drop down menu). Non editable
    94    combo boxes can only contain one of the specified values.
    95  '''<multiselect>'''::
    96    Displays a list from which zero or more items can be chosen. ''key'' and ''values'' are mandatory, and ''text'', ''default'', ''delimiter'', ''match'' and ''required'' are optional. The selected values will be concatenated with the specified delimiter (default: semicolon) and written to the tag value. If a tag value has already been set when the preset dialog is opened, the multiselect will attempt to mark the appropriate items in the list as select. If the tag value cannot be represented by a combination of choices in the list, then the list will be disabled so that the user cannot accidentally overwrite a custom value. In contrast to the "combo" element, the "multiselect" expects the list of values, descriptions etc. to use the specified delimiter, i.e. by default you will have to use a semicolon. You can specify delimiter="," but then a comma will also be used in the tag value.
    97  '''<check>'''::
    98    A checkbox which the user can only select or deselect. The ''key'' attribute is mandatory. ''text'', ''default'', ''match'' and ''required'' is optional.
     102 <key />::
     103   This tag will always set a key to a specific value. `key=""` is required and if `value=""` is present, the key will be set. If `value=""` attribute is omitted, the key is removed. The `match=""` attribute is optional.
     104\\
     105
     106==== Attribute entry and selection dialog boxes ====#EntrySelectionBoxes
     107 <text />::
     108   A text edit field to enter any arbitrary string from the user. `key=""` is mandatory, `text=""`, `default=""`, `use_last_as_default=""`, `auto_increment=""`, `length=""`, `alternative_autocomplete_keys=""`, `match=""`, `icon=""` and `icon_size=""` (both since r17605) are optional.
     109 <combo />::
     110   Displays a multiple choice combo box. `key=""` and `values=""` are mandatory, `text=""`, `default=""`, `editable=""`, `delimiter=""`, `values_from=""`, `display_values=""`, `short_descriptions=""`, `use_last_as_default=""`, `values_searchable=""`, `length=""`, `values_no_i18n=""`, `values_sort=""`, `match=""`, `icon=""` and `icon_size=""` (both since r17605) are optional.\\
     111   If `editable=""` is `true` (default), combo boxes can be edited as if they were text fields (additional to the drop down menu). Non editable combo boxes can only contain one of the specified values.\\
     112   If the key is `colour` or `colour:*` or `*:colour`, a color preview and color picker is added on the right (see #8352).
     113 [=#multiselect]
     114 <multiselect />::
     115   Displays a list from which zero or more items can be chosen. `key=""` and `values=""` are mandatory, and `text=""`, `default=""`, `delimiter=""`, `values_from=""`, `rows=""`, `display_values=""`, `short_descriptions=""`, `use_last_as_default=""`, `values_searchable=""`, `values_no_i18n=""`, `values_sort=""`, `match=""`, `icon=""` and `icon_size=""` (both since r17605) are optional. The selected values will be concatenated with the specified delimiter (default: semicolon, `;`) and written to the tag value. If a tag value has already been set when the preset dialog is opened, the `<multiselect />` will attempt to mark the appropriate items in the list as select. If the tag value cannot be represented by a combination of choices in the list, then the list will be disabled so that the user cannot accidentally overwrite a custom value. In contrast to the `<combo />` element, the `<multiselect />` expects the list of values, descriptions etc. to use the specified delimiter, i.e. by default you will have to use a semicolon. You can specify `delimiter=","` but then a comma will also be used in the tag value.
     116 <list_entry />::
     117   Used in `<combo>` and `<multiselect>`. More information see `short_descriptions=""`, [#short_description below]. The attributes are `value=""`, `display_value=""`, `short_description=""`, `icon=""` and `icon_size=""`.
     118 <check />::
     119   A checkbox which the user can select, deselect or set as unset. The `key=""` attribute is mandatory. `text=""`, `default=""`, `match=""`, `value_on=""` , `value_off=""`, `disable_off=""`, `icon=""` and `icon_size=""` (both since r15437) are optional.
     120\\
     121
    99122==== Templates ====
    100  '''<chunk>'''::
    101    To define a template of elements for later (repeated) use. The ''id'' attribute is mandatory.
    102  '''<reference>'''::
    103    To include an earlier defined template. The ''ref'' attribute is mandatory.
     123 <chunk>::
     124   To define a template of elements for later (repeated) use. The `id=""` attribute is mandatory.
     125 <reference>::
     126   To include an earlier defined template. The `ref=""` attribute is mandatory.
     127\\
    104128
    105129=== Attributes ===
    106130The attributes of the tags have the following meaning:
    107  '''name="a_name"'''::
     131 name="a_name"::
    108132   Specify a name for an item. This name will be used in the GUI to display the tagging preset.
    109  '''name_context="context"'''::
     133 name_context="context"::
    110134   Translation context for name attribute to separate equals words with different meaning (not required for in-file translations).
    111  '''type="data_type"'''::
    112    When specified, only objects of the given type will be changed at all by this tagging preset. Can be "node", "relation", "way", "closedway" or any comma separated combination of them. Also used in the <role> tag to specify which object types are allowed for a specific relation member.
    113  '''icon="iconname"'''::
    114    A name or link to an icon. The image will be used as icon to display in the selection list and when adding the preset to the toolbar. The icon should be quadratic in size. See [[Styles#Iconhandling]] how icons can be specified.
    115  '''icon_size="a number"'''::
    116    The maximal size of an icon in px. If no value is given, default is 16 for <label>.
    117  '''key="some_key"'''::
    118    This specifies the property key that will be modified by the item. In case of <role> it is the role name used in a relation.
    119  '''text="Any text"'''::
    120    The description, that will be displayed before (after in case of <check>) the gui element. Also used for <label> and <optional>.
    121  '''text_context="context"'''::
     135 type="data_type"::
     136   When specified, only objects of the given type will work with this tagging preset. Can be `"node"`, `"way"`, `"closedway"`, `"multipolygon"`, `"relation"` or any comma separated combination of them. Note that `"multipolygon"` is not included in `"relation"`, so if the preset should apply for multipolygons and other relation types, you need to specify both: `"multipolygon,relation"`. Also used in the `<role>` tag to specify which object types are allowed for a specific relation member.
     137 icon="iconname"::
     138   A name or link to an icon. The image will be used as icon to display in the selection list and when adding the preset to the toolbar. Icons can also be used in  `<item>`, `<label />`, plus all [#EntrySelectionBoxes attribute entry and selection dialog boxes] (since r17605, before it was only `<list_entry />` and `<check />`).  It is placed in front of `<text />` The icon should be quadratic in size. See [wikitr:/Styles#Iconhandling Icon handling] how icons can be specified.
     139 icon_size="a number"::
     140   The maximal size of an icon in px. If no value is given, default is 16 for `<label />` and the default icon size for `<list_entry />` (in `<combo>` and `<multiselect>`).
     141 key="some_key"::
     142   This specifies the property key that will be modified by the item. In case of `<role>` it is the role name used in a relation.
     143 text="Any text"::
     144   The description, that will be displayed before the gui element, (in case of `<check />` after the gui element and the optional icon). Also used for `<label>` and `<optional>`.
     145 text_context="context"::
    122146   Translation context for text attribute to separate equals words with different meaning (not required for in-file translations).
    123  '''default="default_value"'''::
    124    The default value for the item. If not specified, the current value of the key is chosen as default (if applicable).
    125  '''values="entry1,entry2,entry3"'''::
    126    A list of entries (for the combo box and multiselect). The list has to be separated by commas (for the combo box) or by the specified delimiter (for the multiselect). If a value contains the delimiter, the delimiter may be escaped with a backslash. If a value contains a backslash, it must also be escaped with a backslash.
    127  '''values_context="context"'''::
    128    Translation context for name attribute to separate equals words with different meaning (not required for in-file translations).
    129  '''display_values="Entry1,Entry2,Entry3"'''::
    130    A list of entries that is displayed to the user. Must be the same number of entries as values and '''editable''' must be false or not specified. For the delimiter character and escaping, see the remarks at ''values''.
    131  '''value="foobar"'''::
    132    Specify a value to be entered in the <key> tag.
    133  '''value_on="foobar"'''::
    134    Specify the true value to be entered in the <key> tag (default is "yes").
    135  '''value_off="foobar"'''::
    136    Specify the false value to be entered in the <key> tag (default is "no").
    137  '''editable="false"'''::
    138    The combo box is readonly, which means that the user can only select an item in the list.
    139  '''use_last_as_default="true"'''::
    140    For combo boxes or text fields the last value is used as default. Using "force" enforces this behaviour also for already tagged objects.
    141  '''rows="count"'''::
    142    Specify the number of rows in multiselect entry.
    143  '''name_template="template", name_template_filter="search expression"'''::
    144    Custom name formatter for osm primitives matching this preset. See [[NameTemplate]] for details.
    145  '''match="none|key|key!|keyvalue|keyvalue!"'''::
    146     Allows to change the matching process, i.e., determining whether the tags of an OSM object fit into this preset. If a preset fits then it is linked in the [wiki:Help/Dialog/TagsMembership Tags/Membership dialog].
    147     * none: neutral, i.e., do not consider this item for matching
    148     * key: positive if key matches, neutral otherwise
    149     * key!: positive if key matches, negative otherwise
    150     * keyvalue: positive if key and value matches, neutral otherwise
    151     * keyvalue!: positive if key and value matches, negative otherwise
    152    Note that for a match, at least one positive and no negative is required. Default is "keyvalue!" for <key> and "none" for <text>, <combo>, <multiselect> and <check>.
    153  '''id="unique_identifier"'''::
    154    the unique identifier for this chunk
    155  '''ref="unique_identifier"'''::
     147 default="default_value"::
     148   An explicitly declared default value for the item. This value is ''only'' applied through a preset when the object the preset is applied to has ''zero keys''.
     149  If no value for default is specified, no value is set to the key. Used in `<check />`, `<text />`, `<combo />` and `<multiselect />`. For `<check />` only the values `"on"` and `"off"` are valid.
     150 values="entry1,entry2,entry3"::
     151   A list of entries (for the `<combo />` box and `<multiselect />`). The list has to be separated by commas (for the combo box) or by the specified delimiter (for the multiselect). If a value contains the delimiter, the delimiter may be escaped with a backslash. If a value contains a backslash, it must also be escaped with a backslash.
     152 values_from="JAVA code"::
     153   To use instead of `values=""` if the list of values has to be obtained with a Java method of this form: `public static String[] getValues()`; The value must be: "full.package.name.ClassName#methodName".
     154 values_no_i18n="true|false"::
     155   Disables internationalisation for values to avoid mistakes, see #11696. Default is `"false"`. Used in `<combo />` and `<multiselect />`. (Useful e.g. for keys `opening hours` or `brand`.) Not needed with keys with only numbers as values like `layer` or `level` which are already excluded from translation.
     156 values_sort="true|false"::
     157   Values of `<combo />` and `<multiselect />` are sorted alphabetic in every language. With this attribute you can disable the alphabetic sorting if the values should keep the given order, see #5509 and #11926. (In the JOSM internal preset this is used e.g. for the keys `tracktype`, `direction`, `network`, `smoothness`, `visibility` or `trail_visibility`.) Default is `"true"`.\\
     158  Users can globally disable sorting with the preference key `taggingpreset.sortvalues`.
     159 values_context="context"::
     160   Translation context for values attribute to separate equals words with different meaning (not required for in-file translations).
     161 display_values="Entry1,Entry2,Entry3"::
     162   A list of entries that is displayed to the user. Must be the same number and order of entries as `values=""` and `editable=""` must be `"false"` or not specified. For the delimiter character and escaping, see the remarks at `values=""`. Used in `<combo />` and `<multiselect />`.
     163 value="foobar"::
     164   Specify a value to be entered in the `<key>` tag.
     165 value_on="foobar"::
     166   Specify the true value to be entered in the `<key>` tag of a checked `<check />` (default is `"yes"`).
     167 value_off="foobar"::
     168   Specify the false value to be entered in the `<key>` tag of a unchecked `<check />` (default is `"no"`).
     169 disable_off="true"::
     170   Whether the off value of a `<check />` is disabled in the dialog, i.e., only unset or `"yes"` are provided.
     171 editable="false"::
     172   The combo box is read only, which means that the user can only select an item in the list. Default is `"true"`, which means, the user can add other values as text. **Feature is broken, see #6157**.
     173 use_last_as_default="true|false|force"::
     174   For `<combo />`, `<multiselect />` or `<text />` fields the last used value is used as default. Using `"force"` enforces this behavior also for already tagged objects. Default is `"false"`.
     175 rows="count"::
     176   Specify the number of rows to display in `<multiselect />` entry (if not set, it is auto determined by java or the look and feel and results in e.g. 8). Currently, you need to add one additional row to display all values, see #19013.
     177 name_template="template", name_template_filter="search expression"::
     178   Custom name formatter for osm primitives matching this preset. See [#name_templatedetails name template details] below.
     179 match="none|key|key!|keyvalue|keyvalue!"::
     180   Allows to change the matching process, i.e., determining whether the tags of an OSM object fit into this preset. If a preset fits then it is linked in the [wikitr:/Help/Dialog/TagsMembership Tags/Membership dialog].
     181   * `none`: neutral, i.e., do not consider this item for matching
     182   * `key`: positive if key matches, neutral otherwise
     183   * `key!`: positive if key matches, negative otherwise
     184   * `keyvalue`: positive if key and value matches, neutral otherwise
     185   * `keyvalue!`: positive if key and value matches, negative otherwise \\
     186  **Note**: For a match, at least one positive and no negative is required. Default is `"keyvalue!"` for `<key>` and `"none"` for `<text />`, `<combo />`, `<multiselect />` and `<check />`.
     187 match_expression="search expression"::
     188   additional criteria for matching primitives, specified in [wikitr:/Help/Action/Search JOSM search] syntax. ''(since r17662)'' \\
     189   For instance, a preset with `match_expression="foo=bar"` requires OSM objects to have the tag `foo=bar`. You may want to use the `match_expression=""` to exclude certain OSM objects, e.g. when a more specific preset is present. \\
     190  **Note**: Does not work, yet, see #20843.
     191 id="unique_identifier"::
     192   the unique identifier for this `<chunk>`
     193 ref="unique_identifier"::
    156194   the unique identifier of the (already defined) template to include
    157  '''columns="a number"'''::
    158    the number of columns of grouped checks
    159  '''requisite="optional|required"'''::
    160    If a relation member is optional or required. Default is "optional".
    161  '''count="a number"'''::
     195 columns="a number"::
     196   the number of columns of grouped `<check />`
     197 requisite="optional|required"::
     198   If a relation member is optional or required. Default is `"optional"`.
     199 count="a number"::
    162200   How often can a role occur (if not given unlimited number is assumed)
    163  '''member_expression="an expression"'''::
    164    an expression (cf. search dialog) for objects of this role
    165  '''preset_name="exact_name"'''::
     201 member_expression="search expression"::
     202   an expression, in [wikitr:/Help/Action/Search JOSM search] syntax, for objects of this role
     203 regexp="true"::
     204   set to `"true"` if the key of a role is a regular expression. \\
     205   This allows variable roles e.g. `<role key="level_-?\d+" text="Building level" regexp="true" requisite="optional" type="relation" />` allows the roles `level_0`, `level_1`,...
     206 preset_name="exact_name"::
    166207   The exact name of the preset to link to.
    167 
    168 == Format description from XML document (needs to be joined with above texts) ==
    169  (delete here the parts which you have joined with above texts)
     208 preset_name_label="false|true"::
     209   Whether to insert "[preset name]" label in dialog (defaults to `"false"` for backward-compatibility on external presets).
     210 length="a number"::
     211   The length of a `<text />` or `<combo />` box (number of characters allowed).
     212 alternative_autocomplete_keys="some_key(s)"::
     213   A comma separated list of alternative keys to use for auto completion of `<text>`.
     214 auto_increment="-2,-1,+1,+2"::
     215   May contain a comma separated list of integer increments or decrements, e.g. `"-2,-1,+1,+2"`. A button will be shown next to the `<text />` field for each value, allowing the user to select auto-increment with the given stepping. Auto-increment only happens if the user selects it. There is also a button to deselect auto-increment. Default is no auto-increment. Mutually exclusive with `use_last_as_default=""`.
     216 delimiter="special character"::
     217   The character that separates values. In case of `<combo />` the default is ''comma'' (`,`). In case of `<multiselect />` the default is ''semicolon'' (`;`) and this will also be used to separate selected values in the tag. More information see `<multiselect />`, [#multiselect above].
     218 [=#short_description]
     219 short_descriptions="Entry1,Entry2,Entry3"::
     220   A delimiter-separated list of texts to be displayed below each `display_value=""`. (Only if it is not possible to describe the entry in 2-3 words.) Instead of a comma separated list  using `values=""`, `display_values=""` and `short_descriptions=""`, the following form is also supported: \\
     221   `<list_entry value="" display_value="" short_description="" icon="" icon_size="" />`
     222 values_searchable="true|false"::
     223   Whether to search in `values=""` and `display_values=""`, respectively, `value=""` and `display_value=""` of `<combo />` or `<multiselect />`  searching for presets.
     224 value_template="template"::
     225   A template to generate the value automatically based on other tag values of the object. The syntax of `name_template=""` is used, [#NameTemplateSyntax see below]. ''(since r17639)'' \\
     226   For instance, `"Bus {ref}: {from} → {to}"` can be used to generate the name of a bus route relation. \\
     227  **Note**: There are some minor problems with this attribute, see #20851 and #20861.
     228\\
     229
     230===== name_template details =====
     231Name templates can be used to define custom formatting for OSM primitives or GPX waypoints (for example in the Relations or the Selection).
    170232
    171233{{{
    172 item:
    173   name: the text to display
    174   icon: the icon to display
    175   - relative to the icon path
    176   - URL's are also supported to allow remote icons (are cached locally)
    177   type: the data types - way,node,relation,closedway (separated by comma)
    178   name_template: define custom formatting for OSM primitives
    179                  see [[NameTemplate]]
    180   preset_name_label: whether to insert "[preset name]" label in dialog
    181                      (defaults to "false" for backward-compatibility on external presets)
    182 
    183 text: text box
    184   key: key to set
    185   text: fixed label to display
    186   default: default string to display (defaults to "")
    187   use_last_as_default: true/false/force (default is "false")
    188   auto_increment: may contain a comma separated list of integer increments or
    189                   decrements, e.g. "-2,-1,+1,+2"; a button will be shown next
    190                   to the text field for each value, allowing the user to select
    191                   auto-increment with the given stepping. auto-increment only
    192                   happens if the user selects it. default is no auto-increment;
    193                   mutually exclusive with use_last_as_default.
    194   length: length of input box (number of characters allowed)
    195   alternative_autocomplete_keys: comma separated list of alternative keys to use for autocompletion
    196 
    197 combo: combo box, with multiple choices and possible to enter free form text
    198   key: key to set
    199   text: fixed label to display
    200   delimiter: character that separates values (default: comma)
    201   values: separated list of values
    202   values_from: to use instead of "values" if the list of values has to be obtained with a Java method
    203                of this form: public static String[] getValues();
    204                The value must be: "full.package.name.ClassName#methodName"
    205   display_values: comma separated list of values to be displayed instead of the
    206                   database values, order and number must be equal to values
    207   short_descriptions: comma separated list of texts to be displayed below each
    208                       display_value. (Only if it is not possible to describe
    209                       the entry in 2-3 words.) Instead of comma separated list
    210   instead using values, display_values and short_descriptions, the following form is also supported:
    211     <list_entry value="" display_value="" short_description="" icon="" icon_size="" />
    212         icon: location of icon
    213         icon_size: maximal size of icon. If tag is not setup it is taken default size of icon file
    214   default: default string to display (defaults to "")
    215   use_last_as_default: true/false/force (default is "false")
    216   editable: allow to add other values as text (default is "true")
    217   values_searchable: true/false (whether to search in combo (display_)values when searching for presets)
    218   length: length of input box (number of characters allowed)
    219 
    220 multiselect: list of values from which zero or more can be selected
    221   key: key to set
    222   text: fixed label to display
    223   delimiter: character that separates values (default: semicolon) - this
    224              will also be used to separate selected values in the tag.
    225   values: delimiter-separated list of values (delimiter can be escaped with backslash)
    226   values_from: to use instead of "values" if the list of values has to be obtained with a Java method
    227                of this form: public static String[] getValues();
    228                The value must be: "full.package.name.ClassName#methodName"
    229   rows: specify the number of rows to display (default -1)
    230   display_values: delimiter-separated list of values to be displayed instead of the
    231                   database values, order and number must be equal to values
    232   short_descriptions: delimiter-separated list of texts to be displayed below each
    233                       display_value. (Only if it is not possible to describe
    234                       the entry in 2-3 words.) Instead of a separated list
    235   instead using values, display_values and short_descriptions, the following form is also supported:
    236     <list_entry value="" display_value="' short_description="" icon="" icon_size="" />
    237         icon: location of icon
    238         icon_size: maximal size of icon. If tag is not setup it is taken default size of icon file
    239   default: default string to display (defaults to "")
    240   use_last_as_default: true/false/force (default is "false")
    241   values_searchable: true/false (whether to search in multiselect (display_)values when searching for presets)
    242 
    243 check: checkbox
    244   key: key to set
    245   text: fixed label to display
    246   default: ticked on/off (default is "off")
    247   value_on: the value to set when checked (default is "yes")
    248   value_off: the value to set when unchecked (default is "no")
    249   disable_off: whether the off value is disabled in the dialog, i.e., only unset or yes are provided
    250 
     234#!xml
     235<?xml version="1.0" encoding="UTF-8"?>
     236<presets>
     237        <item name="Public transportation" type="relation"
     238                name_template="Bus({operator} {ref} ?{'{from} - {via} - {to}' | '{from} - {to}' | '{from}' | '{to}'})"
     239                name_template_filter="type=route route=bus">
     240        </item>
     241</presets>
    251242}}}
    252243
     244'''Samples'''
     245||= Template =||= Tags =||= Result =||
     246|| `House number {addr:housenumber}` || `addr:housenumber=10` || House number 10
     247|| `?{ 'House number {addr:housenumber} at {addr:street}' | 'House number {addr:housenumber}'  }` || `addr:housenumber=10` || House number 10
     248|| || `addr:housenumber=10 addr:street=Abbey road` || House number 10 at Abbey road
     249|| `?{ admin_level = 2 'NUTS 1' | admin_level = 4 'NUTS 2' | admin_level = 6 'NUTS 3' |  'Admin level {admin_level}'}` ||  `admin_level=4` || NUTS 2
     250|| || `admin_level=5` || Admin level 5
     251|| `{admin_level} - {name} !{parent() type=boundary '?{'(part of {admin_level} - {name})' | ''}'}` || `admin_level=6 name=Vysocina`, member of relation `admin_level=4 name=Jihovychod` || 6 - Vysocina (part of Jihovychod)
     252|| ||  `admin_level=2 name=Czech republic` (no parents) || 2 - Czech republic
     253\\
     254
     255====== Syntax ======#NameTemplateSyntax
     256* `{var}` - use value of variable var
     257* `?{condition1 'value1' | condition2 'value2 | 'value3'}` - use ''value1'' if ''condition1'' is satisfied, ''value3'' if no condition is satisfied. Condition can be either explicit - in [wikitr:/Help/Action/Search JOSM search] syntax - or implicit; the value is used when all variables used inside exist
     258* `!{search_expression 'template'}` - search_expression is evaluated and first matching primitive is used as context for template. Useful for example to get tags of parent relation.
     259\\
     260
     261====== Available values ======
     262For formatting of OSM primitives , the value of any tag can be used. You can use `{special:everything}` to see what values are available for your gpx waypoints.
     263
     264Some additional variables are available  via the special prefix:
     265- `{special:everything}` prints all available values, available for formatting of both primitives and waypoints.
     266- `{special:id}` prints the ID of an osm primitive
     267- `{special:localName}` prints the localized name, that is the value of `name:lang` for your language if it is available or the value of the name tag if it doesn't.
     268\\
     269
     270=== Deprecated Attributes ===
     271The following attributes are deprecated and no longer supported by JOSM:
     272
     273 delete_if_empty="true"::
     274   was removed in r5155. You can simply remove this attribute if still used in your preset.
     275 required="true"::
     276   replaced by `match=""` since r5155
     277\\
     278
    253279== Translation ==
    254 To support translations, all textual elements ("name", "text", "display_values") may also be localized. (E.g. "de.name" would represent the name in case German language support is loaded.)
    255 
    256 In JOSM internally ([source:josm/trunk/data/defaultpresets.xml internal preset]) all "name", "text" and "display_values" are translated when no specific translation has been given in XML file. When no "display_values" are supplied, then "values" will be treated as "display_values" and translated instead. When translations of equal words but different meanings may conflict, a translation context should be specified. Use "name_context", "text_context" or "values_context" for this. The context should be a meaningful short description to help translators. The translation for the internal preset is done at [https://translations.launchpad.net/josm/trunk Launchpad] (and will probably change to Transifex in the future).
     280To support translations, all textual elements (`name=""`, `text=""`, `display_values=""`) may also be localized. E.g. `de.name=""` would represent the name in case the German language support is loaded. In the preset code the English term must be the first before possible translations are added.
     281
     282In JOSM internally ([source:josm/trunk/resources/data/defaultpresets.xml internal preset]) all `name=""`, `text=""` and `display_values=""` are translated when no specific translation has been given in XML file. When no `display_values=""` are supplied, then `values=""` will be treated as `display_values=""` and translated instead. When translations of equal words but different meanings may conflict, a translation context should be specified. Use `name_context=""`, `text_context=""` or `values_context=""` for this. The context should be a meaningful short description to help translators.
     283
     284The translation for the internal preset is done at [https://translations.launchpad.net/josm/trunk Launchpad] (and will probably change to another service in the future, since the Launchpad web interface often produces timeout errors, see #8645).
     285
     286The translation of external presets on this website is, so far, only possible inline within the preset source code, see #11392.
    257287
    258288== Icon handling ==
    259 See [wiki:Styles#Iconhandling Styles].
     289See [wikitr:/Styles#Iconhandling Styles].
    260290
    261291== See also ==
    262 * [wiki:Presets]
    263 * [wiki:Help/Menu/Presets Presets menu]
    264 * [wiki:Help/Preferences/Map#TaggingPresets Tagging presets preferences]
     292* [wikitr:/Help/Menu/Presets Presets menu]