Commit f10bd140 authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Polish the events section of the documentation.

parent d4d3a2e3
......@@ -27,11 +27,11 @@ a JSON_ string.
The structure of the dictionary, *the properties*, are defined by the user,
once, for each event type. The structure of the dictionary can be modified at
any time by the user.
any time.
Mechanisms are in placed to guaranty the consistency between
the ``events.data`` and ``history.data`` fields when properties are added,
renamed or destroyed. This is a powerful tool, however there is few
renamed or destroyed. This is a powerful tool, however there are few
limitations:
* The properties should only contains the characters ``[A-Za-z0_9_]``.
......@@ -95,7 +95,9 @@ In order to create a new event definition:
5. Enter the the model.
Add the first property by right clicking on ``property``, ``type`` or
``default`` label. Later on, others properties can be ``Add``,
``Modify`` or ``Delete`` using the contextual menu.
``Modify`` or ``Delete`` using the contextual menu. Mechanisms are in
place to preserve the consistency between the ``events.data`` and
``history.data`` when a property is added, renamed or deleted.
.. warning::
Modifying the definition of the user block is a tricky operation
......@@ -103,20 +105,16 @@ In order to create a new event definition:
has to be preserved, as well as between the ``events.data`` and
the report configurations.
.. warning::
Mechanisms are in place to preserve the consistency between the
``events.data`` and ``history.data`` when a property is added,
renamed or deleted.
.. warning::
The consistency is not preserved between the ``events.data`` and the
report configurations. Each configuration has to be checked when
property are destroyed or renamed.
.. warning::
The consistency is not preserved when the property type is changed.
Each entry of the history table, associated to the event, has to be
checked.
The consistency is not preserved when the *property type* is
changed. Each entry of the history table, associated to
the event, has to be checked. The data conversion is effective once
the user edit the property value.
Enter an event in the history
......@@ -148,12 +146,22 @@ contains three tabs:
*category*, *funding* and *percentage* allocated for the people.
``Event``
the event type, the time period and the user data block.
the *event type*, the *time period* or the *date* and the *user data
block*.
.. note::
The *starting date* and the *ending date* have to be equal when
the event happen at a fixed date.
.. note::
The *starting date* as well as the *ending date* can be empty.
Its means that the event start a long time ago or that the event
is not yet finished.
``Note``
single input for comments
Make report on events
----------------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment