docs(abstract): tables
This commit is contained in:
parent
fc480ef248
commit
4fb075b451
1 changed files with 63 additions and 37 deletions
|
|
@ -98,11 +98,16 @@ Here are some output examples:
|
||||||
- documentation
|
- documentation
|
||||||
- custom table views
|
- custom table views
|
||||||
|
|
||||||
Here is a reminder of the different steps:
|
.. list-table::
|
||||||
|
:header-rows: 1
|
||||||
|
|
||||||
- Structured data
|
* - Step
|
||||||
- User data
|
|
||||||
- Output
|
* - Structured data
|
||||||
|
|
||||||
|
* - User data
|
||||||
|
|
||||||
|
* - Output
|
||||||
|
|
||||||
What kind of actor?
|
What kind of actor?
|
||||||
---------------------
|
---------------------
|
||||||
|
|
@ -118,7 +123,7 @@ Choice your own actor name if you wish to personnalize in your specific context.
|
||||||
|
|
||||||
integrator
|
integrator
|
||||||
|
|
||||||
An integrator in the Rougail field is the person who writes the :term:`structure files <structure file>`\ .
|
An integrator in the Rougail field is the person who writes the :term:`structured <structured data>`\ .
|
||||||
He has the responsibility of the integration process, that is,
|
He has the responsibility of the integration process, that is,
|
||||||
he defines the variables and the relationship between them, the variables that are allowed
|
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**
|
(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 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 <structure file>`.
|
The type validation is driven by the definitions in the :term:`structure file <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::
|
.. list-table::
|
||||||
:widths: 15 35 50
|
|
||||||
:header-rows: 1
|
:header-rows: 1
|
||||||
|
|
||||||
* - Step
|
* - Step
|
||||||
- Actor
|
- Actor
|
||||||
- Description
|
|
||||||
|
|
||||||
* - Structured data
|
* - Structured data
|
||||||
- Integrator
|
- Integrator
|
||||||
- The actor who defines the structure
|
|
||||||
|
|
||||||
* - User data
|
* - User data
|
||||||
- Operator
|
- Operator
|
||||||
- The actor who sets the values
|
|
||||||
|
|
||||||
* - Output
|
* - Output
|
||||||
- Operator or integrator
|
- - Operator
|
||||||
- The actor who uses the variables with their values
|
- Integrator
|
||||||
|
|
||||||
Variable lifetime
|
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):
|
The lifecycle of a variable includes the generic stages (like, in the Python language):
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 25 25 25 25
|
|
||||||
:header-rows: 1
|
:header-rows: 1
|
||||||
|
|
||||||
* - Creation
|
* - 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:
|
But other concepts are included in the lifecycle:
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 15 35 50
|
|
||||||
:header-rows: 1
|
:header-rows: 1
|
||||||
|
|
||||||
* - Permission
|
* - Permission
|
||||||
|
|
@ -198,7 +203,6 @@ But other concepts are included in the lifecycle:
|
||||||
|
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 15 35 50
|
|
||||||
:header-rows: 1
|
:header-rows: 1
|
||||||
|
|
||||||
* - Step
|
* - Step
|
||||||
|
|
@ -211,11 +215,16 @@ But other concepts are included in the lifecycle:
|
||||||
|
|
||||||
* - User data
|
* - User data
|
||||||
- Operator
|
- Operator
|
||||||
- Assignment and permission
|
- - Assignment
|
||||||
|
- Permission
|
||||||
|
|
||||||
* - Output
|
* - Output
|
||||||
- Operator or integrator
|
- - Operator
|
||||||
- Reading, permission, documentation and specialization
|
- Integrator
|
||||||
|
- - Reading
|
||||||
|
- Permission
|
||||||
|
- Documentation
|
||||||
|
- Specialization
|
||||||
|
|
||||||
Variable mutability
|
Variable mutability
|
||||||
---------------------
|
---------------------
|
||||||
|
|
@ -241,27 +250,32 @@ Output
|
||||||
Variable definition settings are immutable.
|
Variable definition settings are immutable.
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 25 25 25 25
|
|
||||||
:header-rows: 1
|
:header-rows: 1
|
||||||
|
|
||||||
* - Step
|
* - Step
|
||||||
- Actor
|
- Actor
|
||||||
- Lifetime
|
- Lifetime
|
||||||
- Variable mutability
|
- Mutability
|
||||||
|
|
||||||
* - Structured data
|
* - Structured data
|
||||||
- Integrator
|
- Integrator
|
||||||
- Creation + initialization
|
- - Creation
|
||||||
|
- initialization
|
||||||
- Mutable
|
- Mutable
|
||||||
|
|
||||||
* - User data
|
* - User data
|
||||||
- Operator
|
- Operator
|
||||||
- Assignment and permission
|
- - Assignment
|
||||||
|
- Permission
|
||||||
- Immutable
|
- Immutable
|
||||||
|
|
||||||
* - Output
|
* - Output
|
||||||
- Operator or integrator
|
- - Operator
|
||||||
- Reading, permission, documentation and specialization
|
- Integrator
|
||||||
|
- - Reading
|
||||||
|
- Permission
|
||||||
|
- Documentation
|
||||||
|
- Specialization
|
||||||
- Immutable
|
- Immutable
|
||||||
|
|
||||||
Value access
|
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.
|
In this case, the value does indeed correspond to the result of the calculation.
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 20 20 20 20 20
|
|
||||||
:header-rows: 1
|
:header-rows: 1
|
||||||
|
|
||||||
* - Step
|
* - Step
|
||||||
- Actor
|
- Actor
|
||||||
- Lifetime
|
- Lifetime
|
||||||
- Variable mutability
|
- Mutability
|
||||||
- Value
|
- Value
|
||||||
|
|
||||||
* - Structured data
|
* - Structured data
|
||||||
- Integrator
|
- Integrator
|
||||||
- Creation + initialization
|
- - Creation
|
||||||
|
- initialization
|
||||||
- Mutable
|
- Mutable
|
||||||
- Mutable default value
|
- Mutable default value
|
||||||
|
|
||||||
* - User data
|
* - User data
|
||||||
- Operator
|
- Operator
|
||||||
- Assignment and permission
|
- - Assignment
|
||||||
|
- Permission
|
||||||
- Immutable
|
- Immutable
|
||||||
- Read write
|
- Read write
|
||||||
|
|
||||||
* - Output
|
* - Output
|
||||||
- Operator or integrator
|
- - Operator
|
||||||
- Reading, permission, documentation and specialization
|
- Integrator
|
||||||
|
- - Reading
|
||||||
|
- Permission
|
||||||
|
- Documentation
|
||||||
|
- Specialization
|
||||||
- Immutable
|
- Immutable
|
||||||
- Read only
|
- 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.
|
This property is generally used dynamically to remove access to the variable depending on the context.
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 20 20 20 20 20 20
|
|
||||||
:header-rows: 1
|
:header-rows: 1
|
||||||
|
|
||||||
* - Step
|
* - Step
|
||||||
- Actor
|
- Actor
|
||||||
- Lifetime
|
- Lifetime
|
||||||
- Variable mutability
|
- Mutability
|
||||||
- Value
|
- Value
|
||||||
- Access control
|
- Access control
|
||||||
|
|
||||||
* - Structured data
|
* - Structured data
|
||||||
- Integrator
|
- Integrator
|
||||||
- Creation + initialization
|
- - Creation
|
||||||
|
- initialization
|
||||||
- Mutable
|
- Mutable
|
||||||
- Mutable default value
|
- Mutable default value
|
||||||
- N/A
|
- N/A
|
||||||
|
|
||||||
* - User data
|
* - User data
|
||||||
- Operator
|
- Operator
|
||||||
- Assignment and permission
|
- - Assignment
|
||||||
|
- Permission
|
||||||
- Immutable
|
- Immutable
|
||||||
- Read write
|
- Read write
|
||||||
- hidden + disabled
|
- - hidden
|
||||||
|
- disabled
|
||||||
|
|
||||||
* - Output
|
* - Output
|
||||||
- Operator or integrator
|
- - Operator
|
||||||
- Reading, permission, documentation and specialization
|
- Integrator
|
||||||
|
- - Reading
|
||||||
|
- Permission
|
||||||
|
- Documentation
|
||||||
|
- Specialization
|
||||||
- Immutable
|
- Immutable
|
||||||
- Read only
|
- Read only
|
||||||
- disabled + mandatory
|
- - disabled
|
||||||
|
- mandatory
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue