Changes between Version 88 and Version 89 of TaggingPresets

Timestamp:

2014-11-06T00:25:16+01:00 (11 years ago)

Author:

Klumbumbus

Comment:

joined "check"

TaggingPresets

@@ -96 +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.
  '''<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'', ''required'', ''value_on'' , ''value_off'' and ''disable_off'' are optional.
 ==== Templates ====
  '''<chunk>'''::
@@ -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).
+   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").
  '''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.
@@ -132 +132 @@
    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. 
@@ -233 +235 @@
   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
-
 }}}