rename FileOption to FilenameOption
[tiramisu.git] / doc / glossary.txt
1 .. default-role:: literal
2
3 Glossary
4 ==========
5
6 .. glossary::
7
8     configuration
9
10         Global configuration object, wich contains the whole configuration
11         options *and* their descriptions (option types and group)
12
13     schema
14     option description
15
16         see :class:`tiramisu.option.OptionDescription`
17
18         The schema of a configuration :
19
20         - the option types
21
22         - how they are organised in groups or even subgroups, that's why we
23           call them **groups** too.
24
25     configuration option
26
27         An option object wich has a name and a value and can be accessed
28         from the configuration object
29
30     access rules
31
32         Global access rules are : :meth:`~config.CommonConfig.read_write()` or
33         :meth:`~config.Config.read_only()`, see :doc:`status`
34
35     default value
36
37         Default value of a configuration option. The default value can be
38         set at instanciation time, or even at any moment. Remember that if
39         you reset the default value, the owner reset to `default`
40
41     freeze
42
43         A whole configuration can be frozen (used in read only access). See
44         :ref:`frozen` for details.
45
46         A single option can be frozen too.
47
48     value owner
49
50         When an option is modified, including at the instanciation, we
51         always know who has modified it. It's the owner of the option, see
52         :doc:`status` for more details.
53
54     option with properties
55
56         an option wich has property like 'hidden' or 'disabled' is an option
57         wich has restricted acces rules
58
59     hidden option
60
61         a hidden option has a different behaviour on regards to the access
62         of the value in the configuration, see :doc:`status` for more details.
63
64     disabled option
65
66         a disabled option has a different behaviour on regards to the access
67         of the value in the configuration, see :doc:`status` for more details.
68
69     mandatory option
70
71         A mandatory option is a configuration option wich value has to be
72         set, that is the default value cannot be `None`.
73
74     consistency
75
76         Preserving the consistency in a whole configuration is a tricky thing,
77         tiramisu takes care of it for you, see :doc:`consistency` for details.
78
79     context
80     
81         The context is a :class:`tiramisu.setting.Setting()` object in the 
82         configuration that enables us to access to the global properties
83         
84         for example the `read_write` or `read_only` :term:`access rules`
85
86