Classes for management of all options used in the application and its plugins.
All options are described in options.xml under the appdata directory
and in plugin.xml under the root directory in the plugin directory for each plugin.
The options.xml file have following format:
<options> <optiongroup groupname="%groupname"> <option type="%type" name="%optionname" flag="%flag" default="%default" usage="%usage"> <desc>%desc</desc> <shortdesc>%shortdesc</shortdesc> <legalvalue name="%legalvaluename" class="%class">%legalvaluedesc</legalvalue> </option> ... </optiongroup> ... </options>
One or many optiongroup elements are enclosed by the options. The optiongroup element
enclose one or more option. Each option contains at least two description elements: desc and shortdesc.
The attributes used by the optiongroup element and the options element are descibed below:
| Attribute | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| groupname | The name of the option group that categorize a group of options. | ||||||||||||||
| name | The name of the option | ||||||||||||||
| type |
There are following option types:
| ||||||||||||||
| flag | A short version option indicator. | ||||||||||||||
| default | If there is a default value it is specified by this attribute. | ||||||||||||||
| usage |
Indicates the usage of the option:
|
An option of one the types: enum, stringenum and class, should at least contain one legalvalue
element. Common for the three types is that they should contain an identifier specified by the name attribute and a short description of the
legal value. For the stringenum type there should also be a mapto element that specifies what the identifier should be mapped to.
The class type should contain a class attribute that specifies what class should be loaded.
All options are described in a short version and a long version. The option value can be specified in different ways (see the user guide: Controlling MaltParser.