diff --git a/docs/concepts.rst b/docs/concepts.rst index f832c905a..8605286c8 100644 --- a/docs/concepts.rst +++ b/docs/concepts.rst @@ -98,11 +98,16 @@ Here are some output examples: - documentation - custom table views -Here is a reminder of the different steps: +.. list-table:: + :header-rows: 1 -- Structured data -- User data -- Output + * - Step + + * - Structured data + + * - User data + + * - Output What kind of actor? --------------------- @@ -118,7 +123,7 @@ Choice your own actor name if you wish to personnalize in your specific context. integrator - An integrator in the Rougail field is the person who writes the :term:`structure files `\ . + An integrator in the Rougail field is the person who writes the :term:`structured `\ . He has the responsibility of the integration process, that is, he defines the variables and the relationship between them, the variables that are allowed (or not) to be set, and so on. His responsabilites are the **structuration** and the **consistency** @@ -134,25 +139,27 @@ Choice your own actor name if you wish to personnalize in your specific context. The user :term:`value`\ s, that is the values that have been set by the operator, are of course type validated. The type validation is driven by the definitions in the :term:`structure file `. +Here is a reminder of the different steps: + +- the integrator defines the structure +- the operator sets the value +- the integrator and/or the operator use the output + .. list-table:: - :widths: 15 35 50 :header-rows: 1 * - Step - Actor - - Description * - Structured data - Integrator - - The actor who defines the structure * - User data - Operator - - The actor who sets the values * - Output - - Operator or integrator - - The actor who uses the variables with their values + - - Operator + - Integrator Variable lifetime ---------------------- @@ -169,7 +176,6 @@ The variable’s lifetime is the period between its creation and its destruction The lifecycle of a variable includes the generic stages (like, in the Python language): .. list-table:: - :widths: 25 25 25 25 :header-rows: 1 * - Creation @@ -185,7 +191,6 @@ The lifecycle of a variable includes the generic stages (like, in the Python lan But other concepts are included in the lifecycle: .. list-table:: - :widths: 15 35 50 :header-rows: 1 * - Permission @@ -198,7 +203,6 @@ But other concepts are included in the lifecycle: .. list-table:: - :widths: 15 35 50 :header-rows: 1 * - Step @@ -211,11 +215,16 @@ But other concepts are included in the lifecycle: * - User data - Operator - - Assignment and permission + - - Assignment + - Permission * - Output - - Operator or integrator - - Reading, permission, documentation and specialization + - - Operator + - Integrator + - - Reading + - Permission + - Documentation + - Specialization Variable mutability --------------------- @@ -241,27 +250,32 @@ Output Variable definition settings are immutable. .. list-table:: - :widths: 25 25 25 25 :header-rows: 1 * - Step - Actor - Lifetime - - Variable mutability + - Mutability * - Structured data - Integrator - - Creation + initialization + - - Creation + - initialization - Mutable * - User data - Operator - - Assignment and permission + - - Assignment + - Permission - Immutable * - Output - - Operator or integrator - - Reading, permission, documentation and specialization + - - Operator + - Integrator + - - Reading + - Permission + - Documentation + - Specialization - Immutable Value access @@ -283,30 +297,35 @@ The configuration is said to be in :term:`read only mode`. In this case, the value does indeed correspond to the result of the calculation. .. list-table:: - :widths: 20 20 20 20 20 :header-rows: 1 * - Step - Actor - Lifetime - - Variable mutability + - Mutability - Value * - Structured data - Integrator - - Creation + initialization + - - Creation + - initialization - Mutable - Mutable default value * - User data - Operator - - Assignment and permission + - - Assignment + - Permission - Immutable - Read write * - Output - - Operator or integrator - - Reading, permission, documentation and specialization + - - Operator + - Integrator + - - Reading + - Permission + - Documentation + - Specialization - Immutable - Read only @@ -346,33 +365,40 @@ A `disabled` variable is a variable that will not be accessible to any of the ac This property is generally used dynamically to remove access to the variable depending on the context. .. list-table:: - :widths: 20 20 20 20 20 20 :header-rows: 1 * - Step - Actor - Lifetime - - Variable mutability + - Mutability - Value - Access control * - Structured data - Integrator - - Creation + initialization + - - Creation + - initialization - Mutable - Mutable default value - N/A * - User data - Operator - - Assignment and permission + - - Assignment + - Permission - Immutable - Read write - - hidden + disabled + - - hidden + - disabled * - Output - - Operator or integrator - - Reading, permission, documentation and specialization + - - Operator + - Integrator + - - Reading + - Permission + - Documentation + - Specialization - Immutable - Read only - - disabled + mandatory + - - disabled + - mandatory