Changes between Version 105 and Version 106 of TaggingPresets
- Timestamp:
- 2014-11-13T23:20:08+01:00 (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TaggingPresets
v105 v106 60 60 ==== Menu creation ==== 61 61 <group>:: 62 Used to group items in sub menus. ''name''is required,''icon''is optional attribute.62 Used to group items in sub menus. `name` is required, `icon` is optional attribute. 63 63 <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.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 65 <separator/>:: 66 66 Insert a line separator into the menu. … … 68 68 ==== Preset window layout ==== 69 69 <label>:: 70 Labels are static texts for display. ''text''is a required attribute,''icon'' and ''icon_size''are optional.70 Labels are static texts for display. `text` is a required attribute, `icon` and `icon_size` are optional. 71 71 <space />:: 72 72 Add some space (ie a newline). 73 73 <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 />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 /> 75 75 <item_separator />:: 76 76 Add a horizontal separator line between items. 77 77 <link>:: 78 Specify a web link for this feature or to anything else of use. The ''href''attribute is required.78 Specify a web link for this feature or to anything else of use. The `href` attribute is required. 79 79 <checkgroup>:: 80 To group checks. The ''columns''attribute is required.80 To group checks. The `columns` attribute is required. 81 81 <roles>:: 82 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 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.84 To specify possible roles of members in relations. The `key` attribute is required, `text`, `requisite`, `count`, `type` and `member_expression` are optional. 85 85 <preset_link>:: 86 Adds a link to an other preset. The ''preset_name''attribute is required.86 Adds a link to an other preset. The `preset_name` attribute is required. 87 87 [[BR]] 88 88 ==== Set a fixed key value pair ==== 89 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.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 91 [[BR]] 92 92 ==== Attribute entry and selection dialog boxes ==== 93 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 optional94 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 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.\\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 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 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.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 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''.101 Used in <combo> and <multiselect>. More information see `short_descriptions`. The attributes are `value`, `display_value`, `short_description`, `icon` and `icon_size`. 102 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.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 104 [[BR]] 105 105 ==== Templates ==== 106 106 <chunk>:: 107 To define a template of elements for later (repeated) use. The ''id''attribute is mandatory.107 To define a template of elements for later (repeated) use. The `id` attribute is mandatory. 108 108 <reference>:: 109 To include an earlier defined template. The ''ref''attribute is mandatory.109 To include an earlier defined template. The `ref` attribute is mandatory. 110 110 [[BR]] 111 111 === Attributes === … … 136 136 Translation context for name attribute to separate equals words with different meaning (not required for in-file translations). 137 137 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 false or not specified. For the delimiter character and escaping, see the remarks at''values''. Used in <combo> and <multiselect>.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 false or not specified. For the delimiter character and escaping, see the remarks at `values`. Used in <combo> and <multiselect>. 139 139 value="foobar":: 140 140 Specify a value to be entered in the <key> tag. … … 183 183 A comma separated list of alternative keys to use for autocompletion of <text>. 184 184 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''.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`. 186 186 delimiter="special character":: 187 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 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="" />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="" /> 190 190 values_searchable="true|false":: 191 191 Whether to search in <combo> or <multiselect> (display_)values when searching for presets.
