fix:
This commit is contained in:
parent
be4162d603
commit
eb569a8705
8 changed files with 19 additions and 29 deletions
|
|
@ -1,3 +1,5 @@
|
||||||
|
.. _family:
|
||||||
|
|
||||||
The families
|
The families
|
||||||
=============
|
=============
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -74,7 +74,7 @@ There are two types of params:
|
||||||
|
|
||||||
- parameter via a variable
|
- parameter via a variable
|
||||||
- parameter via an information
|
- parameter via an information
|
||||||
- parameter via an identifier: in a :ref:`dynamically built family` returns the current identifier
|
- parameter via an identifier: in a :ref:`dynamically built family <dynamically_built_family>` returns the current identifier
|
||||||
- parameter via an index: in the case of a :term:`follower` variable returns the current index
|
- parameter via an index: in the case of a :term:`follower` variable returns the current index
|
||||||
- parameter via :ref:`the current namespace name <namespace>`
|
- parameter via :ref:`the current namespace name <namespace>`
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -95,7 +95,7 @@ Parameters
|
||||||
- if the variable is not in a family, the variable will have a medium mode by default
|
- if the variable is not in a family, the variable will have a medium mode by default
|
||||||
- a :term:`mandatory` variable without default value (calculate or not) will have the smaller mode
|
- a :term:`mandatory` variable without default value (calculate or not) will have the smaller mode
|
||||||
|
|
||||||
.. seealso:: tutorial with a real world sample :doc:`mode parameter <../tutorial/mode>`
|
.. seealso:: tutorial with a real world sample :doc:`mode parameter <../tutorial/modes>`
|
||||||
|
|
||||||
* - **tags**
|
* - **tags**
|
||||||
|
|
||||||
|
|
@ -195,7 +195,7 @@ Parameters
|
||||||
|
|
||||||
**Default value**: `false`
|
**Default value**: `false`
|
||||||
|
|
||||||
.. seealso:: tutorial with a real world sample :doc:`auto_save parameter <../tutorial/autosave>`
|
.. seealso:: tutorial with a real world sample :doc:`auto_save parameter <../tutorial/auto_save>`
|
||||||
|
|
||||||
* - **mandatory**
|
* - **mandatory**
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -98,7 +98,7 @@ By default there is no namespace.
|
||||||
The default namespace
|
The default namespace
|
||||||
~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
The families and variables contained in these structure files are ordered, by default, in the `rougail` namespace. It is possible to change the name of this namespace with the :term:`variable namespace <variable_namespace>` parameter of the :doc:`configuration <configuration>`.
|
The families and variables contained in these structure files are ordered, by default, in the `rougail` namespace. It is possible to change the name of this namespace with the :term:`variable namespace <namespace>` parameter of the :ref:`configuration <configuration>`.
|
||||||
|
|
||||||
This namespace (the default namespace) is a bit special, it can access variables in another namespace.
|
This namespace (the default namespace) is a bit special, it can access variables in another namespace.
|
||||||
|
|
||||||
|
|
@ -107,7 +107,7 @@ The extra structure files
|
||||||
|
|
||||||
An extra is a different namespace. The idea is to be able to classify the variables by theme.
|
An extra is a different namespace. The idea is to be able to classify the variables by theme.
|
||||||
|
|
||||||
Extra namespaces must be declared :doc:`when configuring Rougail <configuration>`.
|
Extra namespaces must be declared :ref:`when configuring Rougail <configuration>`.
|
||||||
|
|
||||||
In this namespace we cannot access variables from another `extra` namespace.
|
In this namespace we cannot access variables from another `extra` namespace.
|
||||||
On the other hand, it is possible to access the variable of the default namespace.
|
On the other hand, it is possible to access the variable of the default namespace.
|
||||||
|
|
|
||||||
|
|
@ -51,7 +51,7 @@ Rougail accepts the following standard types:
|
||||||
|
|
||||||
.. FIXME: est-ce que integer et float -> number type ????
|
.. FIXME: est-ce que integer et float -> number type ????
|
||||||
|
|
||||||
.. seealso:: :doc:`the variable documentation <variable>`
|
.. seealso:: :ref:`the variable documentation <variable>`
|
||||||
|
|
||||||
Specialized types
|
Specialized types
|
||||||
~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~
|
||||||
|
|
@ -65,7 +65,7 @@ But we will also find a whole series of specialized types:
|
||||||
- secret
|
- secret
|
||||||
- ...
|
- ...
|
||||||
|
|
||||||
.. seealso:: :doc:`the variable documentation <variable>`
|
.. seealso:: :ref:`the variable documentation <variable>`
|
||||||
|
|
||||||
A variable with a list of possible values
|
A variable with a list of possible values
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
@ -79,7 +79,7 @@ Type parameters
|
||||||
|
|
||||||
For certain types, there are a number of parameters that can be used to further type the variables.
|
For certain types, there are a number of parameters that can be used to further type the variables.
|
||||||
|
|
||||||
.. seealso:: :doc:`the variable documentation <variable>`
|
.. seealso:: :ref:`the variable documentation <variable>`
|
||||||
|
|
||||||
.. _nullable_variable:
|
.. _nullable_variable:
|
||||||
|
|
||||||
|
|
@ -143,7 +143,7 @@ It is a container designed to hold variables.
|
||||||
The whole :term:`configuration` tree structure is handled by the families definitions.
|
The whole :term:`configuration` tree structure is handled by the families definitions.
|
||||||
It is possible to create subfamilies.
|
It is possible to create subfamilies.
|
||||||
|
|
||||||
.. seealso:: :doc:`the family documentation <family>`
|
.. seealso:: :ref:`the family documentation <family>`
|
||||||
|
|
||||||
.. _dynamically_built_family:
|
.. _dynamically_built_family:
|
||||||
|
|
||||||
|
|
@ -160,7 +160,7 @@ A dynamically built family is a special family.
|
||||||
|
|
||||||
This means that families will appear or disappear folling the :term:`context`.
|
This means that families will appear or disappear folling the :term:`context`.
|
||||||
|
|
||||||
.. seealso:: :doc:`the dynamically built family documentation <family>`
|
.. seealso:: :ref:`the dynamically built family documentation <dynamically_built_family>`
|
||||||
|
|
||||||
Homogeneous elements sequence
|
Homogeneous elements sequence
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,6 @@
|
||||||
Properties
|
Properties
|
||||||
==========
|
==========
|
||||||
|
|
||||||
.. FIXME: duplicate from tutorial/properties.rst
|
|
||||||
|
|
||||||
Access control is achieved through `properties`.
|
Access control is achieved through `properties`.
|
||||||
|
|
||||||
.. glossary::
|
.. glossary::
|
||||||
|
|
@ -10,7 +8,7 @@ Access control is achieved through `properties`.
|
||||||
property
|
property
|
||||||
|
|
||||||
A property is a state (`disabled`, `mandatory`, `frozen`, `hidden`...)
|
A property is a state (`disabled`, `mandatory`, `frozen`, `hidden`...)
|
||||||
of a family or a variable.
|
of a family, a subfamily or a variable.
|
||||||
These properties change the usual behavior of a variable or family.
|
These properties change the usual behavior of a variable or family.
|
||||||
|
|
||||||
The properties can be defined permanently or according to the result of a calculation.
|
The properties can be defined permanently or according to the result of a calculation.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,5 @@
|
||||||
|
.. _tutorial_namespace:
|
||||||
|
|
||||||
Namespaces
|
Namespaces
|
||||||
============
|
============
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,16 +4,16 @@ Define access to variable or family
|
||||||
.. objectives:: Objectives
|
.. objectives:: Objectives
|
||||||
|
|
||||||
In this section we will see what a disabled variable or family is, and why it can be interesting
|
In this section we will see what a disabled variable or family is, and why it can be interesting
|
||||||
to assign the `disabled` property to a variable or a family.
|
to assign the `disabled` :term:`property` to a variable or a family.
|
||||||
Then we'll see the same thing for the `hidden` property.
|
Then we'll see the same thing for the `hidden` :term:`property`.
|
||||||
We'll also learn the difference between disabling and hiding families or variables.
|
We'll also learn the difference between disabling and hiding families or variables.
|
||||||
|
|
||||||
We will:
|
We will:
|
||||||
|
|
||||||
- create a `disabled` family
|
- create a `disabled` family
|
||||||
- use a new family or variable's property: the `hidden` property
|
- use a new family or variable's :term:`property`: the `hidden` :term:`property`
|
||||||
|
|
||||||
Disabling and hiding are two families or variables properties.
|
Disabling and hiding are two families or variables :term:`properties <property>`.
|
||||||
|
|
||||||
.. prerequisites:: Prerequisites
|
.. prerequisites:: Prerequisites
|
||||||
|
|
||||||
|
|
@ -33,18 +33,6 @@ Disabling and hiding are two families or variables properties.
|
||||||
git clone https://forge.cloud.silique.fr/stove/rougail-tutorials.git
|
git clone https://forge.cloud.silique.fr/stove/rougail-tutorials.git
|
||||||
git switch --detach v1.1_050
|
git switch --detach v1.1_050
|
||||||
|
|
||||||
.. type-along:: What a property is
|
|
||||||
|
|
||||||
Let's begin with defining what a property is:
|
|
||||||
|
|
||||||
.. glossary::
|
|
||||||
|
|
||||||
property
|
|
||||||
|
|
||||||
A property is a state (`disabled`, `mandatory`, `frozen`, `hidden`...)
|
|
||||||
of a family, a subfamily or a variable.
|
|
||||||
These properties change the usual behavior of a variable or family.
|
|
||||||
|
|
||||||
.. _tutorial_disabled:
|
.. _tutorial_disabled:
|
||||||
|
|
||||||
A disabled family
|
A disabled family
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue