stove/rougail
3
0
Fork 0
Code Issues 5 Pull requests 1 Projects Releases Wiki Activity

doc(rename)

Browse source
This commit is contained in:
egarette@silique.fr 2026-06-14 09:41:53 +02:00
parent 200a05f942
commit a71a68a02a
2 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/tutorial/underscore_parameter.rst
View file

@ -23,19 +23,19 @@ Name and parameter conflict
Of course, you can also decide to copy/paste or download the tutorial files contents while following the tutorial steps. 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>`, 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:`v1.1_210 <src/tag/v1.1_210/README.md>` this workshop page corresponds to the tag :tutorial:`v1.1_220 <src/tag/v1.1_220/README.md>`
in the repository. in the repository.
:: ::
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_210 git switch --detach v1.1_220
.. type-along:: Let's recap how far we've come .. type-along:: Let's recap how far we've come
We have this homogeneous elements type family in its structure definition file: We have this homogeneous elements type family in its structure definition file:
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_202/foxyproxy/00-foxyproxy.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_210/foxyproxy/00-foxyproxy.yml
:linenos: :linenos:
:language: yaml :language: yaml
:caption: The `proxies` family with `sequence` type in the :file:`foxyproxy/00-foxyproxy.yml` structure file :caption: The `proxies` family with `sequence` type in the :file:`foxyproxy/00-foxyproxy.yml` structure file
@ -56,7 +56,7 @@ So the best way it to rename the `type` parameter to `_type`
Let's create a family named `manual` which obviously corresponds to the proxy's manual configuration choice. Let's create a family named `manual` which obviously corresponds to the proxy's manual configuration choice.
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_210/foxyproxy/00-foxyproxy.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_220/foxyproxy/00-foxyproxy.yml
:language: yaml :language: yaml
:caption: The `proxies` family with `sequence` type and a variable with the name `type` in the :file:`foxyproxy/00-foxyproxy.yml` structure file :caption: The `proxies` family with `sequence` type and a variable with the name `type` in the :file:`foxyproxy/00-foxyproxy.yml` structure file

22
docs/tutorial/variable_propertyerror.rst
View file

@ -15,12 +15,12 @@ Variable calculation with propertyerror
Of course, you can also decide to copy/paste or download the tutorial files contents while following the tutorial steps. 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>`, 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:`v1.1_220 <src/tag/v1.1_220/README.md>` in the repository: this workshop page corresponds to the tag :tutorial:`v1.1_230 <src/tag/v1.1_230/README.md>` in the repository:
:: ::
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_220 git switch --detach v1.1_230
We have now to add three new variables: We have now to add three new variables:
@ -41,7 +41,7 @@ This property allows you to disable errors in case of :ref:`access problems <acc
Let's start by modifying the structure file: Let's start by modifying the structure file:
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_220/foxyproxy/00-foxyproxy.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_230/foxyproxy/00-foxyproxy.yml
:language: yaml :language: yaml
:caption: The :file:`foxyproxy/00-foxyproxy.yml` :caption: The :file:`foxyproxy/00-foxyproxy.yml`
@ -53,7 +53,7 @@ Don't just take my word for it, let's do a test.
Now let's test with the following user data file: Now let's test with the following user data file:
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_220/config/02/config.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_230/config/02/config.yml
:linenos: :linenos:
:language: yaml :language: yaml
:caption: The :file:`config/02/config.yml` user data :caption: The :file:`config/02/config.yml` user data
@ -66,14 +66,14 @@ If we launch the Rougail CLI:
.. raw:: html .. raw:: html
:class: terminal :class: terminal
:url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_220/config/02/cmd_ro.txt :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_230/config/02/cmd_ro.txt
We have this output: We have this output:
.. raw:: html .. raw:: html
:class: output :class: output
:url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_220/config/02/output_ro.html :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_230/config/02/output_ro.html
As expected, calculating the default value works without issue even though the variables involved in the calculations are inaccessible. As expected, calculating the default value works without issue even though the variables involved in the calculations are inaccessible.
@ -83,17 +83,17 @@ Now try it in the :term:`read write mode` with the Rougail CLI:
.. raw:: html .. raw:: html
:class: terminal :class: terminal
:url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_220/config/02/cmd_rw.txt :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_230/config/02/cmd_rw.txt
The variables has really the value `null`: The variables has really the value `null`:
.. raw:: html .. raw:: html
:class: output :class: output
:url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_220/config/02/output_rw.html :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_230/config/02/output_rw.html
Now let's configure the variables in the Firefox :ref:`namespace <tutorial_namespace>`: Now let's configure the variables in the Firefox :ref:`namespace <tutorial_namespace>`:
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_220/config/04/config.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_230/config/04/config.yml
:linenos: :linenos:
:language: yaml :language: yaml
:caption: The :file:`config/04/config.yml` user data :caption: The :file:`config/04/config.yml` user data
@ -104,13 +104,13 @@ If we launch the Rougail CLI:
.. raw:: html .. raw:: html
:class: terminal :class: terminal
:url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_220/config/04/cmd_ro.txt :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_230/config/04/cmd_ro.txt
We have this output: We have this output:
.. raw:: html .. raw:: html
:class: output :class: output
:url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_220/config/04/output_ro.html :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_230/config/04/output_ro.html
As expected, the Firefox :ref:`namespace <tutorial_namespace>` values are correctly copied into the FoxyProxy :ref:`namespace <tutorial_namespace>`. As expected, the Firefox :ref:`namespace <tutorial_namespace>` values are correctly copied into the FoxyProxy :ref:`namespace <tutorial_namespace>`.