[tutorial v1.1_001)] A first variable with only a name (config and doc)
This commit is contained in:
parent
bf27d1af4a
commit
db41060b7c
14 changed files with 130 additions and 12 deletions
102
README.md
102
README.md
|
|
@ -1,8 +1,9 @@
|
||||||
- [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_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_000)] An empty structured file with format version
|
# [tutorial v1.1_001)] A first variable with only a name
|
||||||
|
|
||||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000)
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001)
|
||||||
|
|
||||||
|
|
||||||
## Screenshot
|
## Screenshot
|
||||||
|
|
@ -28,7 +29,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_000
|
git switch --detach v1.1_001
|
||||||
```
|
```
|
||||||
|
|
||||||
## Structure
|
## Structure
|
||||||
|
|
@ -36,9 +37,9 @@ git switch --detach v1.1_000
|
||||||
|
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./">.</a><br/>
|
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./">.</a><br/>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/">firefox</a><br/>
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./firefox/">firefox</a><br/>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||||
<br/><br/></p>
|
<br/><br/></p>
|
||||||
|
|
||||||
Contents of the firefox/00-proxy.yml file
|
Contents of the firefox/00-proxy.yml file
|
||||||
|
|
@ -47,9 +48,32 @@ Contents of the firefox/00-proxy.yml file
|
||||||
%YAML 1.2
|
%YAML 1.2
|
||||||
---
|
---
|
||||||
version: 1.1
|
version: 1.1
|
||||||
|
|
||||||
|
proxy_mode:
|
||||||
...
|
...
|
||||||
|
|
||||||
```
|
```
|
||||||
|
### Let's generate the documentation
|
||||||
|
|
||||||
|
```shell
|
||||||
|
rougail -m firefox/ -o doc
|
||||||
|
```
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | |
|
||||||
|
|
||||||
|
### Let's generate the changelog
|
||||||
|
|
||||||
|
```shell
|
||||||
|
rougail -m firefox/ -o doc --doc.contents changelog
|
||||||
|
```
|
||||||
|
#### New variable
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | |
|
||||||
|
|
||||||
|
|
||||||
## User datas
|
## User datas
|
||||||
|
|
||||||
### Example 1
|
### Example 1
|
||||||
|
|
@ -65,7 +89,69 @@ version: 1.1
|
||||||
```shell
|
```shell
|
||||||
rougail -m firefox/ -u yaml -yf config/01/config.yml
|
rougail -m firefox/ -u yaml -yf config/01/config.yml
|
||||||
```
|
```
|
||||||
<pre></pre>
|
<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>
|
||||||
|
#### Output in read write mode
|
||||||
|
|
||||||
|
```shell
|
||||||
|
rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write
|
||||||
|
```
|
||||||
|
<pre>╭─────── Caption ────────╮
|
||||||
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||||
|
╰────────────────────────╯
|
||||||
|
Variables:
|
||||||
|
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">null</span>
|
||||||
|
</pre>
|
||||||
|
### Example 2
|
||||||
|
|
||||||
|
#### config/02/config.yml
|
||||||
|
|
||||||
|
|
||||||
- [[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))
|
```yml
|
||||||
|
---
|
||||||
|
proxy_mode: No proxy
|
||||||
|
```
|
||||||
|
#### Output
|
||||||
|
|
||||||
|
```shell
|
||||||
|
rougail -m firefox/ -u yaml -yf config/02/config.yml
|
||||||
|
```
|
||||||
|
<pre>╭──────── Caption ────────╮
|
||||||
|
│ Variable Modified value │
|
||||||
|
╰─────────────────────────╯
|
||||||
|
Variables:
|
||||||
|
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yml"
|
||||||
|
</pre>
|
||||||
|
### Example 3
|
||||||
|
|
||||||
|
#### config/03/config.yml
|
||||||
|
|
||||||
|
|
||||||
|
```yml
|
||||||
|
---
|
||||||
|
proxy_mode: 1
|
||||||
|
```
|
||||||
|
#### Output
|
||||||
|
|
||||||
|
```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>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/03/config.yml"
|
||||||
|
<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>
|
||||||
|
#### Output when invalid user datas is an error
|
||||||
|
|
||||||
|
```shell
|
||||||
|
rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_error
|
||||||
|
```
|
||||||
|
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||||
|
<span style="color: #ff0000">┗━━ </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/03/config.yml"
|
||||||
|
</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))
|
||||||
|
|
|
||||||
1
config/01/cmd_rw.txt
Normal file
1
config/01/cmd_rw.txt
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write
|
||||||
|
|
@ -1 +1,4 @@
|
||||||
<pre></pre>
|
<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>
|
||||||
|
|
|
||||||
6
config/01/output_rw.html
Normal file
6
config/01/output_rw.html
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
<pre>╭─────── Caption ────────╮
|
||||||
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||||
|
╰────────────────────────╯
|
||||||
|
Variables:
|
||||||
|
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">null</span>
|
||||||
|
</pre>
|
||||||
1
config/02/cmd_ro.txt
Normal file
1
config/02/cmd_ro.txt
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
rougail -m firefox/ -u yaml -yf config/02/config.yml
|
||||||
2
config/02/config.yml
Normal file
2
config/02/config.yml
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
---
|
||||||
|
proxy_mode: No proxy
|
||||||
6
config/02/output_ro.html
Normal file
6
config/02/output_ro.html
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
<pre>╭──────── Caption ────────╮
|
||||||
|
│ Variable Modified value │
|
||||||
|
╰─────────────────────────╯
|
||||||
|
Variables:
|
||||||
|
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy ◀ loaded from the YAML file "config/02/config.yml"
|
||||||
|
</pre>
|
||||||
1
config/03/cmd_invalid.txt
Normal file
1
config/03/cmd_invalid.txt
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_error
|
||||||
1
config/03/cmd_ro.txt
Normal file
1
config/03/cmd_ro.txt
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
rougail -m firefox/ -u yaml -yf config/03/config.yml
|
||||||
2
config/03/config.yml
Normal file
2
config/03/config.yml
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
---
|
||||||
|
proxy_mode: 1
|
||||||
3
config/03/output_invalid.html
Normal file
3
config/03/output_invalid.html
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||||
|
<span style="color: #ff0000">┗━━ </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/03/config.yml"
|
||||||
|
</pre>
|
||||||
6
config/03/output_ro.html
Normal file
6
config/03/output_ro.html
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
<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/03/config.yml"
|
||||||
|
<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>
|
||||||
BIN
firefox.png
BIN
firefox.png
Binary file not shown.
|
Before Width: | Height: | Size: 123 KiB After Width: | Height: | Size: 119 KiB |
|
|
@ -25,9 +25,9 @@
|
||||||
</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_000/./">.</a><br>
|
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./">.</a><br>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/">firefox</a><br>
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./firefox/">firefox</a><br>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
||||||
<br><br><p>
|
<br><br><p>
|
||||||
|
|
||||||
2 directories, 1 file
|
2 directories, 1 file
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue