Summary

[tutorial v1.1_120] xxx
[tutorial v1.1_120] xxx (config and doc)
2025-12-02 16:19:31 +01:00 · 2025-12-02 16:19:31 +01:00 · 2025-12-02 16:19:31 +01:00 · 2025-12-02 16:19:29 +01:00 · 2025-12-02 16:19:29 +01:00 · 2025-12-02 16:19:27 +01:00
15 changed files with 73 additions and 356 deletions
--- a/README.md
+++ b/README.md
@ -1,26 +1,24 @@
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[tutorial v1.1_080] A conditional disabled variable with type web_address](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080))
+# Description

-# [tutorial v1.1_090] A conditional disabled variable with type domainname and parameters
+This tutorial shows to you an example of Rougail use on how to set a proxy in the Mozilla Firefox browser.

-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090)
+More precisely, this tutorial aims at reproducing this [Mozilla Firefox](https://www.mozilla.org/firefox/new/) settings page:

-[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-domainname-and-parameters)
+![Firefox Proxy setting](firefox.png)

+And the integration of part of the [Firefox FoxyProxy plugin](https://addons.mozilla.org/firefox/addon/foxyproxy-standard/).

-## Screenshot
+The idea is to have a namespace specific to FoxyProxy and to find in it part of the settings that we will have made in the main namespace.

+This is what the page looks like:

-<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
-
-
-## Clone and install
-
+![Foxyproxy Proxy setting](foxyproxy.png)

+# Installation

 To test this tutorial, you need to download this repository and install Rougail:

-```shell
+```bash
 git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
 cd rougail-tutorials
 python -m venv venv_rougail
@ -28,165 +26,69 @@ python -m venv venv_rougail
 pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
 ```

-Then switch to the tutorial page:
+# Summary

-```shell
-git switch --detach v1.1_090
-```
+Each step is a separerate commit. You can navigate to history to discover different aspect to the Rougail format.

-## Structure
+- Getting started
+    - [[tutorial v1.1_000] Creating a structure file](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#creating-a-structure-file) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000))
+    - [[tutorial v1.1_001] Let’s add our first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#let-s-add-our-first-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001))
+    - [[tutorial v1.1_002] Describe the variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#describe-the-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002))
+    - [[tutorial v1.1_003] Set a default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#set-a-default-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003))
+- A variable with a list of possible values
+    - [[tutorial v1.1_010] A variable with a list of possible values](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#a-variable-with-a-list-of-possible-values) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010))
+- Group variables inside "families"
+    - [[tutorial v1.1_020] Creating a new family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#creating-a-new-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020))
+    - [[tutorial v1.1_021] Or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#or-a-sub-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021))
+    - [[tutorial v1.1_022] Putting a variable inside of a family or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#putting-a-variable-inside-of-a-family-or-a-sub-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022))
+- Constrainte the value of a variable with it's type
+    - [[tutorial v1.1_030] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"domainname") - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030))
+    - [[tutorial v1.1_031] A variable with type's parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type's-parameters) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031))
+    - [[tutorial v1.1_032] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"port") - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_032~1..v1.1_032))
+    - [[tutorial v1.1_033] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"boolean") - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033))
+- Define access to variable or family
+  - Property disabled
+    - [[tutorial v1.1_040] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-disabled-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040))
+    - [[tutorial v1.1_041] A conditional disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_041/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-disabled-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041))
+  - Property hidden
+    - [[tutorial v1.1_042] Copy HTTP manual proxy to HTTPS manual proxy](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_042/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#copy-http-manual-proxy-to-https-manual-proxy) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042))
+    - [[tutorial v1.1_043] A conditional hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_043/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-hidden-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043))
+- Calculated default value for a variable
+    - [[tutorial v1.1_050] A calculated default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_050/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-calculated-default-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050))
+- Dynamic family
+    - [[tutorial v1.1_060] Family: a dynamic family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_060/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/dynfam.html#family:-a-dynamic-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_060~1..v1.1_060))
+    - [[tutorial v1.1_061] A conditional disabled variable with dynamic identifier](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/dynfam.html#a-conditional-disabled-variable-with-dynamic-identifier) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_061~1..v1.1_061))
+- Playing with Jinja
+    - [[tutorial v1.1_070] A conditional hidden family with Jinja](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_070/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-hidden-family-with-jinja) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_070~1..v1.1_070))
+    - [[tutorial v1.1_071] Jinja with a description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_071/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#jinja-with-a-description) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_071~1..v1.1_071))
+    - [[tutorial v1.1_072] Jinja with a parameter](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_072/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#jinja-with-a-parameter) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_072~1..v1.1_072))
+- Various variables
+    - [[tutorial v1.1_080] A conditional disabled variable with type web_address](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-web_address) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080))
+    - [[tutorial v1.1_090] A conditional disabled variable with type domainname and parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-domainname-and-parameters) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090))
+- Multiple variable
+    - [[tutorial v1.1_091] A variable with multiple value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_091/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-with-multiple-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_091~1..v1.1_091))
+- Mandatory
+    - [[tutorial v1.1_092] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_092/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-non-mandatory-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_092~1..v1.1_092))
+- Extras informations for a variable
+    - [[tutorial v1.1_093] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_093/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#examples) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_093~1..v1.1_093))
+    - [[tutorial v1.1_094] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_094/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#help) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_094~1..v1.1_094))
+- Various variables
+    - [[tutorial v1.1_095] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095))
+    - [[tutorial v1.1_096] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096))
+    - [[tutorial v1.1_097] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_097/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-jinja-conditional-disabled-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_097~1..v1.1_097))
+- Mode
+    - [[tutorial v1.1_098] A variable in avanced mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-in-avanced-mode) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_098~1..v1.1_098))
+- Various variables
+    - [[tutorial v1.1_100] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100))
+    - [[tutorial v1.1_101] A choice variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_101/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-choice-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101))
+    - [[tutorial v1.1_102] A web_address variable ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_102/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-web_address-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102))
+- Validators
+    - [[tutorial v1.1_103] A variable with custom validation](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_103/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-with-custom-validation) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103))
+- Namespace
+    - [[tutorial v1.1_110] Namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#namespace) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110))
+    - [[tutorial v1.1_111] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111))
+    - [[tutorial v1.1_112] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_112~1..v1.1_112))
+    - [[tutorial v1.1_113] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_113/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_113~1..v1.1_113))
+    - [[tutorial v1.1_114] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_114~1..v1.1_114))
+    - [[tutorial v1.1_120] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_120~1..v1.1_120))

-
-
-<p>
-<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./">.</a><br/>
-	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/">firefox</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/10-manual.yml">10-manual.yml</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/20-manual.yml">20-manual.yml</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/30-auto.yml">30-auto.yml</a><br/>
-	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
-<br/><br/></p>
-
-Contents of the firefox/40-no_proxy.yml file
-
-```yml
-%YAML 1.2
---
-version: 1.1
-
-no_proxy:
-  description: Address for which proxy will be desactivated
-  type: domainname
-  params:
-    allow_ip: true
-    allow_cidr_network: true
-    allow_without_dot: true
-    allow_startswith_dot: true
-  disabled:
-    variable: _.proxy_mode
-    when: No proxy
-...
-
-```
-### Let's generate the documentation
-
-```shell
-rougail -m firefox/ -o doc
-```
-| Variable                                                                                                                                                   | Description                                                                                                                                                                                                                                                                  |
-|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>•&nbsp;No proxy **← (default)**<br/>•&nbsp;Auto-detect proxy settings for this network<br/>•&nbsp;Use system proxy settings<br/>•&nbsp;Manual proxy configuration<br/>•&nbsp;Automatic proxy configuration URL |
-
-#### Manual proxy configuration
-
-> **🛈 Informations**
-> 
-> **Path**: manual\
-> *`disabled`*\
-> **Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Manual proxy configuration"
-
-##### HTTP Proxy
-
-> **🛈 Informations**
-> 
-> **Path**: manual.http_proxy
-
-| Variable                                                                                                                                                                                                    | Description                                                                                                                                                                                                                |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **<a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be an IP                                                                                                                      |
-| **<a id="manual.http_proxy.port" name="manual.http_proxy.port">manual.http_proxy.port</a>**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                | HTTP Port.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;private ports (greater than 49152) are allowed<br/>**Default**: 8080 |
-
-| Variable                                                                                                                                                                                  | Description                                          |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
-| **<a id="manual.use_for_https" name="manual.use_for_https">manual.use_for_https</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
-
-##### *HTTPS* Proxy or *SOCKS* Proxy
-
-> **🛈 Informations**
-> 
-> This family builds families dynamically.\
-> **Path**: 
-> - manual.*https*_proxy
-> - manual.*socks*_proxy\
-> *`hidden`*\
-> **Hidden**: in HTTPS case if "[Also use this proxy for HTTPS](#manual.use_for_https)" is set to "true"\
-> **Identifiers**: 
-> - HTTPS
-> - SOCKS
-
-| Variable                                                                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                                                                                          |
-|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **<a id="manual.:::identifier:::_proxy.address" name="manual.:::identifier:::_proxy.address">manual.*https*_proxy.address</a>**<br/>**manual.*socks*_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`          | *HTTPS* or *SOCKS* address.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be an IP<br/>**Default**: the value of the variable "[HTTP address](#manual.http_proxy.address)"                                                                                          |
-| **<a id="manual.:::identifier:::_proxy.port" name="manual.:::identifier:::_proxy.port">manual.*https*_proxy.port</a>**<br/>**manual.*socks*_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                            | *HTTPS* or *SOCKS* port.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;private ports (greater than 49152) are allowed<br/>**Default**: the value of the variable "[HTTP Port](#manual.http_proxy.port)" |
-| **<a id="manual.:::identifier:::_proxy.version" name="manual.:::identifier:::_proxy.version">manual.*https*_proxy.version</a>**<br/>**manual.*socks*_proxy.version**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.<br/>**Choices**: <br/>•&nbsp;v4<br/>•&nbsp;v5 **← (default)**<br/>**Disabled**: when the identifier is "HTTPS"                                                                                                                                                     |
-
-| Variable                                                                                                                                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                     |
-|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **<a id="auto" name="auto">auto</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*            | Automatic proxy configuration URL.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be a hostname<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL"                     |
-| **<a id="no_proxy" name="no_proxy">no_proxy</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Address for which proxy will be desactivated.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can starts by a dot<br/>•&nbsp;the domain name can be a hostname<br/>•&nbsp;the domain name can be an IP<br/>•&nbsp;the domain name can be network in CIDR format<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
-
-### Let's generate the changelog
-
-```shell
-rougail -m firefox/ -o doc --doc.contents changelog
-```
-#### New variable
-
-| Variable                                                                                                                                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                     |
-|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **<a id="no_proxy" name="no_proxy">no_proxy</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Address for which proxy will be desactivated.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can starts by a dot<br/>•&nbsp;the domain name can be a hostname<br/>•&nbsp;the domain name can be an IP<br/>•&nbsp;the domain name can be network in CIDR format<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
-
-
-## User datas
-
-### Example 1
-
-#### config/01/config.yml
-
-
-```yml
---
-```
-#### Output
-
-```shell
-rougail -m firefox/ -u yaml -yf config/01/config.yml
-```
-<pre>╭──────────────────── Caption ─────────────────────╮
-│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #ffd700">Default value</span> │
-╰──────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
-</pre>
-### Example 2
-
-#### config/02/config.yml
-
-
-```yml
---
-proxy_mode: Automatic proxy configuration URL
-auto: https://auto.proxy.net/wpad.dat
-no_proxy: 192.168.1.0/24
-```
-#### Output
-
-```shell
-rougail -m firefox/ -u yaml -yf config/02/config.yml
-```
-<pre>╭─────────────────────────── Caption ────────────────────────────╮
-│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span>              │
-│                                    (⏳ Original default value) │
-╰────────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Automatic proxy configuration URL</span>
-<span style="color: #5c5cff">┃   </span>◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
-<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Automatic proxy configuration URL</span>: <span style="color: #00aa00">https://auto.proxy.net/wpad.dat</span> ◀ 
-<span style="color: #5c5cff">┃   </span>loaded from the YAML file "config/02/config.yml"
-<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>: <span style="color: #00aa00">192.168.1.0/24</span> ◀ loaded 
-<span style="color: #5c5cff">    </span>from the YAML file "config/02/config.yml"
-</pre>
-
-
- [[tutorial v1.1_091] A variable with multiple value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_091/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_091~1..v1.1_091))
--- a/config/01/cmd_ro.txt
+++ b/config/01/cmd_ro.txt
@ -1 +0,0 @@
-rougail -m firefox/ -u yaml -yf config/01/config.yml
--- a/config/01/config.yml
+++ b/config/01/config.yml
@ -1 +0,0 @@
---
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@ -1,6 +0,0 @@
-<pre>╭──────────────────── Caption ─────────────────────╮
-│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #ffd700">Default value</span> │
-╰──────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
-</pre>
--- a/config/02/cmd_ro.txt
+++ b/config/02/cmd_ro.txt
@ -1 +0,0 @@
-rougail -m firefox/ -u yaml -yf config/02/config.yml
--- a/config/02/config.yml
+++ b/config/02/config.yml
@ -1,4 +0,0 @@
---
-proxy_mode: Automatic proxy configuration URL
-auto: https://auto.proxy.net/wpad.dat
-no_proxy: 192.168.1.0/24
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@ -1,12 +0,0 @@
-<pre>╭─────────────────────────── Caption ────────────────────────────╮
-│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span>              │
-│                                    (⏳ Original default value) │
-╰────────────────────────────────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Automatic proxy configuration URL</span>
-<span style="color: #5c5cff">┃   </span>◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
-<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Automatic proxy configuration URL</span>: <span style="color: #00aa00">https://auto.proxy.net/wpad.dat</span> ◀ 
-<span style="color: #5c5cff">┃   </span>loaded from the YAML file "config/02/config.yml"
-<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>: <span style="color: #00aa00">192.168.1.0/24</span> ◀ loaded 
-<span style="color: #5c5cff">    </span>from the YAML file "config/02/config.yml"
-</pre>
--- a/firefox.png
+++ b/firefox.png
--- a/firefox/00-proxy.yml
+++ b/firefox/00-proxy.yml
@ -1,14 +0,0 @@
-%YAML 1.2
---
-version: 1.1
-
-proxy_mode:
-  description: Configure Proxy Access to the Internet
-  choices:
-    - No proxy
-    - Auto-detect proxy settings for this network
-    - Use system proxy settings
-    - Manual proxy configuration
-    - Automatic proxy configuration URL
-  default: No proxy
-...
--- a/firefox/10-manual.yml
+++ b/firefox/10-manual.yml
@ -1,23 +0,0 @@
-%YAML 1.2
---
-version: 1.1
-
-manual:
-  description: Manual proxy configuration
-  disabled:
-    variable: _.proxy_mode
-    when_not: Manual proxy configuration
-
-  http_proxy:  # HTTP Proxy
-
-    address:
-      description: HTTP address
-      type: domainname
-      params:
-        allow_ip: true
-
-    port:
-      description: HTTP Port
-      type: port
-      default: 8080
-...
--- a/firefox/20-manual.yml
+++ b/firefox/20-manual.yml
@ -1,43 +0,0 @@
-%YAML 1.2
---
-version: 1.1
-
-manual:
-
-  use_for_https: true  # Also use this proxy for HTTPS
-
-  '{{ identifier }}_proxy':
-    description: '{{ identifier }} Proxy'
-    hidden:
-      jinja: |-
-        {% if my_identifier == 'HTTPS' and _.use_for_https %}
-          HTTPS is same has HTTP
-        {% endif %}
-      description: in HTTPS case if "_.use_for_https" is set to "true"
-      params:
-        my_identifier:
-          type: identifier
-    dynamic:
-      - HTTPS
-      - SOCKS
-
-    address:
-      description: '{{ identifier }} address'
-      default:
-        variable: __.http_proxy.address
-
-    port:
-      description: '{{ identifier }} port'
-      default:
-        variable: __.http_proxy.port
-
-    version:
-      description: SOCKS host version used by proxy
-      choices:
-        - v4
-        - v5
-      default: v5
-      disabled:
-        type: identifier
-        when: HTTPS
-...
--- a/firefox/30-auto.yml
+++ b/firefox/30-auto.yml
@ -1,11 +0,0 @@
-%YAML 1.2
---
-version: 1.1
-
-auto:
-  description: Automatic proxy configuration URL
-  type: web_address
-  disabled:
-    variable: _.proxy_mode
-    when_not: Automatic proxy configuration URL
-...
--- a/firefox/40-no_proxy.yml
+++ b/firefox/40-no_proxy.yml
@ -1,16 +0,0 @@
-%YAML 1.2
---
-version: 1.1
-
-no_proxy:
-  description: Address for which proxy will be desactivated
-  type: domainname
-  params:
-    allow_ip: true
-    allow_cidr_network: true
-    allow_without_dot: true
-    allow_startswith_dot: true
-  disabled:
-    variable: _.proxy_mode
-    when: No proxy
-...
--- a/install.txt
+++ b/install.txt
@ -1,5 +0,0 @@
-git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
-cd rougail-tutorials
-python -m venv venv_rougail
-. venv_rougail/bin/activate
-pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
--- a/tree.html
+++ b/tree.html
@ -1,48 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <meta name="Author" content="Made by 'tree'">
- <meta name="GENERATOR" content="tree v2.2.1 © 1996 - 2024 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro">
- <title>Directory Tree</title>
- <style type="text/css">
-  BODY { font-family : monospace, sans-serif;  color: black;}
-  P { font-family : monospace, sans-serif; color: black; margin:0px; padding: 0px;}
-  A:visited { text-decoration : none; margin : 0px; padding : 0px;}
-  A:link    { text-decoration : none; margin : 0px; padding : 0px;}
-  A:hover   { text-decoration: underline; background-color : yellow; margin : 0px; padding : 0px;}
-  A:active  { margin : 0px; padding : 0px;}
-  .VERSION { font-size: small; font-family : arial, sans-serif; }
-  .NORM  { color: black;  }
-  .FIFO  { color: purple; }
-  .CHAR  { color: yellow; }
-  .DIR   { color: blue;   }
-  .BLOCK { color: yellow; }
-  .LINK  { color: aqua;   }
-  .SOCK  { color: fuchsia;}
-  .EXEC  { color: green;  }
- </style>
-</head>
-<body>
-	<h1>Directory Tree</h1><p>
-	<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./">.</a><br>
-	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/">firefox</a><br>
-	&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/00-proxy.yml">00-proxy.yml</a><br>
-	&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/10-manual.yml">10-manual.yml</a><br>
-	&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/20-manual.yml">20-manual.yml</a><br>
-	&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/30-auto.yml">30-auto.yml</a><br>
-	&nbsp;&nbsp;&nbsp; └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br>
-<br><br><p>
-
-2 directories, 5 files
-
-</p>
-	<hr>
-	<p class="VERSION">
-		 tree v2.2.1 © 1996 - 2024 by Steve Baker and Thomas Moore <br>
-		 HTML output hacked and copyleft © 1998 by Francesc Rocher <br>
-		 JSON output hacked and copyleft © 2014 by Florian Sesser <br>
-		 Charsets / OS/2 support © 2001 by Kyosuke Tokoro
-	</p>
-</body>
-</html>
Author	SHA1	Message	Date
Emmanuel Garette	6ec1a18922	Summary	2025-12-02 16:19:31 +01:00
Emmanuel Garette	192941aa90	[tutorial v1.1_120] xxx	2025-12-02 16:19:31 +01:00
Emmanuel Garette	98d3b5ff23	[tutorial v1.1_120] xxx (config and doc)	2025-12-02 16:19:31 +01:00
Emmanuel Garette	b70fe2a52b	[tutorial v1.1_114] xxx	2025-12-02 16:19:29 +01:00
Emmanuel Garette	e670e92f7f	[tutorial v1.1_114] xxx (config and doc)	2025-12-02 16:19:29 +01:00
Emmanuel Garette	ff9adfbaf4	[tutorial v1.1_113] xxx	2025-12-02 16:19:27 +01:00
Emmanuel Garette	70f4d87b34	[tutorial v1.1_113] xxx (config and doc)	2025-12-02 16:19:27 +01:00
Emmanuel Garette	69265edce6	[tutorial v1.1_112] xxx	2025-12-02 16:19:25 +01:00
Emmanuel Garette	db3dd0c915	[tutorial v1.1_112] xxx (config and doc)	2025-12-02 16:19:25 +01:00
Emmanuel Garette	adbeec79a2	[tutorial v1.1_111] xxx	2025-12-02 16:19:23 +01:00
Emmanuel Garette	7fef7d35df	[tutorial v1.1_111] xxx (config and doc)	2025-12-02 16:19:23 +01:00
Emmanuel Garette	99415b5db4	[tutorial v1.1_110] Namespace	2025-12-02 16:19:21 +01:00
Emmanuel Garette	a9b5ce6672	[tutorial v1.1_110] Namespace (config and doc)	2025-12-02 16:19:21 +01:00
Emmanuel Garette	dc9d0d650e	[tutorial v1.1_103] A variable with custom validation	2025-12-02 16:19:19 +01:00
Emmanuel Garette	a95aaba039	[tutorial v1.1_103] A variable with custom validation (config and doc)	2025-12-02 16:19:19 +01:00
Emmanuel Garette	9ea6478140	[tutorial v1.1_102] A web_address variable	2025-12-02 16:19:17 +01:00
Emmanuel Garette	eed80ef7a8	[tutorial v1.1_102] A web_address variable (config and doc)	2025-12-02 16:19:17 +01:00
Emmanuel Garette	1b94f06cbd	[tutorial v1.1_101] A choice variable	2025-12-02 16:19:15 +01:00
Emmanuel Garette	81d569057b	[tutorial v1.1_101] A choice variable (config and doc)	2025-12-02 16:19:15 +01:00
Emmanuel Garette	0838dab66c	[tutorial v1.1_100] A boolean variable	2025-12-02 16:19:13 +01:00
Emmanuel Garette	d8410e6189	[tutorial v1.1_100] A boolean variable (config and doc)	2025-12-02 16:19:13 +01:00
Emmanuel Garette	70b6b92bb8	[tutorial v1.1_098] A variable in avanced mode	2025-12-02 16:19:11 +01:00
Emmanuel Garette	7e41d54635	[tutorial v1.1_098] A variable in avanced mode (config and doc)	2025-12-02 16:19:11 +01:00
Emmanuel Garette	124ddd9821	[tutorial v1.1_097] A Jinja conditional disabled boolean variable	2025-12-02 16:19:09 +01:00
Emmanuel Garette	36a77f4c6c	[tutorial v1.1_097] A Jinja conditional disabled boolean variable (config and doc)	2025-12-02 16:19:09 +01:00
Emmanuel Garette	94af5caed3	[tutorial v1.1_096] A boolean variable	2025-12-02 16:19:07 +01:00
Emmanuel Garette	d5287cbb6b	[tutorial v1.1_096] A boolean variable (config and doc)	2025-12-02 16:19:07 +01:00
Emmanuel Garette	71d0065215	[tutorial v1.1_095] A conditional disabled boolean variable	2025-12-02 16:19:05 +01:00
Emmanuel Garette	ae7897072f	[tutorial v1.1_095] A conditional disabled boolean variable (config and doc)	2025-12-02 16:19:05 +01:00
Emmanuel Garette	5baad602cf	[tutorial v1.1_094] Help	2025-12-02 16:19:03 +01:00
Emmanuel Garette	c9c905196c	[tutorial v1.1_094] Help (config and doc)	2025-12-02 16:19:03 +01:00
Emmanuel Garette	6526f9957f	[tutorial v1.1_093] Examples	2025-12-02 16:19:01 +01:00
Emmanuel Garette	5734c3f596	[tutorial v1.1_093] Examples (config and doc)	2025-12-02 16:19:01 +01:00
Emmanuel Garette	14780700da	[tutorial v1.1_092] A non mandatory variable	2025-12-02 16:18:59 +01:00
Emmanuel Garette	0b48de05c5	[tutorial v1.1_092] A non mandatory variable (config and doc)	2025-12-02 16:18:59 +01:00
Emmanuel Garette	e38c525704	[tutorial v1.1_091] A variable with multiple value	2025-12-02 16:18:57 +01:00
Emmanuel Garette	e3b1907dda	[tutorial v1.1_091] A variable with multiple value (config and doc)	2025-12-02 16:18:57 +01:00
				`@ -1 +0,0 @@`
				`rougail -m firefox/ -u yaml -yf config/01/config.yml`