Changes between Version 111 and Version 198 of TaggingPresets
- Timestamp:
- (multiple changes)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TaggingPresets
v111 v198 1 [[TranslatedPages (outdated=The example should be changed because it uses key-value pairs which are uncommon in OSM and highways are usually NOT oneway.)]]1 [[TranslatedPages]] 2 2 [[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 3 9 = 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 == Installing presets == 7 Either: 8 * Click on main menu [Help/Menu/Presets Presets] and click on "Preset Preferences". 9 * 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"]. 10 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). 11 12 The 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. 10 13 11 14 == Develop a new preset == 12 15 The tagging preset description is in a very simple XML format. Details see [#XML below]. 13 16 14 See the **[source:trunk/data/defaultpresets.xml defaultpresets.xml]** for an example covering most of the possibilities listed below. 15 16 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]. 17 18 To add the preset to the list of available presets see [[Presets#Createnewpresets]]. 17 See the **[source:/trunk/resources/data/defaultpresets.xml defaultpresets.xml]** for an example covering most of the possibilities listed below. 19 18 20 19 Example: 21 [[Image(tagging_screenshot.png,align=right)]] 20 21 [[Image(Change 1 object.png,right,link=,margin-left=15)]] 22 22 23 23 {{{ 24 #!xml 24 #!preset 25 <?xml version="1.0" encoding="UTF-8"?> 25 26 <presets xmlns="http://josm.openstreetmap.de/tagging-preset-1.0"> 26 <item name="Highway"> 27 <label text="Inserting a highway in UK" /> 28 29 <text key="name" text="Highway (e.g. M3)" /> 30 <combo key="highway" text="Type" values="major,minor" /> 31 32 <!-- 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 --> 33 35 <check key="oneway" text="Oneway" default="on" /> 34 36 35 <!-- Always setting class=highway-->36 <key key=" class" value="highway" />37 <!-- Always setting asphalt surface --> 38 <key key="surface" value="asphalt" /> 37 39 </item> 38 40 </presets> 39 41 }}} 42 \\ 40 43 41 44 == XML Format description ==#XML 45 The 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 42 47 === Tags === 43 ==== The document prolog ==== 48 ==== The document prologue ==== 44 49 <presets>:: 45 50 Has to be the main tag of the file. Supports following attributes 46 * '''xmlns="http://josm.openstreetmap.de/tagging-preset-1.0"''' 47 * '''author''' - the name of the author of the preset 48 * '''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). 49 * '''description''' (i18n) - description what the file contains 50 * '''shortdescription''' (i18n) - very short overview description i.e. the "name" of the preset 51 * '''link''' (i18n) - web link to further details (optional) 52 * '''icon''' - informational icon for the whole preset. (This is nedded to display the icon in the table at [[Presets]].) 53 54 (i18n) means the values may also be localized (e.g. de.description). 55 [[BR]] 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 56 63 ==== Comments ==== 57 64 <!-- this is an example comment -->:: 58 The document can contain embedded comments. 59 [[BR]] 60 ==== Menu creation ==== 65 The document can contain embedded comments. 66 \\ 67 68 ==== Preset group creation ==== 61 69 <group>:: 62 Used to group items in sub menus. `name` is required, `icon` is optional attribute. 70 Used to group items in sub menus. `name=""` is required, `icon=""` is optional attribute. 63 71 <item>:: 64 Every item is one annotation set to select from. `name` is required, `type` and `preset_name_label` are recommended, `icon` and `name_template` are optional attributes. 65 <separator/>:: 66 Insert a line separator into the menu. 67 [[BR]] 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 />:: 74 Insert a line separator into the menu. 75 \\ 76 68 77 ==== Preset window layout ==== 69 <label>:: 70 Labels are static texts for display. `text` is a required attribute, `icon` and `icon_size` are optional. 78 <label />:: 79 Labels are static texts for display. `text=""` is a required attribute, `icon=""` and `icon_size=""` are optional. 71 80 <space />:: 72 Add some space (i ea newline).81 Add some space (i.e. a newline). 73 82 <optional>:: 74 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 /> 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 />` 75 84 <item_separator />:: 76 Add a horizontal separator line between items. 77 <link>:: 78 Specify a web link for this feature or to anything else of use. The `href` attribute is required.85 Add a horizontal separator line between items. 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. If using `wiki=""`, the OSM wiki page must not be URL encoded, e.g., it must not be `"Tag:leisure%3Dpark"` and must instead be `"Tag:leisure=park"`. 79 88 <checkgroup>:: 80 To group checks. The `columns` attribute is required. 89 To group checks. The `columns=""` attribute is required. 81 90 <roles>:: 82 This is required around <role> and adds the heading ("Availible roles role count elements") to the table which is generated by several <role>. 83 <role>:: 84 To specify possible roles of members in relations. The `key` attribute is required, `text`, `requisite`, `count`, `type` and `member_expression` are optional. 85 <preset_link>:: 86 Adds a link to an other preset. The `preset_name` attribute is required. 87 [[BR]] 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=""`, `member_expression=""` and `regexp=""` 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 exceptions, see #20044. 99 \\ 100 88 101 ==== Set a fixed key value pair ==== 89 <key>:: 90 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. 91 [[BR]] 92 ==== Attribute entry and selection dialog boxes ==== 93 <text>:: 94 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` and `match` is optional 95 <combo>:: 96 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` and `match` is optional.\\ 97 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. 98 <multiselect>:: 99 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` and `match` 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. 100 <list_entry>:: 101 Used in <combo> and <multiselect>. More information see `short_descriptions`. The attributes are `value`, `display_value`, `short_description`, `icon` and `icon_size`. 102 <check>:: 103 A checkbox which the user can only select or deselect (or set as unset). The `key` attribute is mandatory. `text`, `default`, `match`, `value_on` , `value_off` and `disable_off` are optional. 104 [[BR]] 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 105 122 ==== Templates ==== 106 123 <chunk>:: 107 To define a template of elements for later (repeated) use. The `id` attribute is mandatory. 124 To define a template of elements for later (repeated) use. The `id=""` attribute is mandatory. 108 125 <reference>:: 109 To include an earlier defined template. The `ref` attribute is mandatory. 110 [[BR]] 126 To include an earlier defined template. The `ref=""` attribute is mandatory. 127 \\ 128 111 129 === Attributes === 112 130 The attributes of the tags have the following meaning: 113 131 name="a_name":: 114 Specify a name for an item. This name will be used in the GUI to display the tagging preset. 132 Specify a name for an item. This name will be used in the GUI to display the tagging preset. 115 133 name_context="context":: 116 Translation context for name attribute to separate equals words with different meaning (not required for in-file translations). 134 Translation context for name attribute to separate equals words with different meaning (not required for in-file translations). 117 135 type="data_type":: 118 When specified, only objects of the given type will be changed at all bythis 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.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. 119 137 icon="iconname":: 120 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> and <list_entry>. The icon should be quadratic in size. See [[Styles#Iconhandling]] how icons can be specified.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. 121 139 icon_size="a number":: 122 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>).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>`). 123 141 key="some_key":: 124 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.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. 125 143 text="Any text":: 126 The description, that will be displayed before (afterin case of<check>)the gui element. Also used for <label>and<optional>.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>`. 127 145 text_context="context":: 128 Translation context for text attribute to separate equals words with different meaning (not required for in-file translations). 146 Translation context for text attribute to separate equals words with different meaning (not required for in-file translations). 129 147 default="default_value":: 130 The default value for the item. If not specified, the current value of the key is chosen as default (if applicable). In case of <check> whether the checkbox is ticked on or off by default (default is "off"). In case of <text>, <combo> and <multiselct> defaults to "". 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. 131 150 values="entry1,entry2,entry3":: 132 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.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. 133 152 values_from="JAVA code":: 134 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". 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`. 135 159 values_context="context":: 136 Translation context for nameattribute to separate equals words with different meaning (not required for in-file translations).160 Translation context for values attribute to separate equals words with different meaning (not required for in-file translations). 137 161 display_values="Entry1,Entry2,Entry3":: 138 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 falseor not specified. For the delimiter character and escaping, see the remarks at `values`. Used in<combo> and <multiselect>.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 />`. 139 163 value="foobar":: 140 Specify a value to be entered in the <key>tag.164 Specify a value to be entered in the `<key>` tag. 141 165 value_on="foobar":: 142 Specify the true value to be entered in the <key>tag of a checked<check>(default is"yes").166 Specify the true value to be entered in the `<key>` tag of a checked `<check />` (default is `"yes"`). 143 167 value_off="foobar":: 144 Specify the false value to be entered in the <key>tag of a unchecked<check>(default is"no").168 Specify the false value to be entered in the `<key>` tag of a unchecked `<check />` (default is `"no"`). 145 169 disable_off="true":: 146 Whether the off value of a <check>is disabled in the dialog, i.e., only unset oryesare provided.170 Whether the off value of a `<check />` is disabled in the dialog, i.e., only unset or `"yes"` are provided. 147 171 editable="false":: 148 The combo box is readonly, 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.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 was not working properly for a long time but should work again since r18221, see #6157.) 149 173 use_last_as_default="true|false|force":: 150 For <combo>,<multiselect> or <text>fields the last value is used as default. Using"force"enforces this behaviour also for already tagged objects. Default is"false".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"`. 151 175 rows="count":: 152 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).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). 153 177 name_template="template", name_template_filter="search expression":: 154 Custom name formatter for osm primitives matching this preset. See [ [NameTemplate]] fordetails.178 Custom name formatter for osm primitives matching this preset. See [#name_templatedetails name template details] below. 155 179 match="none|key|key!|keyvalue|keyvalue!":: 156 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]. 157 * none: neutral, i.e., do not consider this item for matching 158 * key: positive if key matches, neutral otherwise 159 * key!: positive if key matches, negative otherwise 160 * keyvalue: positive if key and value matches, neutral otherwise 161 * keyvalue!: positive if key and value matches, negative otherwise 162 163 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>. 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 Quotes (`"`) need to be written as `"`. \\ 190 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. 164 191 id="unique_identifier":: 165 the unique identifier for this chunk192 the unique identifier for this `<chunk>` 166 193 ref="unique_identifier":: 167 the unique identifier of the (already defined) template to include 194 the unique identifier of the (already defined) template to include 168 195 columns="a number":: 169 the number of columns of grouped checks196 the number of columns of grouped `<check />` 170 197 requisite="optional|required":: 171 If a relation member is optional or required. Default is "optional". 198 If a relation member is optional or required. Default is `"optional"`. 172 199 count="a number":: 173 How often can a role occur (if not given unlimited number is assumed) 174 member_expression="an expression":: 175 an expression (cf. search dialog) for objects of this role 200 How often can a role occur (if not given unlimited number is assumed) 201 member_expression="search expression":: 202 an expression, in [wikitr:/Help/Action/Search JOSM search] syntax, for objects of this role \\ 203 Quotes (`"`) need to be written as `"`. 204 regexp="true":: 205 set to `"true"` if the key of a role is a regular expression. \\ 206 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`,... 176 207 preset_name="exact_name":: 177 The exact name of the preset to link to. 208 The exact name of the preset to link to. 178 209 preset_name_label="false|true":: 179 Whether to insert "[preset name]" label in dialog (defaults to "false"for backward-compatibility on external presets).210 Whether to insert "[preset name]" label in dialog (defaults to `"false"` for backward-compatibility on external presets). 180 211 length="a number":: 181 The length of a <text> or <combo>box (number of characters allowed).212 The length of a `<text />` or `<combo />` box (number of characters allowed). 182 213 alternative_autocomplete_keys="some_key(s)":: 183 A comma separated list of alternative keys to use for autocompletion of <text>.214 A comma separated list of alternative keys to use for auto completion of `<text>`. 184 215 auto_increment="-2,-1,+1,+2":: 185 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 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=""`. 186 217 delimiter="special character":: 187 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>. 188 short_descriptions=""Entry1,Entry2,Entry3":: 189 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 comma separated list instead using values, display_values and short_descriptions, the following form is also supported: <list_entry value="" display_value="" short_description="" icon="" icon_size="" /> 218 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]. 219 [=#short_description] 220 short_descriptions="Entry1,Entry2,Entry3":: 221 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: \\ 222 `<list_entry value="" display_value="" short_description="" icon="" icon_size="" />` 190 223 values_searchable="true|false":: 191 Whether to search in <combo> or <multiselect> (display_)values when searching for presets. 224 Whether to search in `values=""` and `display_values=""`, respectively, `value=""` and `display_value=""` of `<combo />` or `<multiselect />` searching for presets. 225 value_template="template":: 226 A template to generate the value automatically based on other tag values of the object. The same syntax as in `name_template=""` is used, [#NameTemplateSyntax see below]. ''(since r17639)'' \\ 227 For instance, `"Bus {ref}: {from} → {to}"` can be used to generate the name of a bus route relation. \\ 228 **Note**: There are some minor problems with this attribute, see #20851 and #20861. 229 \\ 230 231 ===== name_template and value_template details ===== #name_templatedetails 232 Name templates can be used to define custom formatting for OSM primitives or GPX waypoints (for example in the Relations or Selection panels). 233 234 {{{ 235 #!xml 236 <?xml version="1.0" encoding="UTF-8"?> 237 <presets> 238 <item name="Public transportation" type="relation" 239 name_template="Bus({operator} {ref} ?{'{from} - {via} - {to}' | '{from} - {to}' | '{from}' | '{to}'})" 240 name_template_filter="type=route route=bus"> 241 </item> 242 </presets> 243 }}} 244 245 **Samples** 246 ||= Template =||= Tags =||= Result =|| 247 || `House number {addr:housenumber}` || `addr:housenumber=10` || House number 10 248 || `?{ 'House number {addr:housenumber} at {addr:street}' | 'House number {addr:housenumber}' }` || `addr:housenumber=10` || House number 10 249 || || `addr:housenumber=10 addr:street=Abbey road` || House number 10 at Abbey road 250 || `?{ admin_level = 2 'NUTS 1' | admin_level = 4 'NUTS 2' | admin_level = 6 'NUTS 3' | 'Admin level {admin_level}'}` || `admin_level=4` || NUTS 2 251 || || `admin_level=5` || Admin level 5 252 || `{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 4 - Jihovychod) 253 || || `admin_level=2 name=Czech republic` (no parents) || 2 - Czech republic 254 \\ 255 256 ====== Syntax ======#NameTemplateSyntax 257 * `{tag}` - insert the value of the tag. 258 * `?{condition1 'value1' | condition2 'value2' | 'value3'}` - use ''value1'' if ''condition1'' is satisfied, else use ''value2'' if ''condition2'' is satisfied, finally use ''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 tags referenced inside exist. 259 * `!{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. 260 * `\` - use a backslash to escape special characters '{', '}', '?', '!'. E.g. `What is this\? It is a {type}\!`. 261 \\ 262 263 ====== Available values ====== 264 For formatting of OSM primitives, the value of any tag can be used. Use the tag `{special:everything}` to display all available tags, eg. on your gpx waypoints. 265 266 You can also use these virtual tags: 267 - `{special:everything}` prints all available values, available for formatting of both primitives and waypoints. 268 - `{special:id}` prints the ID of the osm primitive. 269 - `{special:localName}` prints the localized name, that is the value of `name:lang` for your language if it is available, or the value of `name` if it is not. 270 \\ 192 271 193 272 === Deprecated Attributes === … … 195 274 196 275 delete_if_empty="true":: 197 was removed in [5155]. You can simply remove this attribute if still used in your preset.276 was removed in r5155. You can simply remove this attribute if still used in your preset. 198 277 required="true":: 199 repleaced by `match` since [5155] 278 replaced by `match=""` since r5155 279 \\ 200 280 201 281 == Translation == 202 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.) 203 204 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 another service in the future, since the Launchpad web interface often produces timeout errors, see #8645). 282 To support translations, all textual elements (`name=""`, `text=""`, `display_values=""`) can be localized. E.g. `de.name=""` would represent the name when the German language support is loaded. In the preset XML code the English term must be the first, before possible translations can be added. 283 284 === Internal Preset === 285 The translation for the internal preset is done at [https://translations.launchpad.net/josm/trunk Launchpad]. 286 287 In the [source:josm/trunk/resources/data/defaultpresets.xml internal preset], all `name=""`, `text=""` and `display_values=""` are translated via the above service, as long as no specific translation has been given within XML file. When no `display_values=""` are supplied, then `values=""` will be treated as `display_values=""` and translated instead. 288 289 When the same English word has different translations in different contexts, the specific translation context needs to be specified. Use `name_context=""`, `text_context=""` or `values_context=""` for this purpose. The context should be a meaningful short description to help translators. 290 291 === External Presets === 292 293 The translation of external presets on this website is, so far, only possible inline within the preset XML source code, see #11392. 294 295 Presets hosted elsewhere can also add a `data` directory with the JOSM-style {{{.lang}}} files for translation (like in JOSM itself or plugins). 296 297 However, when words are used in the external preset that already exist in the internal preset, the translation from the internal preset applies to the external as well. This is useful as long as the context is the same. When the context in the external preset is different, it needs to be distinguished by adding `name_context=""`, `text_context=""` or `values_context=""`. 205 298 206 299 == Icon handling == 207 See [wiki :Styles#Iconhandling Styles].300 See [wikitr:/Styles#Iconhandling Styles]. 208 301 209 302 == See also == 210 * [wiki:Presets] 211 * [wiki:Help/Menu/Presets Presets menu] 212 * [wiki:Help/Preferences/Map#TaggingPresets Tagging presets preferences] 303 * [wikitr:/Help/Menu/Presets Presets menu]