The Desc File
This document gives an informal description of the FinalCOnfig desc file format as implemented by FinalConfig version 0.2. See also the example file (test/test.xml) provided within the FinalConfig download.
The desc file is a XML based file, with the root element finalconfig-desc,
which contains section elements, which contain other sections and entries.
Section
The section element does not have any attirbues. The only elements allowed within a section are:- section
- title
- entry
Entries
- Optional attributes and elements are printed in italic.
- Elements marked with a * can be used more than once within the entry.
| Entry Type | Attributes | Elements | Version | Purpose |
|---|---|---|---|---|
| group | type | title, entry* | 0.1 | grouping of entries |
| bool | type, id | title, hint, value | 0.1 | a true/false option |
| string | type, id | title, hint, value | 0.1 | any kind of text |
| numeric | type, id, exact | title, hint, value, min, max, digits | 0.1 | a numeric value; either integer or float |
| list | type, id | title, hint, value, entry* *1 | 0.1 | a list of options, of which exactly one is selected |
| liststring | type | title, hint, handle | 0.1 | an entry within a list |
| file | type, id, directory | title, hint, value, filter* | 0.2 | a file name |
| font | type, id | title, hint, value | 0.2 | a font (value consists of the font name followed by the size, separated by a space) |
| colour (or color) | type, id, alpha | title, hint, value | 0.2 | a colour with on optional alpha channel (value consists of the colour value plus a space separated alpha value, if the entry uses an alpha channel) |
Footnotes:
*1 Entries of type list may only contain entries of type liststring.
Attributes and Elements
| Attribute | Defaults to | Description |
|---|---|---|
| type | - | type as listed in the Entry Types table |
| id | - | ID by which the entry is listed in the config file |
| exact | false | true: User must be able to set the numeric value of this entry exactly |
| directory | false | true: Limit file selection dialogue to directories |
| alpha | false | true: Colour has an alpha channel |
| Element | Defaults to | Description |
|---|---|---|
| section | - | a collection of entries and sub-sections |
| entry | - | a node in the entry tree |
| title | no title or "<no title>" | a label or title |
| hint | no hint | additional description (in FinalConfig displayed as Tooltip |
| value | - | default value |
| min | - | lowest allowed value for a numerical entry |
| max | - | highest allowed value for a numerical entry |
| digits | "0" | number of decimal digits |
| handle | - | handle which identifies a liststring within a list |
| filter | - | file filter; may contain title, pattern and mime-type elements |
| pattern | - | a shell style glob pattern; should not be used togather with a mine-type in the same filter; multiple patterns within a filter are or'ed togather |
| mime-type | - | a mime-type; should not be used togather with a pattern in the same filter; multiple mime-types within a filter are or'ed togather |