|
|
|
|
@ -1,9 +1,9 @@
|
|
|
|
|
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
|
|
|
|
- [[tutorial v1.1_000] An empty structured file with format version](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000))
|
|
|
|
|
- [[tutorial v1.1_001] A first variable with only a name](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001))
|
|
|
|
|
|
|
|
|
|
# [tutorial v1.1_001)] A first variable with only a name
|
|
|
|
|
# [tutorial v1.1_002)] Describe the variable
|
|
|
|
|
|
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001)
|
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Screenshot
|
|
|
|
|
@ -23,142 +23,33 @@
|
|
|
|
|
---
|
|
|
|
|
version: 1.1
|
|
|
|
|
|
|
|
|
|
proxy_mode:
|
|
|
|
|
proxy_mode: # Configure Proxy Access to the Internet
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
### Let's generate the documentation
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_001
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_002
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -o doc
|
|
|
|
|
```
|
|
|
|
|
| Variable | Description |
|
|
|
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
|
|
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | |
|
|
|
|
|
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. |
|
|
|
|
|
|
|
|
|
|
### Let's generate the changelog
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_001
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_002
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
|
|
|
|
|
```
|
|
|
|
|
#### New variable
|
|
|
|
|
#### Modified variable
|
|
|
|
|
|
|
|
|
|
| Variable | Description |
|
|
|
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
|
|
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | |
|
|
|
|
|
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | <ins>Configure Proxy Access to the Internet.</ins> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## User datas
|
|
|
|
|
|
|
|
|
|
### Example 1
|
|
|
|
|
|
|
|
|
|
#### config/01/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_001
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
|
|
|
|
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
|
|
|
|
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>proxy_mode
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 2
|
|
|
|
|
|
|
|
|
|
#### config/02/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: No proxy
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_001
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre>╭──────── Caption ────────╮
|
|
|
|
|
│ Variable Modified value │
|
|
|
|
|
╰─────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yaml"
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 3
|
|
|
|
|
|
|
|
|
|
#### config/03/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: Manual proxy configuration
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_001
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre>╭──────── Caption ────────╮
|
|
|
|
|
│ Variable Modified value │
|
|
|
|
|
╰─────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml"
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 4
|
|
|
|
|
|
|
|
|
|
#### config/04/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: foo
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_001
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre>╭──────── Caption ────────╮
|
|
|
|
|
│ Variable Modified value │
|
|
|
|
|
╰─────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: foo ◀ loaded from the YAML file "config/04/config.yaml"
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 5
|
|
|
|
|
|
|
|
|
|
#### config/05/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: 1
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_001
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
|
|
|
|
<span style="color: #ffff00">┗━━ </span>the value "1" is an invalid string for "proxy_mode", which is not a string, it will be ignored when loading from the YAML file "config/05/config.yaml"
|
|
|
|
|
<span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
|
|
|
|
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
|
|
|
|
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>proxy_mode
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- [[tutorial v1.1_002] Describe the variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002))
|
|
|
|
|
- [[tutorial v1.1_003] Set a default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003))
|
|
|
|
|
|
