Changes between Version 170 and Version 171 of TaggingPresets

Timestamp:

2020-05-04T21:48:39+02:00 (6 years ago)

Author:

skyper

Comment:

added some slashes

TaggingPresets

@@ -68 +68 @@
  <item>::
   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.
- <separator/>::
+ <separator />::
   Insert a line separator into the menu.
 \\
 
 ==== Preset window layout ====
- <label>::
+ <label />::
   Labels are static texts for display. `text` is a required attribute, `icon` and `icon_size` are optional.
  <space />::
-  Add some space (ie a newline).
+  Add some space (i.e. a newline).
  <optional>::
-  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 />`
+  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 />`
  <item_separator />::
   Add a horizontal separator line between items.
- <link>::
-  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.
+ <link />::
+  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.
  <checkgroup>::
   To group checks. The `columns` attribute is required.
  <roles>::
-  This is required around `<role>` and adds the heading ("Available roles role count elements") to the table which is generated by several `<role>`.
- <role>::
+  This is required around `<role />` and adds the heading ("Available roles role count elements") to the table which is generated by several `<role />`.
+ <role />::
   To specify possible roles of members in relations. The `key` attribute is required, `text`, `requisite`, `count`, `type` and `member_expression` are optional.
- <preset_link>::
-  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. **Watch out for presets with identical `name`** as it is not predictable to which preset the link will lead to, see #12716.
+ <preset_link />::
+  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. **Watch out for presets with identical `name`** as it is not predictable to which preset the link will lead to, see #12716.
 \\
 
 ==== Set a fixed key value pair ====
- <key>::
+ <key />::
   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.
 \\
 
 ==== Attribute entry and selection dialog boxes ====
- <text>::
+ <text />::
   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
- <combo>::
+ <combo />::
   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` and `match` is optional.\\
   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.\\
   If the key is `colour` or `colour:*` or `*:colour`, a color preview and color picker is added on the right (see #8352).
  [=#multiselect]
- <multiselect>::
-  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` 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.
- <list_entry>::
+ <multiselect />::
+  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` 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.
+ <list_entry />::
   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`.
- <check>::
+ <check />::
   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.
 \\
@@ -130 +130 @@
   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.
  icon="iconname"::
-  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 [wikitr:/Styles#Iconhandling Icon handling] how icons can be specified.
+  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 [wikitr:/Styles#Iconhandling Icon handling] how icons can be specified.
  icon_size="a number"::
-  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>`).
+  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>`).
  key="some_key"::
   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.
  text="Any text"::
-  The description, that will be displayed before (after in case of `<check>`) the gui element. Also used for `<label>` and `<optional>`.
+  The description, that will be displayed before (after in case of `<check />`) the gui element. Also used for `<label>` and `<optional>`.
  text_context="context"::
   Translation context for text attribute to separate equals words with different meaning (not required for in-file translations).
  default="default_value"::
   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''.
-  If no value for default is specified, no value is set to the key. Used in `<check>`, `<text>`, `<combo>` and `<multiselect>`.
+  If no value for default is specified, no value is set to the key. Used in `<check />`, `<text />`, `<combo />` and `<multiselect />`.
  values="entry1,entry2,entry3"::
-  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.
+  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.
  values_from="JAVA code"::
   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".
  values_no_i18n="true|false"::
-  Disables internationalisation for value to avoid mistakes, see #11696. Default is `"false"`. Used in `<combo>` and `<multiselect>`. (Useful e.g. for opening hours or brand names.)
+  Disables internationalisation for value to avoid mistakes, see #11696. Default is `"false"`. Used in `<combo />` and `<multiselect />`. (Useful e.g. for opening hours or brand names.)
  values_sort="false"::
-  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"`.\\
+  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"`.\\
  Users can globally disable sorting with the preference key `taggingpreset.sortvalues`.
  values_context="context"::
   Translation context for values attribute to separate equals words with different meaning (not required for in-file translations).
  display_values="Entry1,Entry2,Entry3"::
-  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>`.
+  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 />`.
  value="foobar"::
   Specify a value to be entered in the `<key>` tag.
  value_on="foobar"::
-  Specify the true value to be entered in the `<key>` tag of a checked `<check>` (default is `"yes"`).
+  Specify the true value to be entered in the `<key>` tag of a checked `<check />` (default is `"yes"`).
  value_off="foobar"::
-  Specify the false value to be entered in the `<key>` tag of a unchecked `<check>` (default is `"no"`).
+  Specify the false value to be entered in the `<key>` tag of a unchecked `<check />` (default is `"no"`).
  disable_off="true"::
-  Whether the off value of a `<check>` is disabled in the dialog, i.e., only unset or `"yes"` are provided.
+  Whether the off value of a `<check />` is disabled in the dialog, i.e., only unset or `"yes"` are provided.
  editable="false"::
   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**.
  use_last_as_default="true|false|force"::
-  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"`.
+  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"`.
  rows="count"::
-  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).
+  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).
  name_template="template", name_template_filter="search expression"::
   Custom name formatter for osm primitives matching this preset. See below [[#name_templatedetails]] for details.
@@ -178 +178 @@
   * `keyvalue`: positive if key and value matches, neutral otherwise
   * `keyvalue!`: positive if key and value matches, negative otherwise \\
- **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>`.
+ **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 />`.
  id="unique_identifier"::
   the unique identifier for this `<chunk>`
@@ -184 +184 @@
   the unique identifier of the (already defined) template to include
  columns="a number"::
-  the number of columns of grouped `<check>`
+  the number of columns of grouped `<check />`
  requisite="optional|required"::
   If a relation member is optional or required. Default is `"optional"`.
@@ -198 +198 @@
   Whether to insert "[preset name]" label in dialog (defaults to `"false"` for backward-compatibility on external presets).
  length="a number"::
-  The length of a `<text>` or `<combo>` box (number of characters allowed).
+  The length of a `<text />` or `<combo />` box (number of characters allowed).
  alternative_autocomplete_keys="some_key(s)"::
   A comma separated list of alternative keys to use for auto completion of `<text>`.
  auto_increment="-2,-1,+1,+2"::
-  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`.
+  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`.
  delimiter="special character"::
-  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].
+  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].
  [=#short_description]
  short_descriptions="Entry1,Entry2,Entry3"::
   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: `<list_entry value="" display_value="" short_description="" icon="" icon_size="" />`
  values_searchable="true|false"::
-  Whether to search in `<combo>` or `<multiselect>` `(display_)values` when searching for presets.
+  Whether to search in `<combo />` or `<multiselect />` `(display_)values` when searching for presets.
 \\