disabled/hidden

This commit is contained in:
gwen 2025-05-26 22:09:29 +02:00
parent 284a176a0a
commit e49f731aa2
5 changed files with 85 additions and 7 deletions

View file

@ -12,7 +12,7 @@ You can use the python installer and type the install command in your preferred
pip install rougail pip install rougail
a better way to install the Rougail library in to do this in a virtual environment: Another way to install the Rougail library in install it in a virtual environment:
.. code-block:: text .. code-block:: text
@ -30,6 +30,12 @@ or, under windows:
.venv\Scripts\activate.exe .venv\Scripts\activate.exe
Then again:
.. code-block:: text
pip install rougail
What is a consistency handling system ? What is a consistency handling system ?
------------------------------------------------ ------------------------------------------------

View file

@ -6,6 +6,8 @@ A new variable which has the `boolean` type
In this section we will learn: In this section we will learn:
- how to make a boolean type variable - how to make a boolean type variable
- how to reuse some value of a variable
(in this use case we will reuse the HTTP configuration variables values for the HTTPS configuration)
.. prerequisites:: Reminders .. prerequisites:: Reminders
@ -63,7 +65,25 @@ Now we will focus on configuring the HTTPS mode in case of "Manual proxy configu
.. image:: images/firefox_manual_https.png .. image:: images/firefox_manual_https.png
Let's set two other variables for the HTTPS use only:
.. confval:: https_proxy.address
:type: `domainname`
This is an address setting for the manual HTTPS configuration
.. confval:: https_proxy.port
:type: `port`
This is a port setting for the manual HTTPS configuration
- So we have a `manual.http_proxy.address` variable and a `manual.https_proxy.address` variable
- In the same way, we have a `manual.http_proxy.port` variable and a `manual.https_proxy.port` variable
.. type-along:: What do we want to reuse?
Do we want to reuse, for the HTTPS mode, the same configuration as for the HTTP mode? Do we want to reuse, for the HTTPS mode, the same configuration as for the HTTP mode?
It depends on the situation.
A new `boolean` type variable A new `boolean` type variable
------------------------------- -------------------------------
@ -91,3 +111,47 @@ Its description in the structure file gives us this:
type: boolean type: boolean
default: true default: true
.. type-along:: Update on the situation
So now we have three new variables in the manual mode of the http proxy configuration.
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_032/firefox/20-manual.yml
:language: yaml
:caption: firefox/20-manual.yml
..
---
manual:
use_for_https:
description: Also use this proxy for HTTPS
default: true
https_proxy:
description: HTTPS Proxy
address:
description: HTTPS address
type: domainname
params:
allow_ip: true
port:
description: HTTPS Port
type: port
default: 8080
And with this :confval:`use_for_https` boolean variable, there are two possibilities, and only two:
- The http proxy's configuration will be reused for the https proxy's configuration
- The http proxy's will not be reused for the https proxy's configuration
.. questions:: Question: disabled?
Is it relevant to use the :term:`disabled property <disabled>` here?
..
How can we tell Rougail that this :confval:`use_for_https` boolean variable is used to enable/disable
the use of variables from the entire family?

View file

@ -24,9 +24,17 @@ A family can disapear in the outerspace
of a family, a subfamily or a variable. These properties may vary of a family, a subfamily or a variable. These properties may vary
depending on the context. depending on the context.
A disabled family A disabled family
----------------------- -----------------------
.. glossary::
disabled
The disabled property is a property of a variable or a family that is kind of deactivated
for the whole configuration.
Let's come back to our use case, we have a choice between five options Let's come back to our use case, we have a choice between five options
in order to set the proxy mode: in order to set the proxy mode:

View file

@ -11,7 +11,7 @@ Preliminaries
.. prerequisites:: Prerequisites .. prerequisites:: Prerequisites
We assume that Rougail's library is :ref:`already installed <installation>` on your computer (or in a virtual environment). We assume that Rougail's library is :ref:`globally installed <installation>` on your computer or locally in a virtual environment.
.. type-along:: an empty structure file .. type-along:: an empty structure file
@ -87,7 +87,7 @@ So we can therefore see this consequence:
Rougail waits for the `proxy_mode` configuration option's value to be set. Rougail waits for the `proxy_mode` configuration option's value to be set.
.. seealso:: To go further, have a look at the :tiramisu:`mandatory option <glossary.html#term-mandatory-option>` Tiramisu's definition. .. seealso:: To go further, have a look at the :tiramisu:`mandatory option <glossary.html#term-mandatory-option>` according to the definition of Tiramisu.
.. glossary:: .. glossary::

View file

@ -8,13 +8,13 @@ Synopsis
variable variable
A variable is an abstract black box (container) paired with an associated symbolic name, most often an option configuration, hich contains some defined or undefined data setting referred to as a :term:`value`. A variable is an abstract black box (container) paired with an associated symbolic name, most often an option configuration, hich contains some defined or undefined data setting referred to as a :term:`value`.
value value
A value is a variable's setting. A value is a variable's setting.
Variable can have a default value, that is a setting defined in the :term:`structure file`, Variable can have a default value, that is a setting defined in the :term:`structure file`,
or no value at all, then the value needs to be define later by the :term:`operator`. or no value at all, then the value needs to be define later by the :term:`operator`.
.. discussion:: Discussion .. discussion:: Discussion