diff --git a/README.md b/README.md index 2d620cdc..45e7bd95 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_021] Or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([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) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022)) -# [tutorial v1.1_022)] Putting a variable inside of a family or a sub family +# [tutorial v1.1_023)] A variable with type "domainname" -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023) ## Screenshot @@ -47,14 +47,16 @@ manual: # Manual proxy configuration http_proxy: # HTTP Proxy - address: # HTTP address + address: + description: HTTP address + type: domainname ... ``` ### Let's generate the documentation ```console -foo@bar:~$ git switch --detach v1.1_022 +foo@bar:~$ git switch --detach v1.1_023 foo@bar:~$ rougail -m firefox/ -o doc ``` | Variable                                                                                        | Description                                                                                     | @@ -73,21 +75,21 @@ foo@bar:~$ rougail -m firefox/ -o doc -| Variable                                                                                        | Description                                                                                     | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.http_proxy.address**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | +| Variable                                                                                            | Description                                                                                         | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | ### Let's generate the changelog ```console -foo@bar:~$ git switch --detach v1.1_022 +foo@bar:~$ git switch --detach v1.1_023 foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog ``` -#### New variable +#### Modified variable -| Variable                                                                                        | Description                                                                                     | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.http_proxy.address**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | +| Variable                                                                                                                    | Description                                                                                                                 | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.http_proxy.address**
~~`string`~~ [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | ## User datas @@ -104,7 +106,7 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog #### Output ```console -foo@bar:~$ git switch --detach v1.1_022 +foo@bar:~$ git switch --detach v1.1_023 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml ```
🛑 ERRORS
@@ -116,7 +118,7 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
 #### Output in read write mode
 
 ```console
-foo@bar:~$ git switch --detach v1.1_022
+foo@bar:~$ git switch --detach v1.1_023
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml --cli.read_write
 ```
 
🛑 ERRORS
@@ -138,7 +140,7 @@ proxy_mode: Manual proxy configuration
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_022
+foo@bar:~$ git switch --detach v1.1_023
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
 ```
 
🛑 ERRORS
@@ -150,7 +152,7 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
 #### Output in read write mode
 
 ```console
-foo@bar:~$ git switch --detach v1.1_022
+foo@bar:~$ git switch --detach v1.1_023
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml --cli.read_write
 ```
 
🛑 ERRORS
@@ -175,7 +177,7 @@ manual:
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_022
+foo@bar:~$ git switch --detach v1.1_023
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
 ```
 
╭────────────── Caption ───────────────╮
@@ -191,7 +193,7 @@ Variables:
 #### Output in read write mode
 
 ```console
-foo@bar:~$ git switch --detach v1.1_022
+foo@bar:~$ git switch --detach v1.1_023
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml --cli.read_write
 ```
 
╭────────────── Caption ───────────────╮
@@ -221,7 +223,7 @@ manual:
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_022
+foo@bar:~$ git switch --detach v1.1_023
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
 ```
 
🔔 WARNINGS
@@ -239,7 +241,7 @@ Variables:
 #### Output in read write mode
 
 ```console
-foo@bar:~$ git switch --detach v1.1_022
+foo@bar:~$ git switch --detach v1.1_023
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_write
 ```
 
🔔 WARNINGS
@@ -274,7 +276,7 @@ manual:
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_022
+foo@bar:~$ git switch --detach v1.1_023
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
 ```
 
🔔 WARNINGS
@@ -294,7 +296,7 @@ Variables:
 #### Output in read write mode
 
 ```console
-foo@bar:~$ git switch --detach v1.1_022
+foo@bar:~$ git switch --detach v1.1_023
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml --cli.read_write
 ```
 
🔔 WARNINGS
@@ -313,4 +315,4 @@ Variables:
 
-- [[tutorial v1.1_023] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_023/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023)) +- [[tutorial v1.1_024] A variable with type's parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_024/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_024~1..v1.1_024))