[tutorial v1.1_040)] A disabled family (config and doc)
This commit is contained in:
parent
f68fb3e6f1
commit
f401a34d90
6 changed files with 63 additions and 90 deletions
106
README.md
106
README.md
|
|
@ -1,11 +1,11 @@
|
||||||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||||
- [[tutorial v1.1_032] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_032~1..v1.1_032))
|
- [[tutorial v1.1_033] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033))
|
||||||
|
|
||||||
# [tutorial v1.1_033)] A variable with type "boolean"
|
# [tutorial v1.1_040)] A disabled family
|
||||||
|
|
||||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033)
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040)
|
||||||
|
|
||||||
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"boolean")
|
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-disabled-family)
|
||||||
|
|
||||||
|
|
||||||
## Screenshot
|
## Screenshot
|
||||||
|
|
@ -31,7 +31,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
|
||||||
Then switch to the tutorial page:
|
Then switch to the tutorial page:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
git switch --detach v1.1_033
|
git switch --detach v1.1_040
|
||||||
```
|
```
|
||||||
|
|
||||||
## Structure
|
## Structure
|
||||||
|
|
@ -39,14 +39,14 @@ git switch --detach v1.1_033
|
||||||
|
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./">.</a><br/>
|
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./">.</a><br/>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./firefox/">firefox</a><br/>
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./firefox/">firefox</a><br/>
|
||||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||||
<br/><br/></p>
|
<br/><br/></p>
|
||||||
|
|
||||||
Contents of the firefox/20-manual.yml file
|
Contents of the firefox/10-manual.yml file
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
%YAML 1.2
|
%YAML 1.2
|
||||||
|
|
@ -54,8 +54,21 @@ Contents of the firefox/20-manual.yml file
|
||||||
version: 1.1
|
version: 1.1
|
||||||
|
|
||||||
manual:
|
manual:
|
||||||
|
description: Manual proxy configuration
|
||||||
|
disabled: true
|
||||||
|
|
||||||
use_for_https: true # Also use this proxy for HTTPS
|
http_proxy: # HTTP Proxy
|
||||||
|
|
||||||
|
address:
|
||||||
|
description: HTTP address
|
||||||
|
type: domainname
|
||||||
|
params:
|
||||||
|
allow_ip: true
|
||||||
|
|
||||||
|
port:
|
||||||
|
description: HTTP Port
|
||||||
|
type: port
|
||||||
|
default: 8080
|
||||||
...
|
...
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -68,39 +81,17 @@ rougail -m firefox/ -o doc
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **proxy_mode**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>- No proxy **← (default)**<br/>- Auto-detect proxy settings for this network<br/>- Use system proxy settings<br/>- Manual proxy configuration<br/>- Automatic proxy configuration URL |
|
| **proxy_mode**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>- No proxy **← (default)**<br/>- Auto-detect proxy settings for this network<br/>- Use system proxy settings<br/>- Manual proxy configuration<br/>- Automatic proxy configuration URL |
|
||||||
|
|
||||||
#### Manual proxy configuration
|
|
||||||
|
|
||||||
**manual**
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### HTTP Proxy
|
|
||||||
|
|
||||||
**manual.http_proxy**
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **manual.http_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.<br/>**Validator**: the domain name can be an IP |
|
|
||||||
| **manual.http_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP Port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: 8080 |
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **manual.use_for_https**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
|
|
||||||
|
|
||||||
### Let's generate the changelog
|
### Let's generate the changelog
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
rougail -m firefox/ -o doc --doc.contents changelog
|
rougail -m firefox/ -o doc --doc.contents changelog
|
||||||
```
|
```
|
||||||
#### New variable
|
#### Deleted variables
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **manual.use_for_https**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
|
|
||||||
|
|
||||||
|
|
||||||
|
- manual.http_proxy.address
|
||||||
|
- manual.http_proxy.port
|
||||||
|
- manual.use_for_https
|
||||||
## User datas
|
## User datas
|
||||||
|
|
||||||
### Example 1
|
### Example 1
|
||||||
|
|
@ -110,26 +101,17 @@ rougail -m firefox/ -o doc --doc.contents changelog
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
---
|
---
|
||||||
manual:
|
|
||||||
http_proxy:
|
|
||||||
address: example.net
|
|
||||||
```
|
```
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
rougail -m firefox/ -u yaml -yf config/01/config.yml
|
rougail -m firefox/ -u yaml -yf config/01/config.yml
|
||||||
```
|
```
|
||||||
<pre>╭──────── Caption ────────╮
|
<pre>╭─────── Caption ────────╮
|
||||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||||
│ Modified value │
|
╰────────────────────────╯
|
||||||
╰─────────────────────────╯
|
|
||||||
Variables:
|
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>📂 Manual proxy configuration
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📂 HTTP Proxy
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 HTTP address: example.net ◀ loaded from the YAML file "config/01/config.yml"
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP Port: <span style="color: #ffd700">8080</span>
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 Also use this proxy for HTTPS: <span style="color: #ffd700">true</span>
|
|
||||||
</pre>
|
</pre>
|
||||||
### Example 2
|
### Example 2
|
||||||
|
|
||||||
|
|
@ -138,9 +120,11 @@ Variables:
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
---
|
---
|
||||||
|
proxy_mode: Manual proxy configuration
|
||||||
manual:
|
manual:
|
||||||
http_proxy:
|
http_proxy:
|
||||||
address: example.net
|
address: http.proxy.net
|
||||||
|
port: 3128
|
||||||
use_for_https: false
|
use_for_https: false
|
||||||
```
|
```
|
||||||
#### Output
|
#### Output
|
||||||
|
|
@ -148,19 +132,17 @@ manual:
|
||||||
```shell
|
```shell
|
||||||
rougail -m firefox/ -u yaml -yf config/02/config.yml
|
rougail -m firefox/ -u yaml -yf config/02/config.yml
|
||||||
```
|
```
|
||||||
<pre>╭────────────── Caption ───────────────╮
|
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
||||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/02/config.yml"
|
||||||
│ Modified value │
|
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/02/config.yml"
|
||||||
|
<span style="color: #ffff00">┗━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.use_for_https" (Also use this proxy for HTTPS) will be ignored when loading from the YAML file "config/02/config.yml"
|
||||||
|
╭────────────── Caption ───────────────╮
|
||||||
|
│ Variable Modified value │
|
||||||
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
||||||
╰──────────────────────────────────────╯
|
╰──────────────────────────────────────╯
|
||||||
Variables:
|
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: Manual proxy configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
||||||
<span style="color: #5c5cff">┗━━ </span>📂 Manual proxy configuration
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📂 HTTP Proxy
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 HTTP address: example.net ◀ loaded from the YAML file "config/02/config.yml"
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP Port: <span style="color: #ffd700">8080</span>
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/02/config.yml" (⏳ <span style="color: #00aa00">true</span>)
|
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
|
|
||||||
- [[tutorial v1.1_040] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040))
|
- [[tutorial v1.1_041] A conditional disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_041/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041))
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1 @@
|
||||||
---
|
---
|
||||||
manual:
|
|
||||||
http_proxy:
|
|
||||||
address: example.net
|
|
||||||
|
|
|
||||||
|
|
@ -1,12 +1,6 @@
|
||||||
<pre>╭──────── Caption ────────╮
|
<pre>╭─────── Caption ────────╮
|
||||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||||
│ Modified value │
|
╰────────────────────────╯
|
||||||
╰─────────────────────────╯
|
|
||||||
Variables:
|
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>📂 Manual proxy configuration
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📂 HTTP Proxy
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 HTTP address: example.net ◀ loaded from the YAML file "config/01/config.yml"
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP Port: <span style="color: #ffd700">8080</span>
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 Also use this proxy for HTTPS: <span style="color: #ffd700">true</span>
|
|
||||||
</pre>
|
</pre>
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,7 @@
|
||||||
---
|
---
|
||||||
|
proxy_mode: Manual proxy configuration
|
||||||
manual:
|
manual:
|
||||||
http_proxy:
|
http_proxy:
|
||||||
address: example.net
|
address: http.proxy.net
|
||||||
|
port: 3128
|
||||||
use_for_https: false
|
use_for_https: false
|
||||||
|
|
|
||||||
|
|
@ -1,13 +1,11 @@
|
||||||
<pre>╭────────────── Caption ───────────────╮
|
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
||||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/02/config.yml"
|
||||||
│ Modified value │
|
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/02/config.yml"
|
||||||
|
<span style="color: #ffff00">┗━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.use_for_https" (Also use this proxy for HTTPS) will be ignored when loading from the YAML file "config/02/config.yml"
|
||||||
|
╭────────────── Caption ───────────────╮
|
||||||
|
│ Variable Modified value │
|
||||||
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
||||||
╰──────────────────────────────────────╯
|
╰──────────────────────────────────────╯
|
||||||
Variables:
|
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: Manual proxy configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
||||||
<span style="color: #5c5cff">┗━━ </span>📂 Manual proxy configuration
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📂 HTTP Proxy
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 HTTP address: example.net ◀ loaded from the YAML file "config/02/config.yml"
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP Port: <span style="color: #ffd700">8080</span>
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/02/config.yml" (⏳ <span style="color: #00aa00">true</span>)
|
|
||||||
</pre>
|
</pre>
|
||||||
|
|
|
||||||
10
tree.html
10
tree.html
|
|
@ -25,11 +25,11 @@
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>Directory Tree</h1><p>
|
<h1>Directory Tree</h1><p>
|
||||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./">.</a><br>
|
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./">.</a><br>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./firefox/">firefox</a><br>
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./firefox/">firefox</a><br>
|
||||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
||||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./firefox/10-manual.yml">10-manual.yml</a><br>
|
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./firefox/10-manual.yml">10-manual.yml</a><br>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/./firefox/20-manual.yml">20-manual.yml</a><br>
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/./firefox/20-manual.yml">20-manual.yml</a><br>
|
||||||
<br><br><p>
|
<br><br><p>
|
||||||
|
|
||||||
2 directories, 3 files
|
2 directories, 3 files
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue