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

proofreading

Browse source
This commit is contained in:
gwen 2025-06-26 17:53:37 +02:00
parent f7701917d0
commit 7e163e56f0
1 changed files with 15 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/tutorial/boolean.rst
View file

@ -228,7 +228,8 @@ Now we can set a `hidden` property to the `https_proxy` family:
The whole `https_proxy` family has been set to `hidden` here. The whole `https_proxy` family has been set to `hidden` here.
.. important:: A `hidden` variable with the `mandatory` parameter set still shall have a defined value .. warning:: A `hidden` variable with the `mandatory` parameter set still shall have a defined value,
even if it's hidden.
If we choose the manual proxy configuration mode, If we choose the manual proxy configuration mode,
@ -256,13 +257,13 @@ Rougail will raise an error:
<span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address) <span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
</pre> </pre>
A conditional hidden family driven by a boolean variable A contextual hidden family driven by a boolean variable
----------------------------------------------------------- -----------------------------------------------------------
But we want this `hidden` property to be assigned dynamically depending on the `use_for_https` `true` or `false` value. What we want is having this `hidden` property assigned dynamically depending on the `use_for_https` `true` or `false` value.
Here is how to achieve this.
Here is how to achieve this:
It is possible to add a `variable` parameter to the `hidden` attribute like this:
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_034/firefox/20-manual.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_034/firefox/20-manual.yml
:language: yaml :language: yaml
@ -292,9 +293,10 @@ It is possible to add a `variable` parameter to the `hidden` attribute like this
type: port type: port
default: 8080 default: 8080
A calculated default value Yes, it is possible to add a `variable` parameter to the `hidden` attribute.
-------------------------------
A contextualized default value
---------------------------------
There is something left in the https configuration mode of the proxy: There is something left in the https configuration mode of the proxy:
@ -312,8 +314,6 @@ By now, the default settings are set like this:
type: port type: port
default: 8080 default: 8080
The dynamic setting of a default can be achieved in this way: The dynamic setting of a default can be achieved in this way:
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_035/firefox/20-manual.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_035/firefox/20-manual.yml
@ -347,10 +347,13 @@ The dynamic setting of a default can be achieved in this way:
default: default:
variable: manual.http_proxy.port variable: manual.http_proxy.port
.. note:: This is just a pointer to another variable's value. The default value is a pointer to another variable's value.
Here, the defaut value of `manual.https_proxy.address` points to `manual.http_proxy.address`.
The default values of the https address and port are pointing to the value of This is the same thing for the default value of the `manual.https_proxy.port` variable,
the `manual.http_proxy.address` and the `manual.http_proxy.port` variables. which points to the `manual.http_proxy.port` value.
We also say that the default value is *calculated*.
.. glossary:: .. glossary::