[tutorial v1.1_096)] A boolean variable (config and doc)
This commit is contained in:
parent
19ee9f8dd4
commit
58a13c19c5
6 changed files with 49 additions and 47 deletions
61
README.md
61
README.md
|
|
@ -1,11 +1,11 @@
|
|||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||
- [[tutorial v1.1_094] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_094/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_094~1..v1.1_094))
|
||||
- [[tutorial v1.1_095] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095))
|
||||
|
||||
# [tutorial v1.1_095)] A conditional disabled boolean variable
|
||||
# [tutorial v1.1_096)] A boolean variable
|
||||
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095)
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096)
|
||||
|
||||
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-boolean-variable)
|
||||
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable)
|
||||
|
||||
|
||||
## Screenshot
|
||||
|
|
@ -31,7 +31,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_095
|
||||
git switch --detach v1.1_096
|
||||
```
|
||||
|
||||
## Structure
|
||||
|
|
@ -39,29 +39,25 @@ git switch --detach v1.1_095
|
|||
|
||||
|
||||
<p>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./">.</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/">firefox</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./">.</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/">firefox</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br/>
|
||||
<br/><br/></p>
|
||||
|
||||
Contents of the firefox/50-prompt_authentication.yml file
|
||||
Contents of the firefox/55-proxy_dns_socks5.yml file
|
||||
|
||||
```yml
|
||||
%YAML 1.2
|
||||
---
|
||||
version: 1.1
|
||||
|
||||
prompt_authentication:
|
||||
description: Prompt for authentication if password is saved
|
||||
default: true
|
||||
disabled:
|
||||
variable: _.proxy_mode
|
||||
when: No proxy
|
||||
proxy_dns_socks5: false # Use proxy DNS when using SOCKS v5
|
||||
...
|
||||
|
||||
```
|
||||
|
|
@ -120,6 +116,7 @@ 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" |
|
||||
| **no_proxy**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.<br/>Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.<br/>**Validators**: <br/>- the domain name can starts by a dot<br/>- the domain name can be a hostname<br/>- the domain name can be an IP<br/>- the domain name can be network in CIDR format<br/>**Examples**: <br/>- .mozilla.org<br/>- .net.nz<br/>- 192.168.1.0/24<br/>**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
|
||||
| **prompt_authentication**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.<br/>**Default**: true<br/>**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
|
||||
| **proxy_dns_socks5**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Use proxy DNS when using SOCKS v5.<br/>**Default**: false |
|
||||
|
||||
### Let's generate the changelog
|
||||
|
||||
|
|
@ -128,9 +125,9 @@ rougail -m firefox/ -o doc --doc.contents changelog
|
|||
```
|
||||
#### New variable
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **prompt_authentication**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.<br/>**Default**: true<br/>**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **proxy_dns_socks5**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Use proxy DNS when using SOCKS v5.<br/>**Default**: false |
|
||||
|
||||
|
||||
## User datas
|
||||
|
|
@ -152,7 +149,8 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml
|
|||
│ 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>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
### Example 2
|
||||
|
||||
|
|
@ -188,7 +186,8 @@ Variables:
|
|||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 SOCKS port: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 SOCKS host version used by proxy: <span style="color: #ffd700">v5</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Address for which proxy will be desactivated:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
### Example 3
|
||||
|
||||
|
|
@ -208,9 +207,7 @@ proxy_dns_socks5: true
|
|||
```shell
|
||||
rougail -m firefox/ -u yaml -yf config/03/config.yml
|
||||
```
|
||||
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
||||
<span style="color: #ffff00">┗━━ </span>variable or family "proxy_dns_socks5" does not exist, it will be ignored when loading from the YAML file "config/03/config.yml"
|
||||
╭────────────── Caption ───────────────╮
|
||||
<pre>╭────────────── Caption ───────────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
│ Modified value │
|
||||
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
||||
|
|
@ -227,7 +224,8 @@ Variables:
|
|||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 SOCKS port: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 SOCKS host version used by proxy: <span style="color: #ffd700">v5</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Address for which proxy will be desactivated:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: true ◀ loaded from the YAML file "config/03/config.yml" (⏳ <span style="color: #00aa00">false</span>)
|
||||
</pre>
|
||||
### Example 4
|
||||
|
||||
|
|
@ -265,8 +263,9 @@ Variables:
|
|||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 SOCKS port: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 SOCKS host version used by proxy: v4 ◀ loaded from the YAML file "config/04/config.yml" (⏳ <span style="color: #00aa00">v5</span>)
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Address for which proxy will be desactivated:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
|
||||
|
||||
- [[tutorial v1.1_096] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/README.md) ([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) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_097~1..v1.1_097))
|
||||
|
|
|
|||
|
|
@ -2,5 +2,6 @@
|
|||
│ 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>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -15,5 +15,6 @@ Variables:
|
|||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 SOCKS port: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 SOCKS host version used by proxy: <span style="color: #ffd700">v5</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Address for which proxy will be desactivated:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,4 @@
|
|||
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
||||
<span style="color: #ffff00">┗━━ </span>variable or family "proxy_dns_socks5" does not exist, it will be ignored when loading from the YAML file "config/03/config.yml"
|
||||
╭────────────── Caption ───────────────╮
|
||||
<pre>╭────────────── Caption ───────────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
│ Modified value │
|
||||
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
||||
|
|
@ -17,5 +15,6 @@ Variables:
|
|||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 SOCKS port: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 SOCKS host version used by proxy: <span style="color: #ffd700">v5</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Address for which proxy will be desactivated:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: true ◀ loaded from the YAML file "config/03/config.yml" (⏳ <span style="color: #00aa00">false</span>)
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -15,5 +15,6 @@ Variables:
|
|||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 SOCKS port: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 SOCKS host version used by proxy: v4 ◀ loaded from the YAML file "config/04/config.yml" (⏳ <span style="color: #00aa00">v5</span>)
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Address for which proxy will be desactivated:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
|
|
|
|||
19
tree.html
19
tree.html
|
|
@ -25,17 +25,18 @@
|
|||
</head>
|
||||
<body>
|
||||
<h1>Directory Tree</h1><p>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./">.</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/">firefox</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/10-manual.yml">10-manual.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/20-manual.yml">20-manual.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/30-auto.yml">30-auto.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./">.</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/">firefox</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/10-manual.yml">10-manual.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/20-manual.yml">20-manual.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/30-auto.yml">30-auto.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br>
|
||||
<br><br><p>
|
||||
|
||||
2 directories, 6 files
|
||||
2 directories, 7 files
|
||||
|
||||
</p>
|
||||
<hr>
|
||||
|
|
|
|||
Loading…
Reference in a new issue