docs(structured-data): proofreading 2
This commit is contained in:
parent
c50ce5bcc5
commit
383c485c7a
2 changed files with 14 additions and 16 deletions
|
|
@ -164,8 +164,8 @@ The variable path
|
||||||
Normal family
|
Normal family
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
The default namespace is defined in RougailConfig["variable_namespace"] with the default value "rougail".
|
The default namespace is defined in `RougailConfig["variable_namespace"]` with the default value `rougail`.
|
||||||
In addition, there are extras namespaces defined with in RougailConfig["extra_dictionaries"].
|
In addition, there are extras namespaces defined with in `RougailConfig["extra_dictionaries"]`.
|
||||||
|
|
||||||
Inside those namespaces we can add families and variables.
|
Inside those namespaces we can add families and variables.
|
||||||
|
|
||||||
|
|
@ -188,14 +188,14 @@ Here is an hierarchic examples:
|
||||||
|
|
||||||
In `calculation` we can use other variables.
|
In `calculation` we can use other variables.
|
||||||
|
|
||||||
Here is all paths:
|
Here are all paths:
|
||||||
|
|
||||||
- rougail.variable1
|
- `rougail.variable1`
|
||||||
- rougail.family1.variable2
|
- `rougail.family1.variable2`
|
||||||
- rougail.family1.variable3
|
- `rougail.family1.variable3`
|
||||||
- rougail.family2.subfamily1.variable4
|
- `rougail.family2.subfamily1.variable4`
|
||||||
- extra1.family3.variable5
|
- `extra1.family3.variable5`
|
||||||
- extra1.family3.variable6
|
- `extra1.family3.variable6`
|
||||||
|
|
||||||
Inside a variable's `calculation` we can use relative path. "_" means that other variable is in same family. "__" means that other variables are in parent family, and so on...
|
Inside a variable's `calculation` we can use relative path. "_" means that other variable is in same family. "__" means that other variables are in parent family, and so on...
|
||||||
|
|
||||||
|
|
@ -210,7 +210,7 @@ But we cannot access to extra1 variables with relative path.
|
||||||
Dynamic family
|
Dynamic family
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Hire is a dynamic family "{{ suffix }}":
|
Here is a `{{ suffix }}` dynamic family:
|
||||||
|
|
||||||
.. code-block::
|
.. code-block::
|
||||||
|
|
||||||
|
|
@ -222,7 +222,7 @@ Hire is a dynamic family "{{ suffix }}":
|
||||||
└── family
|
└── family
|
||||||
└── variable4
|
└── variable4
|
||||||
|
|
||||||
For variable2's calculation, we can use:
|
For `variable2`'s calculation, we can use:
|
||||||
|
|
||||||
- `rougail.{{ suffix }}.variable3`
|
- `rougail.{{ suffix }}.variable3`
|
||||||
- `_.variable3`
|
- `_.variable3`
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ Synopsis
|
||||||
|
|
||||||
A value is a variable's setting.
|
A value is a variable's setting.
|
||||||
Variable can have a default value, that is a setting defined in the :term:`structure file`,
|
Variable can have a default value, that is a setting defined in the :term:`structure file`,
|
||||||
or no value at all, then the value needs to be define later by the :term:`operator`.
|
or no value at all, then the value needs to be defined later by the :term:`operator`.
|
||||||
|
|
||||||
.. discussion:: Discussion
|
.. discussion:: Discussion
|
||||||
|
|
||||||
|
|
@ -252,8 +252,6 @@ Parameters
|
||||||
|
|
||||||
This means that the variable will no longer be visible to the user but also to a :term:`calculation`.
|
This means that the variable will no longer be visible to the user but also to a :term:`calculation`.
|
||||||
|
|
||||||
**Default value**: `false`.
|
|
||||||
|
|
||||||
**Default value**: `false`
|
**Default value**: `false`
|
||||||
|
|
||||||
.. seealso:: tutorial with a real world sample :doc:`disabled parameter <../tutorial/properties>` (the tutorial focuses on family, but the principle is the same for a variable)
|
.. seealso:: tutorial with a real world sample :doc:`disabled parameter <../tutorial/properties>` (the tutorial focuses on family, but the principle is the same for a variable)
|
||||||
|
|
@ -342,7 +340,7 @@ Or a multi default value:
|
||||||
...
|
...
|
||||||
|
|
||||||
By default, the description of the variable is the variable name.
|
By default, the description of the variable is the variable name.
|
||||||
It's a best practice to description a variable. Just add comment in same line of name, this comment is use as description:
|
It's a good practice to describe a variable. Just add comment in same line of name, this comment is used as description:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
|
@ -432,7 +430,7 @@ Specialized type
|
||||||
''''''''''''''''''
|
''''''''''''''''''
|
||||||
|
|
||||||
.. list-table::
|
.. list-table::
|
||||||
:widths: 15 25 20 15
|
:widths: 5 45 45 5
|
||||||
:header-rows: 1
|
:header-rows: 1
|
||||||
|
|
||||||
* - Value
|
* - Value
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue