Context Navigation

Changes between Version 13 and Version 14 of De:TaggingPresets

Timestamp:: 2014-11-07T17:20:40+01:00 (10 years ago)
Author:: Klumbumbus
Comment:: update to rev 100

Legend:

: Unmodified
: Added
: Removed
: Modified

De:TaggingPresets

-              v13
+              v14
 [[TranslatedPages(revision=87,outdated=Die Syntax der Objektvorlagen wurde geändert und die Kopie des XML-Dokuments muss mit der Wikidokumentation zusammengeführt werden. Wenn dies geschehen ist müssen die Änderungen hier übernommen werden und schließlich dieser Teil noch übersetzt werden. Außerdem sollte das Beispiel geändert werden weil es für OSM ungewöhnliche Schlüssel-Wert-Kombinationen nutzt und Straßen normalerweise NICHT Einbahnstraßen sind.)]]
+[[TranslatedPages(revision=100,outdated=Muss teilweise noch übersetzt werden. Außerdem sollte das Beispiel geändert werden weil es für OSM ungewöhnliche Schlüssel-Wert-Kombinationen nutzt und Straßen normalerweise NICHT Einbahnstraßen sind.)]]
 [[PageOutline(2-10,Inhaltsverzeichnis)]]
 = Objektvorlagen =
 …
 }}}
+== XML Format Beschreibung (nicht aktuell!) ==#XML
+== XML Format Beschreibung ==#XML
 === Tags ===
 ==== The document prolog ====
 …
    * '''link''' (i18n) - web link to further details (optional)
    * '''icon''' - informational icon for the whole preset. (This is nedded to display the icon in the table at [[Presets]].)
 (i18n) means the values may also be localized (e.g. de.link).
+(i18n) means the values may also be localized (e.g. de.description).
 ==== Comments ====
  '''<!-- this is an example comment -->'''::
 …
    Used to group items in sub menus. ''name'' is required, ''icon'' is optional attribute.
  '''<item>'''::
    Every item is one annotation set to select from. ''name'' is required, ''type'' is recommended, ''icon'' is optional attribute.
+   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/>'''::
    Insert a line separator into the menu.
 …
 ==== Attribute entry and selection dialog boxes ====
  '''<text>'''::
    A text edit field to enter any arbitrary string from the user. ''key'' is mandatory, ''text'', ''default'', ''match'' and ''required'' is optional
+   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>'''::
    Displays a multiple choice combo box. ''key'' and ''values'' are mandatory and ''text'', ''default'', ''editable'', ''match'' and ''required'' is optional.
+   Displays a multiple choice combo box. ''key'' and ''values'' are mandatory, ''text'', ''default'', ''editable'', ''delimiter'', ''values_from'', ''display_values'', ''schort_descriptions'', ''use_last_as_default'', ''values_searchable'', ''length'' 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.
  '''<multiselect>'''::
+   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.
+   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.
+ '''<list_entry>'''::
+   Used in <combo> and <multiselect>. More information see ''short_descriptions''. The attributes are ''value'', ''display_value'', ''short_description'', ''icon'' and ''icon_size''.
  '''<check>'''::
    A checkbox which the user can only select or deselect. The ''key'' attribute is mandatory. ''text'', ''default'', ''match'' and ''required'' is optional.
