Changes between Version 93 and Version 94 of TaggingPresets

Timestamp:

2014-11-07T15:48:27+01:00 (11 years ago)

Author:

Klumbumbus

Comment:

joined "combo"

TaggingPresets

@@ -90 +90 @@
    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'' and ''match'' 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.
@@ -114 +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.
  '''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>.
  '''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.
@@ -122 +122 @@
    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). In case of <check> whether the checkbox is ticked on or off by default (default is "off"). In case of <text> defaults to "".
+   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> and <combo> 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.
+ '''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''.
  '''value="foobar"'''::
    Specify a value to be entered in the <key> tag.
@@ -138 +140 @@
    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. 
+   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 boxes or text fields the last value is used as default. Using "force" enforces this behaviour also for already tagged objects. Default is "false".
+   For <combo> boxes 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.
@@ -170 +172 @@
    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> 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 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>: default: comma)
+ '''short_descriptions=""Entry1,Entry2,Entry3"'''::
+   A 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="" />
+ '''values_searchable="true|false"'''::
+   Whether to search in <combo> (display_)values when searching for presets.
+
+
 
 == Format description from XML document (needs to be joined with above texts) ==
@@ -180 +190 @@
 
 {{{
-
-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