diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..da150bf9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# New variable + +| Variable | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **manual.http_proxy.address**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 98871a8f..5da951c8 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -1,3 +1,19 @@ | Variable | Description | |------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **proxy_mode**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Choices**:
• No proxy **← (default)**
• Auto-detect proxy settings for this network
• Use system proxy settings
• Manual proxy configuration
• Automatic proxy configuration URL | + +# Manual proxy configuration + +> [!NOTE] +> +> **Path**: manual + +## HTTP Proxy + +> [!NOTE] +> +> **Path**: manual.http_proxy + +| Variable | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **manual.http_proxy.address**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. | diff --git a/README.md b/README.md index 95819dfc..dd20b3ab 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_020] Creating a new family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021)) +- [[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_022~1..v1.1_022)) -# [tutorial v1.1_021] Or a sub family +# [tutorial v1.1_022] Putting a variable inside of a family or a sub family -[Read the tutorial "Or a sub family" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/family.html#or-a-sub-family) +[Read the tutorial "Putting a variable inside of a family or a sub family" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/family.html#putting-a-variable-inside-of-a-family-or-a-sub-family) ## Screenshot @@ -25,16 +25,16 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_021 +git switch --detach v1.1_022 ``` ## Structure

-.
- └── firefox
-     ├── 00-proxy.yml
-     └── 10-manual.yml
+.
+ └── firefox
+     ├── 00-proxy.yml
+     └── 10-manual.yml


Contents of the firefox/10-manual.yml file @@ -46,9 +46,9 @@ version: 1.1 manual: # Manual proxy configuration - http_proxy: - description: HTTP Proxy - type: family + http_proxy: # HTTP Proxy + + address: # HTTP address ... ``` @@ -63,6 +63,70 @@ rougail -m firefox/ -o doc *** +### Let's generate the changelog + +```shell +rougail -m firefox/ -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml +``` +[View the changelog file](CHANGELOG.md) + +*** +## User datas + +### Example 1 + +#### config/01/config.yml -- [[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)) +```yml +--- +``` + +*** +#### Output + +```shell +rougail -m firefox/ -u yaml -yf config/01/config.yml +``` +> [!CAUTION] +> +> - manual (Manual proxy configuration) +> - http_proxy (HTTP Proxy) +> - address (HTTP address): :stop_sign: mandatory variable but has no value + +*** +### Example 2 + +#### config/02/config.yml + + +```yml +--- +manual: + http_proxy: + address: example.net +``` + +*** +#### Output + +```shell +rougail -m firefox/ -u yaml -yf config/02/config.yml +``` +> [!NOTE] +> +> **Caption:** +> - Variable +> - Default value +> - Modified value + +Variables: +- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy +- :open_file_folder: manual (Manual proxy configuration) + - :open_file_folder: http_proxy (HTTP Proxy) + - :notebook: address (HTTP address): example.net ← loaded from the YAML file "config/02/config.yml" + +*** + + +- [[tutorial v1.1_030] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030)) diff --git a/config/01/cmd_ro.txt b/config/01/cmd_ro.txt new file mode 100644 index 00000000..d46f9445 --- /dev/null +++ b/config/01/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/01/config.yml \ No newline at end of file diff --git a/config/01/config.yml b/config/01/config.yml new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/config/01/config.yml @@ -0,0 +1 @@ +--- diff --git a/config/01/output_ro.html b/config/01/output_ro.html new file mode 100644 index 00000000..cafcfd3d --- /dev/null +++ b/config/01/output_ro.html @@ -0,0 +1,5 @@ +
🛑 Caution
+┗━━ manual (Manual proxy configuration)
+    ┗━━ http_proxy (HTTP Proxy)
+        ┗━━ address (HTTP address): 🛑 mandatory variable but has no value
+
diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt new file mode 100644 index 00000000..772ebbef --- /dev/null +++ b/config/02/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/02/config.yml \ No newline at end of file diff --git a/config/02/config.yml b/config/02/config.yml new file mode 100644 index 00000000..22422a2f --- /dev/null +++ b/config/02/config.yml @@ -0,0 +1,4 @@ +--- +manual: + http_proxy: + address: example.net diff --git a/config/02/output_ro.html b/config/02/output_ro.html new file mode 100644 index 00000000..f22f0f29 --- /dev/null +++ b/config/02/output_ro.html @@ -0,0 +1,11 @@ +
╭──────── Caption ────────╮
+│ Variable Default value  │
+│          Modified value │
+╰─────────────────────────╯
+Variables:
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
+┗━━ 📂 manual (Manual proxy configuration)
+    ┗━━ 📂 http_proxy (HTTP Proxy)
+        ┗━━ 📓 address (HTTP address): example.net ◀ loaded from the YAML file 
+            "config/02/config.yml"
+
diff --git a/tree.html b/tree.html index 0afc2d34..35f3a78e 100644 --- a/tree.html +++ b/tree.html @@ -1,6 +1,6 @@

-.
- └── firefox
-     ├── 00-proxy.yml
-     └── 10-manual.yml
+.
+ └── firefox
+     ├── 00-proxy.yml
+     └── 10-manual.yml


\ No newline at end of file