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

add link to the rougail-tuto repo

Browse source
This commit is contained in:
gwen 2025-11-05 15:16:45 +01:00
parent e511f07932
commit 7f4efef0be
1 changed files with 20 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
docs/tutorial/index.rst
View file

@ -20,28 +20,35 @@ We'll call the variables **configuration options** since that's what the variabl
.. attention:: We are not coding a firefox plugin here. .. attention:: We are not coding a firefox plugin here.
We are just going to handle some of the firefox configuration settings We are just going to handle some of the firefox configuration settings
with Rougail. with Rougail. We are just validating them.
The configuration option values entered by the user have to be:
- validated
- consitent
- conform
Let's dive into this **configuration options validation** use case. Let's dive into this **configuration options validation** use case.
Presentation of the firefox option configuration variables Presentation of the firefox configuration options
----------------------------------------------------------- --------------------------------------------------
The values entered by the user have to be At first glance we can see that we have a selection of five configuration options that we need to fill in, they are highlighted here in this screenshot:
- validated
- consitent
- conformity
.. todo:: explain the congruent term. or another term? compliance ? accordance ? conformity ?
At first glance we can see that we have a selection of five configuration options values that we need to fill in, they are highlighted here in this screenshot:
.. image:: images/firefox_01.png .. image:: images/firefox_01.png
We'll learn in this tutorial how to set the values of the configuration options in a clean way with the Rougail library.
.. prerequisites:: Important advice
It is advisable to follow this tutorial with the help of the corresponding :tutorial:`Rougail git repository tutorial <>`.
If you use this rougail tutorial repository, you will have all the necessary files distributed in the correct tree structure.
Of course, you can also decide to start from scratch and copy/paste the tutorial files content.
.. toctree:: .. toctree::
:titlesonly: :titlesonly:
:caption: The firefox tutorial steps :caption: The firefox tutorial
preliminary preliminary
proxymode proxymode
@ -50,7 +57,3 @@ At first glance we can see that we have a selection of five configuration option
dynfam dynfam
calculation calculation
.. prerequisites:: Prerequisites
It is advisable to :tutorial:`Clone the tutorial Git repository <>` corresponding to this getting starting workshop.