+   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.
 ==== Templates ====
  '''<chunk>'''::
 …
    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.
  '''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. The icon should be quadratic in size. See [[Styles#Iconhandling]] 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 [[Styles#Iconhandling]] 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>.
+   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.
 …
    Translation context for text attribute to separate equals words with different meaning (not required for in-file translations).
  '''default="default_value"'''::
+   The default value for the item. If not specified, the current value of the key is chosen as default (if applicable).
+   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 "".
  '''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_context="context"'''::
    Translation context for name 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 of entries as values and '''editable''' must be false or not specified. For the delimiter character and escaping, see the remarks at ''values''.
+   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 (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 (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.
  '''editable="false"'''::
+   The combo box is readonly, which means that the user can only select an item in the list.
+ '''use_last_as_default="true"'''::
    For combo boxes or text fields the last value is used as default. Using "force" enforces this behaviour also for already tagged objects.
+   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.
+ '''use_last_as_default="true|false|force"'''::
+   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".
  '''rows="count"'''::
    Specify the number of rows in multiselect entry.
+   Specify the number of rows to display in <multiselect> entry (default -1).
  '''name_template="template", name_template_filter="search expression"'''::
    Custom name formatter for osm primitives matching this preset. See [[NameTemplate]] for details.
 …
  '''preset_name="exact_name"'''::
    The exact name of the preset to link to.
+== Format description from XML document (needs to be joined with above texts) ==
+ (delete here the parts which you have joined with above texts)
+{{{
+item:
+  name: the text to display
+  icon: the icon to display
+  - relative to the icon path
+  - URL's are also supported to allow remote icons (are cached locally)
+  type: the data types - way,node,relation,closedway (separated by comma)
+  name_template: define custom formatting for OSM primitives
+                 see [[NameTemplate]]
+  preset_name_label: whether to insert "[preset name]" label in dialog
+                     (defaults to "false" for backward-compatibility on external presets)
+text: text box
+  key: key to set
+  text: fixed label to display
+  default: default string to display (defaults to "")
+  use_last_as_default: true/false/force (default is "false")
+  auto_increment: 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. default is no auto-increment;
+                  mutually exclusive with use_last_as_default.
+  length: length of input box (number of characters allowed)
+  alternative_autocomplete_keys: comma separated list of alternative keys to use for autocompletion
+combo: combo box, with multiple choices and possible to enter free form text
+  key: key to set
+  text: fixed label to display
+  delimiter: character that separates values (default: comma)
+  values: separated list of values
+  values_from: 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"
+  display_values: comma separated list of values to be displayed instead of the
+                  database values, order and number must be equal to values
+  short_descriptions: comma 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="" />
+        icon: location of icon
+        icon_size: maximal size of icon. If tag is not setup it is taken default size of icon file
+  default: default string to display (defaults to "")
+  use_last_as_default: true/false/force (default is "false")
+  editable: allow to add other values as text (default is "true")
+  values_searchable: true/false (whether to search in combo (display_)values when searching for presets)
+  length: length of input box (number of characters allowed)
+multiselect: list of values from which zero or more can be selected
+  key: key to set
+  text: fixed label to display
+  delimiter: character that separates values (default: semicolon) - this
+             will also be used to separate selected values in the tag.
+  values: delimiter-separated list of values (delimiter can be escaped with backslash)
+  values_from: 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"
+  rows: specify the number of rows to display (default -1)
+  display_values: delimiter-separated list of values to be displayed instead of the
+                  database values, order and number must be equal to values
+  short_descriptions: 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 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="" />
+        icon: location of icon
+        icon_size: maximal size of icon. If tag is not setup it is taken default size of icon file
+  default: default string to display (defaults to "")
+  use_last_as_default: true/false/force (default is "false")
+  values_searchable: true/false (whether to search in multiselect (display_)values when searching for presets)
+check: checkbox
+  key: key to set
+  text: fixed label to display
+  default: ticked on/off (default is "off")
+  value_on: the value to set when checked (default is "yes")
+  value_off: the value to set when unchecked (default is "no")
+  disable_off: whether the off value is disabled in the dialog, i.e., only unset or yes are provided
+}}}
+ '''preset_name_label="false|true"'''::
+   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).
+ '''alternative_autocomplete_keys="some_key(s)"'''::
+   A comma separated list of alternative keys to use for autocompletion 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''.
+ '''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>.
+ '''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 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="" />
+ '''values_searchable="true|false"'''::
+   Whether to search in <combo> or <multiselect> (display_)values when searching for presets.
 == Translation ==