diff --git a/CHANGELOG.md b/CHANGELOG.md
index da150bf9..8d5b4b4a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,5 @@
-# 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.
**Validator**: type domainname |
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index 5da951c8..0177d492 100644
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -14,6 +14,6 @@
>
> **Path**: manual.http_proxy
-| 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.
**Validator**: type domainname |
diff --git a/README.md b/README.md
index dd20b3ab..a8ffeb8d 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_022~1..v1.1_022))
+- [[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_030~1..v1.1_030))
-# [tutorial v1.1_022] Putting a variable inside of a family or a sub family
+# [tutorial v1.1_030] A variable with type "domainname"
-[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)
+[Read the tutorial "A variable with type "domainname"" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/types.html#a-variable-with-type-domainname)
## 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_022
+git switch --detach v1.1_030
```
## Structure
-.
- └── firefox
- ├── 00-proxy.yml
- └── 10-manual.yml
+.
+ └── firefox
+ ├── 00-proxy.yml
+ └── 10-manual.yml
🛑 Caution -┗━━ manual (Manual proxy configuration) - ┗━━ http_proxy (HTTP Proxy) - ┗━━ address (HTTP address): 🛑 mandatory variable but has no value +╭──────── 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/01/config.yml"diff --git a/config/02/cmd_invalid.txt b/config/02/cmd_invalid.txt new file mode 100644 index 00000000..85f59c74 --- /dev/null +++ b/config/02/cmd_invalid.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.invalid_user_data_error \ No newline at end of file diff --git a/config/02/config.yml b/config/02/config.yml index 22422a2f..cbc99036 100644 --- a/config/02/config.yml +++ b/config/02/config.yml @@ -1,4 +1,4 @@ --- manual: http_proxy: - address: example.net + address: 192.168.0.1 diff --git a/config/02/output_invalid.html b/config/02/output_invalid.html new file mode 100644 index 00000000..e998e31d --- /dev/null +++ b/config/02/output_invalid.html @@ -0,0 +1,9 @@ +🛑 Caution +┗━━ manual (Manual proxy configuration) + ┗━━ http_proxy (HTTP Proxy) + ┗━━ address (HTTP address) + ┣━━ 🛑 the value "192.168.0.1" is an invalid domain name, must not + ┃ be an IP, it has been loading from the YAML file + ┃ "config/02/config.yml" + ┗━━ 🛑 mandatory variable but has no value +diff --git a/config/02/output_ro.html b/config/02/output_ro.html index f22f0f29..62370be7 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -1,11 +1,9 @@ -╭──────── 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" +🛑 Caution +┗━━ manual (Manual proxy configuration) + ┗━━ http_proxy (HTTP Proxy) + ┗━━ address (HTTP address) + ┣━━ 🔔 the value "192.168.0.1" is an invalid domain name, must not + ┃ be an IP, it will be ignored when loading from the YAML file + ┃ "config/02/config.yml" + ┗━━ 🛑 mandatory variable but has no valuediff --git a/config/03/cmd_invalid.txt b/config/03/cmd_invalid.txt new file mode 100644 index 00000000..3fe251f2 --- /dev/null +++ b/config/03/cmd_invalid.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_data_error \ No newline at end of file diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt new file mode 100644 index 00000000..fc8085eb --- /dev/null +++ b/config/03/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/03/config.yml \ No newline at end of file diff --git a/config/03/config.yml b/config/03/config.yml new file mode 100644 index 00000000..39895d11 --- /dev/null +++ b/config/03/config.yml @@ -0,0 +1,4 @@ +--- +manual: + http_proxy: + address: not a valid domain name.com diff --git a/config/03/output_invalid.html b/config/03/output_invalid.html new file mode 100644 index 00000000..b0b8e3bb --- /dev/null +++ b/config/03/output_invalid.html @@ -0,0 +1,10 @@ +🛑 Caution +┗━━ manual (Manual proxy configuration) + ┗━━ http_proxy (HTTP Proxy) + ┗━━ address (HTTP address) + ┣━━ 🛑 the value "not a valid domain name.com" is an invalid domain + ┃ name, must start with lowercase characters followed by lowercase + ┃ characters, number, "-" and "." characters are allowed, it has + ┃ been loading from the YAML file "config/03/config.yml" + ┗━━ 🛑 mandatory variable but has no value +diff --git a/config/03/output_ro.html b/config/03/output_ro.html new file mode 100644 index 00000000..10189d01 --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,11 @@ +🛑 Caution +┗━━ manual (Manual proxy configuration) + ┗━━ http_proxy (HTTP Proxy) + ┗━━ address (HTTP address) + ┣━━ 🔔 the value "not a valid domain name.com" is an invalid domain + ┃ name, must start with lowercase characters followed by lowercase + ┃ characters, number, "-" and "." characters are allowed, it will + ┃ be ignored when loading from the YAML file + ┃ "config/03/config.yml" + ┗━━ 🛑 mandatory variable but has no value +diff --git a/tree.html b/tree.html index 35f3a78e..bbe62faa 100644 --- a/tree.html +++ b/tree.html @@ -1,6 +1,6 @@-.
\ No newline at end of file
- └── firefox
- ├── 00-proxy.yml
- └── 10-manual.yml
+.
+ └── firefox
+ ├── 00-proxy.yml
+ └── 10-manual.yml