Kexi/Configuration: Difference between revisions

Newer edit →

Revision as of 21:35, 27 November 2011

Configuration

Configuration requirements define entities of the program(s) that are configurable.

Levels of configuration

Three can be at least three levels of configuration defined:

Application level (per user)
- Defaults come from Application defaults
Project level
- Defaults come from Application defaults and project template defaults
User Project level
- Defaults come from Project's defaults defined for users

Certain settings can be present at more than one level. Inheritance can occur then.

Requirements

Requirement 1: good defaults for settings, ie. expected, easy to remeber by user, typical.
Requirement 2: each setting should have assigned level(s) where it belongs to; settings should have described inheritance if it is present
Requirement 3: settings should be versioned
Requirement 4: Harmonization with Calligra and KDE settings: typical settings should be harmonized regarding defaults and naming with identical settings in other Calligra and KDE software.

Status

Kexi settings are currently (up to 2.4) accessible via kexirc configuration file. No GUI is available.

Formal documentation

Current settings are documented in the source code tree, kexi/doc/dev/settings.txt. There is advantage of having formal notation for settings documentation: they can be used for automatic generation of

handbook page(s)
manual page(s)
--help messages
What's this and Tool tips in the GUI

All this with less maintenance overhead. Thus it is reasonable to keep the documentation of settings in the version control system.

@@ Line 1: / Line 1: @@
 ==Configuration==
 Configuration requirements define entities of the program(s) that are configurable.
-Requirements: good defaults, ie. expected, easy to remeber by user, typical.
+===Levels of configuration===
+Three can be at least three levels of configuration defined:
+*Application level (per user)
+**Defaults come from Application defaults
+*Project level
+**Defaults come from Application defaults and project template defaults
+*User Project level
+**Defaults come from Project's defaults defined for users
+Certain settings can be present at more than one level. Inheritance can occur then.
+===Requirements===
+*Requirement 1: good defaults for settings, ie. expected, easy to remeber by user, typical.
+*Requirement 2: each setting should have assigned level(s) where it belongs to; settings should have described inheritance if it is present
+*Requirement 3: settings should be versioned
+*Requirement 4: Harmonization with Calligra and KDE settings: typical settings should be harmonized regarding defaults and naming with identical settings in other Calligra and KDE software.
+===Status===
 Kexi settings are currently (up to 2.4) accessible via kexirc configuration file. No GUI is available.
-Formal documentation. Current settings are documented in the source code tree, kexi/doc/dev/settings.txt. There is advantage of having formal notation for settings documentation: they can be used for automatic generation of the handbook page(s), manual page(s), --help messages, What's this and Tool tips in the GUI. All this with less maintenance overhead. So it makes sense to keep the documentation of settings in the version control system.
+===Formal documentation===
+Current settings are documented in the source code tree, kexi/doc/dev/settings.txt. There is advantage of having formal notation for settings documentation: they can be used for automatic generation of
+*handbook page(s)
+*manual page(s)
+*--help messages
+*What's this and Tool tips in the GUI
+All this with less maintenance overhead. Thus it is reasonable to keep the documentation of settings in the version control system.