[tutorial v1.1_062)] Jinja with a description (config and doc)

README.md

@@ -1,9 +1,9 @@
 - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
-- [[tutorial v1.1_060] A conditional hidden family with Jinja](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_060/README.md) ([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](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_061~1..v1.1_061))
 
-# [tutorial v1.1_061)] A conditional disabled variable
+# [tutorial v1.1_062)] Jinja with a description
 
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_061~1..v1.1_061)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_062~1..v1.1_062)
 
 
 ## Screenshot
@@ -29,7 +29,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
 Then switch to the tutorial page:
 
 ```shell
-git switch --detach v1.1_061
+git switch --detach v1.1_062
 ```
 
 ## Structure
@@ -37,12 +37,12 @@ git switch --detach v1.1_061
 
 
 <p>
-<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/./">.</a><br/>
-	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/./firefox/">firefox</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/./firefox/10-manual.yml">10-manual.yml</a><br/>
-	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/./firefox/20-manual.yml">20-manual.yml</a><br/>
-	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/./firefox/30-auto.yml">30-auto.yml</a><br/>
+<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/./">.</a><br/>
+	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/./firefox/">firefox</a><br/>
+	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
+	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/./firefox/10-manual.yml">10-manual.yml</a><br/>
+	    ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/./firefox/20-manual.yml">20-manual.yml</a><br/>
+	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/./firefox/30-auto.yml">30-auto.yml</a><br/>
 <br/><br/></p>
 
 Contents of the firefox/30-auto.yml file
@@ -101,7 +101,7 @@ This family builds families dynamically
 
 *`hidden`*
 
-**Hidden**: depends on a calculation
+**Hidden**: in HTTPS case if "_.use_for_https" is set to True
 
 **Identifiers**: <br/>- HTTPS<br/>- SOCKS
 
@@ -115,83 +115,6 @@ This family builds families dynamically
 |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **auto**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Automatic proxy configuration URL.<br/>**Validator**: the domain name in web address can be only a hostname<br/>**Disabled**: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL"                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
-### Let's generate the changelog
-
-```shell
-rougail -m firefox/ -o doc --doc.contents changelog
-```
-#### New variable
-
-| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;   | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;   |
-|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **auto**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Automatic proxy configuration URL.<br/>**Validator**: the domain name in web address can be only a hostname<br/>**Disabled**: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL"                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 
 
-## User datas
-
-### Example 1
-
-#### config/01/config.yml
-
-
-```yml
----
-auto: https://auto.proxy.net/wpad.dat
-```
-#### Output
-
-```shell
-rougail -m firefox/ -u yaml -yf config/01/config.yml
-```
-<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
-<span style="color: #ffff00">┗━━ </span>variable "auto" (Automatic proxy configuration URL) is disabled, it will be ignored when loading from the YAML file "config/01/config.yml"
-╭─────── Caption ────────╮
-│ Variable <span style="color: #ffd700">Default value</span> │
-╰────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
-</pre>
-### Example 2
-
-#### config/02/config.yml
-
-
-```yml
----
-proxy_mode: Automatic proxy configuration URL
-```
-#### Output
-
-```shell
-rougail -m firefox/ -u yaml -yf config/02/config.yml
-```
-<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
-<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
-<span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>Automatic proxy configuration URL
-</pre>
-### Example 3
-
-#### config/03/config.yml
-
-
-```yml
----
-proxy_mode: Automatic proxy configuration URL
-auto: https://auto.proxy.net/wpad.dat
-```
-#### Output
-
-```shell
-rougail -m firefox/ -u yaml -yf config/03/config.yml
-```
-<pre>╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
-│          (<span style="color: #00aa00">⏳ Original default value</span>) │
-╰──────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/03/config.yml" (⏳ <span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yml"
-</pre>
-
-
-- [[tutorial v1.1_062] Jinja with a description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_062~1..v1.1_062))
+- [[tutorial v1.1_065] A variable with type "web_address"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_065/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_065~1..v1.1_065))

config/01/cmd_ro.txt

@@ -1 +0,0 @@
-rougail -m firefox/ -u yaml -yf config/01/config.yml

config/01/config.yml

@@ -1,2 +0,0 @@
----
-auto: https://auto.proxy.net/wpad.dat

config/01/output_ro.html

@@ -1,8 +0,0 @@
-<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
-<span style="color: #ffff00">┗━━ </span>variable "auto" (Automatic proxy configuration URL) is disabled, it will be ignored when loading from the YAML file "config/01/config.yml"
-╭─────── Caption ────────╮
-│ Variable <span style="color: #ffd700">Default value</span> │
-╰────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
-</pre>

config/02/cmd_ro.txt

@@ -1 +0,0 @@
-rougail -m firefox/ -u yaml -yf config/02/config.yml

config/02/config.yml

@@ -1,2 +0,0 @@
----
-proxy_mode: Automatic proxy configuration URL

config/02/output_ro.html

@@ -1,4 +0,0 @@
-<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
-<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
-<span style="color: #ff0000">    </span><span style="color: #ff0000">┗━━ </span>Automatic proxy configuration URL
-</pre>

config/03/cmd_ro.txt

@@ -1 +0,0 @@
-rougail -m firefox/ -u yaml -yf config/03/config.yml

config/03/config.yml

@@ -1,3 +0,0 @@
----
-proxy_mode: Automatic proxy configuration URL
-auto: https://auto.proxy.net/wpad.dat

config/03/output_ro.html

@@ -1,8 +0,0 @@
-<pre>╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
-│          (<span style="color: #00aa00">⏳ Original default value</span>) │
-╰──────────────────────────────────────╯
-Variables:
-<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/03/config.yml" (⏳ <span style="color: #00aa00">No proxy</span>)
-<span style="color: #5c5cff">┗━━ </span>📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yml"
-</pre>

tree.html

@@ -25,12 +25,12 @@
 </head>
 <body>
 	<h1>Directory Tree</h1><p>
-	<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/./">.</a><br>
-	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/./firefox/">firefox</a><br>
-	&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/./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_061/./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_061/./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_061/./firefox/30-auto.yml">30-auto.yml</a><br>
+	<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/./">.</a><br>
+	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/./firefox/">firefox</a><br>
+	&nbsp;&nbsp;&nbsp; ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/./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_062/./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_062/./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_062/./firefox/30-auto.yml">30-auto.yml</a><br>
 <br><br><p>
 
 2 directories, 4 files