tiramisu/doc/glossary.txt

.. default-role:: literal

glossary
==========

.. _configuration:

**configuration**

    Global configuration object, wich contains the whole configuration 
    options *and* their descriptions (option types and group)

.. _`option description`:
.. _`schema`:

**schema**:
**option description**

    see :api:`option.OptionDescription`, see :ref:`optionapi#schema`

    The schema of a configuration : 
    
    - the option types

    - how they are organised in groups or even subgroups, that's why we 
      call them **groups** too.

.. _`configoption`:

**configuration option**

    An option object wich has a name and a value and can be accessed 
    from the configuration object

.. _`defaultvalue`:

**default value**

    Default value of a configuration option. The default value can be 
    set at instanciation time, or even at any moment. Remember that if 
    you reset the default value, the owner reset to `default`

.. _`rules`:

**acces rules**
    
    Access rules are : :api:`config.Config.cfgimpl_read_write()` or 
    :api:`config.Config.cfgimpl_read_only()`, see :doc:`status` 

**freeze**

    A whole configuration can be frozen (used in read only access). See 
    :ref:`status#frozenconfig` for details.

    A single option can be frozen too.

**forced on freeze**

    A single option is frozen and we want the option to return something 
    else than his value, typically his default value, see 
    :ref:`status#frozen`

.. _`valueowner`: 

**value owner** 
    
    When an option is modified, including at the instanciation, we 
    always know who has modified it. It's the owner of the option, see 
    :doc:`status` for more details.

**option with properties**
 
    an option wich has property like 'hidden' or 'disabled' is an option
    wich has restricted acces rules

**hidden option**

    a hidden option has a different behaviour on regards to the access 
    of the value in the configuration, see :doc:`status` for more details.

**disabled option**

    a disabled option has a different behaviour on regards to the access 
    of the value in the configuration, see :doc:`status` for more details.

.. _mandatory:

**mandatory option**

    A mandatory option is a configuration option wich value has to be 
    set, that is the default value cannot be `None`, see 
    :ref:`optionapi#optioninit`
    
.. _consistency:

**consistency**

    Preserve the consistency in a whole configuration is a tricky thing,
    tiramisu takes care of it for you, see :doc:`consistency` for details.