docs(namespace-sequence): begining of these two sections
This commit is contained in:
parent
4fb075b451
commit
9dfdf908f0
6 changed files with 94 additions and 10 deletions
|
|
@ -72,7 +72,7 @@ Parameters
|
||||||
|
|
||||||
- `family` (**default value**)
|
- `family` (**default value**)
|
||||||
- `dynamic`
|
- `dynamic`
|
||||||
- `leadership`
|
- `sequence`
|
||||||
|
|
||||||
* - **hidden**, **_hidden**
|
* - **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 <tutorial/dynfam>`
|
You can have a look at the tutorial with a real world sample :doc:`dynamically built family <tutorial/dynfam>`
|
||||||
|
|
||||||
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:
|
Let's start the explanation with a concrete example:
|
||||||
|
|
||||||
|
|
@ -240,7 +240,7 @@ Let's start the explanation with a concrete example:
|
||||||
|
|
||||||
accounts:
|
accounts:
|
||||||
description: All accounts
|
description: All accounts
|
||||||
type: leadership
|
type: sequence
|
||||||
|
|
||||||
login:
|
login:
|
||||||
description: Account login
|
description: Account login
|
||||||
|
|
@ -262,13 +262,13 @@ What is expected, it's something like:
|
||||||
- login: bar
|
- login: bar
|
||||||
secret: NotGoodSecret
|
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.
|
.. attention:: A sequence cannot contain other families.
|
||||||
|
|
||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
You can have a look at the tutorial with a real world sample :doc:`similar object sequence <tutorial/sequence>`
|
You can have a look at the tutorial with a real world sample :doc:`Sequence of homogeneous elements <tutorial/sequence>`
|
||||||
|
|
||||||
A custom type family
|
A custom type family
|
||||||
----------------------
|
----------------------
|
||||||
|
|
|
||||||
BIN
docs/images/foxyproxy.png
Normal file
BIN
docs/images/foxyproxy.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 154 KiB |
|
|
@ -10,7 +10,6 @@ Rougail
|
||||||
|
|
||||||
.. todo:: définir les termes suivants:
|
.. 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'
|
2 check.rst:56: WARNING: term not in glossary: 'follower'
|
||||||
4 family.rst:25: WARNING: label non défini: 'convention on variable names'
|
4 family.rst:25: WARNING: label non défini: 'convention on variable names'
|
||||||
5 structfile.rst:89: WARNING: term not in glossary: 'variable_namespace'
|
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'
|
9 variable.rst:38: WARNING: label non défini: 'convention on variable names'
|
||||||
10 variable.rst:137: WARNING: term not in glossary: 'leading'
|
10 variable.rst:137: WARNING: term not in glossary: 'leading'
|
||||||
11 variable.rst:154: WARNING: term not in glossary: 'required'
|
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'
|
13 variable.rst:156: WARNING: term not in glossary: 'follower'
|
||||||
|
|
||||||
|
|
||||||
.. todo:: créer les documents suivants:
|
.. todo:: créer les documents suivants:
|
||||||
|
|
||||||
1 rougail/docs/family.rst:102: WARNING: unknown document: 'tutorial/mode'
|
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'
|
3 rougail/docs/structfile.rst:89: WARNING: term not in glossary: 'variable_namespace'
|
||||||
4 rougail/docs/variable.rst:163: WARNING: unknown document: 'tutorial/mode'
|
4 rougail/docs/variable.rst:163: WARNING: unknown document: 'tutorial/mode'
|
||||||
5 rougail/docs/variable.rst:235: WARNING: unknown document: 'tutorial/validators'
|
5 rougail/docs/variable.rst:235: WARNING: unknown document: 'tutorial/validators'
|
||||||
|
|
|
||||||
|
|
@ -62,5 +62,7 @@ Let's dive into this **configuration options validation** use case.
|
||||||
examples
|
examples
|
||||||
practice1
|
practice1
|
||||||
validators
|
validators
|
||||||
|
namespace
|
||||||
|
sequence
|
||||||
underscore_parameter
|
underscore_parameter
|
||||||
whatsnext
|
whatsnext
|
||||||
|
|
|
||||||
52
docs/tutorial/namespace.rst
Normal file
52
docs/tutorial/namespace.rst
Normal file
|
|
@ -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 <installation>` 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 <src/branch/1.1>`,
|
||||||
|
this workshop page corresponds to the tags :tutorial:`1.1_180 <src/tag/1.1_180/README.md>` to :tutorial:`1.1_181 <src/tag/1.1_181/README.md>`
|
||||||
|
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 <src/tag/1.1_181/README.md>` version::
|
||||||
|
|
||||||
|
git switch --detach 1.1_181
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
.. image:: images/foxyproxy.png
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
33
docs/tutorial/sequence.rst
Normal file
33
docs/tutorial/sequence.rst
Normal file
|
|
@ -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 <installation>` 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 <src/branch/1.1>`,
|
||||||
|
this workshop page corresponds to the tag :tutorial:`1.1_190 <src/tag/1.1_190/README.md>`
|
||||||
|
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
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Loading…
Reference in a new issue