diff --git a/docs/family.rst b/docs/family.rst index 91429a8ad..37074399c 100644 --- a/docs/family.rst +++ b/docs/family.rst @@ -72,7 +72,7 @@ Parameters - `family` (**default value**) - `dynamic` - - `leadership` + - `sequence` * - **hidden**, **_hidden** @@ -225,10 +225,10 @@ This will dynamically create two families: You can have a look at the tutorial with a real world sample :doc:`dynamically built family ` -Similar object sequence -------------------------- +Sequence of homogeneous elements +--------------------------------------- -A family with `type` set to `leadership` is a sequence of similar object. +A family with `type` set to `sequence` is a sequence of homogeneous elements. Let's start the explanation with a concrete example: @@ -240,7 +240,7 @@ Let's start the explanation with a concrete example: accounts: description: All accounts - type: leadership + type: sequence login: description: Account login @@ -262,13 +262,13 @@ What is expected, it's something like: - login: bar secret: NotGoodSecret -It's what we call a sequence of similar object. +It's what we call a Sequence of homogeneous elements. .. attention:: A sequence cannot contain other families. .. seealso:: - You can have a look at the tutorial with a real world sample :doc:`similar object sequence ` + You can have a look at the tutorial with a real world sample :doc:`Sequence of homogeneous elements ` A custom type family ---------------------- diff --git a/docs/images/foxyproxy.png b/docs/images/foxyproxy.png new file mode 100644 index 000000000..418dad01d Binary files /dev/null and b/docs/images/foxyproxy.png differ diff --git a/docs/index.rst b/docs/index.rst index 17f2c3c5f..063ed18c9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,6 @@ Rougail .. todo:: définir les termes suivants: - 1 check.rst:9: WARNING: term not in glossary: 'validator' 2 check.rst:56: WARNING: term not in glossary: 'follower' 4 family.rst:25: WARNING: label non défini: 'convention on variable names' 5 structfile.rst:89: WARNING: term not in glossary: 'variable_namespace' @@ -20,14 +19,12 @@ Rougail 9 variable.rst:38: WARNING: label non défini: 'convention on variable names' 10 variable.rst:137: WARNING: term not in glossary: 'leading' 11 variable.rst:154: WARNING: term not in glossary: 'required' - 12 variable.rst:156: WARNING: term not in glossary: 'leader' 13 variable.rst:156: WARNING: term not in glossary: 'follower' .. todo:: créer les documents suivants: 1 rougail/docs/family.rst:102: WARNING: unknown document: 'tutorial/mode' - 2 rougail/docs/family.rst:273: WARNING: unknown document: 'tutorial/sequence' 3 rougail/docs/structfile.rst:89: WARNING: term not in glossary: 'variable_namespace' 4 rougail/docs/variable.rst:163: WARNING: unknown document: 'tutorial/mode' 5 rougail/docs/variable.rst:235: WARNING: unknown document: 'tutorial/validators' diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst index bed815fdc..378463dcd 100644 --- a/docs/tutorial/index.rst +++ b/docs/tutorial/index.rst @@ -62,5 +62,7 @@ Let's dive into this **configuration options validation** use case. examples practice1 validators + namespace + sequence underscore_parameter whatsnext diff --git a/docs/tutorial/namespace.rst b/docs/tutorial/namespace.rst new file mode 100644 index 000000000..e80f147c0 --- /dev/null +++ b/docs/tutorial/namespace.rst @@ -0,0 +1,52 @@ +Namespaces +============ + +.. objectives:: Objectives + + In this section we are going to evolve our use case. + We're going to use a Firefox add-on called Foxy Proxy. + +.. prerequisites:: Prerequisites + + - We assume that Rougail's library is :ref:`installed ` on your computer. + + - It is possible to retrieve the current state of the various Rougail files manipulated in this tutorial step + by checking out the corresponding tag of the `rougail-tutorials` git repository. + Each tag corresponds to a stage of progress in the tutorial. + Of course, you can also decide to copy/paste or download the tutorial files contents while following the tutorial steps. + + If you want to follow this tutorial with the help of the corresponding :tutorial:`rougail-tutorials git repository `, + this workshop page corresponds to the tags :tutorial:`1.1_180 ` to :tutorial:`1.1_181 ` + in the repository. + + :: + + git clone https://forge.cloud.silique.fr/stove/rougail-tutorials.git + git switch --detach 1.1_180 + +Namespace +----------- + +The purpose here is not to teach you how to use the Foxy Proxy addon, +but rather to explain that using this Firefox plugin will require us +to make decisions about how to organize our variables. + +We will store them in namespaces. + +Variables related to the Foxy Proxy plugin will be stored in a separate namespace. + +New "FoxyProxy" namespace +---------------------------- + +.. type-along:: For those who follow the tutorial with the help of the git repository + + Now you need to checkout the :tutorial:`1.1_181 ` version:: + + git switch --detach 1.1_181 + + + +.. image:: images/foxyproxy.png + + + diff --git a/docs/tutorial/sequence.rst b/docs/tutorial/sequence.rst new file mode 100644 index 000000000..1961d2a73 --- /dev/null +++ b/docs/tutorial/sequence.rst @@ -0,0 +1,33 @@ +Homogeneous elements sequence +================================== + +.. objectives:: Objectives + + We are going to discuss a new Rougail type, the sequence of homogeneous elements. + +.. prerequisites:: Prerequisites + + - We assume that Rougail's library is :ref:`installed ` on your computer. + + - It is possible to retrieve the current state of the various Rougail files manipulated in this tutorial step + by checking out the corresponding tag of the `rougail-tutorials` git repository. + Each tag corresponds to a stage of progress in the tutorial. + Of course, you can also decide to copy/paste or download the tutorial files contents while following the tutorial steps. + + If you want to follow this tutorial with the help of the corresponding :tutorial:`rougail-tutorials git repository `, + this workshop page corresponds to the tag :tutorial:`1.1_190 ` + in the repository. + + :: + + git clone https://forge.cloud.silique.fr/stove/rougail-tutorials.git + git switch --detach 1.1_190 + +A family with sequence of homogeneous elements type +-------------------------------------------------------- + +FIXME + + + +