Compare commits

..

79 commits

Author SHA1 Message Date
6ec1a18922 Summary 2025-12-02 16:19:31 +01:00
192941aa90 [tutorial v1.1_120] xxx 2025-12-02 16:19:31 +01:00
98d3b5ff23 [tutorial v1.1_120] xxx (config and doc) 2025-12-02 16:19:31 +01:00
b70fe2a52b [tutorial v1.1_114] xxx 2025-12-02 16:19:29 +01:00
e670e92f7f [tutorial v1.1_114] xxx (config and doc) 2025-12-02 16:19:29 +01:00
ff9adfbaf4 [tutorial v1.1_113] xxx 2025-12-02 16:19:27 +01:00
70f4d87b34 [tutorial v1.1_113] xxx (config and doc) 2025-12-02 16:19:27 +01:00
69265edce6 [tutorial v1.1_112] xxx 2025-12-02 16:19:25 +01:00
db3dd0c915 [tutorial v1.1_112] xxx (config and doc) 2025-12-02 16:19:25 +01:00
adbeec79a2 [tutorial v1.1_111] xxx 2025-12-02 16:19:23 +01:00
7fef7d35df [tutorial v1.1_111] xxx (config and doc) 2025-12-02 16:19:23 +01:00
99415b5db4 [tutorial v1.1_110] Namespace 2025-12-02 16:19:21 +01:00
a9b5ce6672 [tutorial v1.1_110] Namespace (config and doc) 2025-12-02 16:19:21 +01:00
dc9d0d650e [tutorial v1.1_103] A variable with custom validation 2025-12-02 16:19:19 +01:00
a95aaba039 [tutorial v1.1_103] A variable with custom validation (config and doc) 2025-12-02 16:19:19 +01:00
9ea6478140 [tutorial v1.1_102] A web_address variable 2025-12-02 16:19:17 +01:00
eed80ef7a8 [tutorial v1.1_102] A web_address variable (config and doc) 2025-12-02 16:19:17 +01:00
1b94f06cbd [tutorial v1.1_101] A choice variable 2025-12-02 16:19:15 +01:00
81d569057b [tutorial v1.1_101] A choice variable (config and doc) 2025-12-02 16:19:15 +01:00
0838dab66c [tutorial v1.1_100] A boolean variable 2025-12-02 16:19:13 +01:00
d8410e6189 [tutorial v1.1_100] A boolean variable (config and doc) 2025-12-02 16:19:13 +01:00
70b6b92bb8 [tutorial v1.1_098] A variable in avanced mode 2025-12-02 16:19:11 +01:00
7e41d54635 [tutorial v1.1_098] A variable in avanced mode (config and doc) 2025-12-02 16:19:11 +01:00
124ddd9821 [tutorial v1.1_097] A Jinja conditional disabled boolean variable 2025-12-02 16:19:09 +01:00
36a77f4c6c [tutorial v1.1_097] A Jinja conditional disabled boolean variable (config and doc) 2025-12-02 16:19:09 +01:00
94af5caed3 [tutorial v1.1_096] A boolean variable 2025-12-02 16:19:07 +01:00
d5287cbb6b [tutorial v1.1_096] A boolean variable (config and doc) 2025-12-02 16:19:07 +01:00
71d0065215 [tutorial v1.1_095] A conditional disabled boolean variable 2025-12-02 16:19:05 +01:00
ae7897072f [tutorial v1.1_095] A conditional disabled boolean variable (config and doc) 2025-12-02 16:19:05 +01:00
5baad602cf [tutorial v1.1_094] Help 2025-12-02 16:19:03 +01:00
c9c905196c [tutorial v1.1_094] Help (config and doc) 2025-12-02 16:19:03 +01:00
6526f9957f [tutorial v1.1_093] Examples 2025-12-02 16:19:01 +01:00
5734c3f596 [tutorial v1.1_093] Examples (config and doc) 2025-12-02 16:19:01 +01:00
14780700da [tutorial v1.1_092] A non mandatory variable 2025-12-02 16:18:59 +01:00
0b48de05c5 [tutorial v1.1_092] A non mandatory variable (config and doc) 2025-12-02 16:18:59 +01:00
e38c525704 [tutorial v1.1_091] A variable with multiple value 2025-12-02 16:18:57 +01:00
e3b1907dda [tutorial v1.1_091] A variable with multiple value (config and doc) 2025-12-02 16:18:57 +01:00
8038bf50d6 [tutorial v1.1_090] A conditional disabled variable with type domainname and parameters 2025-12-02 16:18:55 +01:00
87d2415393 [tutorial v1.1_090] A conditional disabled variable with type domainname and parameters (config and doc) 2025-12-02 16:18:55 +01:00
eb378a5f20 [tutorial v1.1_080] A conditional disabled variable with type web_address 2025-12-02 16:18:53 +01:00
8110098a15 [tutorial v1.1_080] A conditional disabled variable with type web_address (config and doc) 2025-12-02 16:18:53 +01:00
79b1619466 [tutorial v1.1_072] Jinja with a parameter 2025-12-02 16:18:51 +01:00
d7fd4fc49d [tutorial v1.1_072] Jinja with a parameter (config and doc) 2025-12-02 16:18:51 +01:00
03ea8ea958 [tutorial v1.1_071] Jinja with a description 2025-12-02 16:18:49 +01:00
b6b5ddfd7f [tutorial v1.1_071] Jinja with a description (config and doc) 2025-12-02 16:18:49 +01:00
450da5d033 [tutorial v1.1_070] A conditional hidden family with Jinja 2025-12-02 16:18:48 +01:00
207ac870e3 [tutorial v1.1_070] A conditional hidden family with Jinja (config and doc) 2025-12-02 16:18:48 +01:00
d7cbdf36c1 [tutorial v1.1_061] A conditional disabled variable with dynamic identifier 2025-12-02 16:18:46 +01:00
39e9533d78 [tutorial v1.1_061] A conditional disabled variable with dynamic identifier (config and doc) 2025-12-02 16:18:46 +01:00
c18b3a74c4 [tutorial v1.1_060] Family: a dynamic family 2025-12-02 16:18:44 +01:00
dab61166c3 [tutorial v1.1_060] Family: a dynamic family (config and doc) 2025-12-02 16:18:44 +01:00
28556c040e [tutorial v1.1_050] A calculated default value 2025-12-02 16:18:42 +01:00
beba7389d7 [tutorial v1.1_050] A calculated default value (config and doc) 2025-12-02 16:18:42 +01:00
014fb38246 [tutorial v1.1_043] A conditional hidden family 2025-12-02 16:18:41 +01:00
1beaee99a3 [tutorial v1.1_043] A conditional hidden family (config and doc) 2025-12-02 16:18:41 +01:00
f01bc1968d [tutorial v1.1_042] Copy HTTP manual proxy to HTTPS manual proxy 2025-12-02 16:18:39 +01:00
b9b4fe3cf7 [tutorial v1.1_042] Copy HTTP manual proxy to HTTPS manual proxy (config and doc) 2025-12-02 16:18:39 +01:00
bb55ec23b1 [tutorial v1.1_041] A conditional disabled family 2025-12-02 16:18:37 +01:00
2c67062333 [tutorial v1.1_041] A conditional disabled family (config and doc) 2025-12-02 16:18:37 +01:00
58c127fa33 [tutorial v1.1_040] A disabled family 2025-12-02 16:18:36 +01:00
03c5ad948c [tutorial v1.1_040] A disabled family (config and doc) 2025-12-02 16:18:36 +01:00
cb68fcb01f [tutorial v1.1_033] A variable with type "boolean" 2025-12-02 16:18:34 +01:00
a5b2a95756 [tutorial v1.1_033] A variable with type "boolean" (config and doc) 2025-12-02 16:18:34 +01:00
88f6eac51c [tutorial v1.1_032] A variable with type "port" 2025-12-02 16:18:32 +01:00
0bf261f16d [tutorial v1.1_032] A variable with type "port" (config and doc) 2025-12-02 16:18:32 +01:00
b864af407d [tutorial v1.1_031] A variable with type's parameters 2025-12-02 16:18:31 +01:00
021d393364 [tutorial v1.1_031] A variable with type's parameters (config and doc) 2025-12-02 16:18:31 +01:00
ed95497ecb [tutorial v1.1_030] A variable with type "domainname" 2025-12-02 16:18:29 +01:00
4a32aaa0ed [tutorial v1.1_030] A variable with type "domainname" (config and doc) 2025-12-02 16:18:29 +01:00
f9f8ce3f2e [tutorial v1.1_022] Putting a variable inside of a family or a sub family 2025-12-02 16:18:27 +01:00
9e55aba5b7 [tutorial v1.1_022] Putting a variable inside of a family or a sub family (config and doc) 2025-12-02 16:18:27 +01:00
f945353fcb [tutorial v1.1_021] Or a sub family
Inside a family, we can have variables or families.

The "type" for family "manual" became unecessary because container an other family, so it's not a variable.
The description can now be has family comment.

In disabled attribute, it's better tu use relative path (we will see the reason in an other slide).
2025-12-02 16:18:26 +01:00
237e232f37 [tutorial v1.1_021] Or a sub family (config and doc) 2025-12-02 16:18:26 +01:00
ca94fb50f4 [tutorial v1.1_020] Creating a new family 2025-12-02 16:18:24 +01:00
87694dd4c2 [tutorial v1.1_020] Creating a new family (config and doc) 2025-12-02 16:18:24 +01:00
54da5c2fd5 [tutorial v1.1_010] A variable with a list of possible values 2025-12-02 16:18:23 +01:00
f3e54d00a3 [tutorial v1.1_010] A variable with a list of possible values (config and doc) 2025-12-02 16:18:23 +01:00
4c754617f1 [tutorial v1.1_003] Set a default value 2025-12-02 16:18:21 +01:00
7cdfa095b2 [tutorial v1.1_003] Set a default value (config and doc) 2025-12-02 16:18:21 +01:00
16 changed files with 73 additions and 220 deletions

205
README.md
View file

@ -1,26 +1,24 @@
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[tutorial v1.1_001] Lets add our first variable](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))
# Description
# [tutorial v1.1_002] Describe the variable
This tutorial shows to you an example of Rougail use on how to set a proxy in the Mozilla Firefox browser.
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002)
More precisely, this tutorial aims at reproducing this [Mozilla Firefox](https://www.mozilla.org/firefox/new/) settings page:
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#describe-the-variable)
![Firefox Proxy setting](firefox.png)
And the integration of part of the [Firefox FoxyProxy plugin](https://addons.mozilla.org/firefox/addon/foxyproxy-standard/).
## Screenshot
The idea is to have a namespace specific to FoxyProxy and to find in it part of the settings that we will have made in the main namespace.
This is what the page looks like:
<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
## Clone and install
![Foxyproxy Proxy setting](foxyproxy.png)
# Installation
To test this tutorial, you need to download this repository and install Rougail:
```shell
```bash
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
cd rougail-tutorials
python -m venv venv_rougail
@ -28,126 +26,69 @@ python -m venv venv_rougail
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
```
Then switch to the tutorial page:
# Summary
```shell
git switch --detach v1.1_002
```
Each step is a separerate commit. You can navigate to history to discover different aspect to the Rougail format.
## Structure
- Getting started
- [[tutorial v1.1_000] Creating a structure file](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#creating-a-structure-file) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000))
- [[tutorial v1.1_001] Lets add our first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#let-s-add-our-first-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001))
- [[tutorial v1.1_002] Describe the variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#describe-the-variable) - [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) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#set-a-default-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003))
- A variable with a list of possible values
- [[tutorial v1.1_010] A variable with a list of possible values](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#a-variable-with-a-list-of-possible-values) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010))
- Group variables inside "families"
- [[tutorial v1.1_020] Creating a new family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#creating-a-new-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020))
- [[tutorial v1.1_021] Or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#or-a-sub-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021))
- [[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) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#putting-a-variable-inside-of-a-family-or-a-sub-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022))
- Constrainte the value of a variable with it's type
- [[tutorial v1.1_030] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"domainname") - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030))
- [[tutorial v1.1_031] A variable with type's parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type's-parameters) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031))
- [[tutorial v1.1_032] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"port") - [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) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"boolean") - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033))
- Define access to variable or family
- Property disabled
- [[tutorial v1.1_040] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-disabled-family) - [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) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-disabled-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041))
- Property hidden
- [[tutorial v1.1_042] Copy HTTP manual proxy to HTTPS manual proxy](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_042/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#copy-http-manual-proxy-to-https-manual-proxy) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042))
- [[tutorial v1.1_043] A conditional hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_043/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-hidden-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043))
- Calculated default value for a variable
- [[tutorial v1.1_050] A calculated default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_050/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-calculated-default-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050))
- Dynamic family
- [[tutorial v1.1_060] Family: a dynamic family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_060/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/dynfam.html#family:-a-dynamic-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_060~1..v1.1_060))
- [[tutorial v1.1_061] A conditional disabled variable with dynamic identifier](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/dynfam.html#a-conditional-disabled-variable-with-dynamic-identifier) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_061~1..v1.1_061))
- Playing with Jinja
- [[tutorial v1.1_070] A conditional hidden family with Jinja](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_070/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-hidden-family-with-jinja) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_070~1..v1.1_070))
- [[tutorial v1.1_071] Jinja with a description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_071/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#jinja-with-a-description) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_071~1..v1.1_071))
- [[tutorial v1.1_072] Jinja with a parameter](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_072/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#jinja-with-a-parameter) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_072~1..v1.1_072))
- Various variables
- [[tutorial v1.1_080] A conditional disabled variable with type web_address](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-web_address) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080))
- [[tutorial v1.1_090] A conditional disabled variable with type domainname and parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-domainname-and-parameters) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090))
- Multiple variable
- [[tutorial v1.1_091] A variable with multiple value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_091/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-with-multiple-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_091~1..v1.1_091))
- Mandatory
- [[tutorial v1.1_092] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_092/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-non-mandatory-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_092~1..v1.1_092))
- Extras informations for a variable
- [[tutorial v1.1_093] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_093/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#examples) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_093~1..v1.1_093))
- [[tutorial v1.1_094] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_094/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#help) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_094~1..v1.1_094))
- Various variables
- [[tutorial v1.1_095] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095))
- [[tutorial v1.1_096] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable) - [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) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-jinja-conditional-disabled-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_097~1..v1.1_097))
- Mode
- [[tutorial v1.1_098] A variable in avanced mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-in-avanced-mode) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_098~1..v1.1_098))
- Various variables
- [[tutorial v1.1_100] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100))
- [[tutorial v1.1_101] A choice variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_101/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-choice-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101))
- [[tutorial v1.1_102] A web_address variable ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_102/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-web_address-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102))
- Validators
- [[tutorial v1.1_103] A variable with custom validation](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_103/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-with-custom-validation) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103))
- Namespace
- [[tutorial v1.1_110] Namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#namespace) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110))
- [[tutorial v1.1_111] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111))
- [[tutorial v1.1_112] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_112~1..v1.1_112))
- [[tutorial v1.1_113] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_113/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_113~1..v1.1_113))
- [[tutorial v1.1_114] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_114~1..v1.1_114))
- [[tutorial v1.1_120] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_120~1..v1.1_120))
<p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./">.</a><br/>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./firefox/">firefox</a><br/>
    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
<br/><br/></p>
Contents of the firefox/00-proxy.yml file
```yml
%YAML 1.2
---
version: 1.1
proxy_mode: # Configure Proxy Access to the Internet
...
```
### Let's generate the documentation
```shell
rougail -m firefox/ -o doc
```
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. |
### Let's generate the changelog
```shell
rougail -m firefox/ -o doc --doc.contents changelog
```
#### Modified variable
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<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.yml
```yml
---
```
#### Output
```shell
rougail -m firefox/ -u yaml -yf config/01/config.yml
```
<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>Configure Proxy Access to the Internet
</pre>
#### Output in read write mode
```shell
rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write
```
<pre>╭──────────────────── Caption ─────────────────────╮
<span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #ffd700">Default value</span>
╰──────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">null</span>
</pre>
### Example 2
#### config/02/config.yml
```yml
---
proxy_mode: No proxy
```
#### Output
```shell
rougail -m firefox/ -u yaml -yf config/02/config.yml
```
<pre>╭───────────────────── Caption ─────────────────────╮
<span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span>
╰───────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">No proxy</span> ◀ loaded from the YAML
<span style="color: #5c5cff"> </span>file "config/02/config.yml"
</pre>
### Example 3
#### config/03/config.yml
```yml
---
proxy_mode: foo
```
#### Output
```shell
rougail -m firefox/ -u yaml -yf config/03/config.yml
```
<pre>╭───────────────────── Caption ─────────────────────╮
<span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span>
╰───────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">foo</span> ◀ loaded from the YAML file
<span style="color: #5c5cff"> </span>"config/03/config.yml"
</pre>
- [[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))

View file

@ -1 +0,0 @@
rougail -m firefox/ -u yaml -yf config/01/config.yml

View file

@ -1 +0,0 @@
rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.read_write

View file

@ -1 +0,0 @@
---

View file

@ -1,4 +0,0 @@
<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>Configure Proxy Access to the Internet
</pre>

View file

@ -1,6 +0,0 @@
<pre>╭──────────────────── Caption ─────────────────────╮
<span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #ffd700">Default value</span>
╰──────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">null</span>
</pre>

View file

@ -1 +0,0 @@
rougail -m firefox/ -u yaml -yf config/02/config.yml

View file

@ -1,2 +0,0 @@
---
proxy_mode: No proxy

View file

@ -1,7 +0,0 @@
<pre>╭───────────────────── Caption ─────────────────────╮
<span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span>
╰───────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">No proxy</span> ◀ loaded from the YAML
<span style="color: #5c5cff"> </span>file "config/02/config.yml"
</pre>

View file

@ -1 +0,0 @@
rougail -m firefox/ -u yaml -yf config/03/config.yml

View file

@ -1,2 +0,0 @@
---
proxy_mode: foo

View file

@ -1,7 +0,0 @@
<pre>╭───────────────────── Caption ─────────────────────╮
<span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #00aa00">Modified value</span>
╰───────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">foo</span> ◀ loaded from the YAML file
<span style="color: #5c5cff"> </span>"config/03/config.yml"
</pre>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 119 KiB

After

Width:  |  Height:  |  Size: 123 KiB

View file

@ -1,6 +0,0 @@
%YAML 1.2
---
version: 1.1
proxy_mode: # Configure Proxy Access to the Internet
...

View file

@ -1,5 +0,0 @@
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
cd rougail-tutorials
python -m venv venv_rougail
. venv_rougail/bin/activate
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml

View file

@ -1,44 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="Author" content="Made by 'tree'">
<meta name="GENERATOR" content="tree v2.2.1 © 1996 - 2024 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro">
<title>Directory Tree</title>
<style type="text/css">
BODY { font-family : monospace, sans-serif; color: black;}
P { font-family : monospace, sans-serif; color: black; margin:0px; padding: 0px;}
A:visited { text-decoration : none; margin : 0px; padding : 0px;}
A:link { text-decoration : none; margin : 0px; padding : 0px;}
A:hover { text-decoration: underline; background-color : yellow; margin : 0px; padding : 0px;}
A:active { margin : 0px; padding : 0px;}
.VERSION { font-size: small; font-family : arial, sans-serif; }
.NORM { color: black; }
.FIFO { color: purple; }
.CHAR { color: yellow; }
.DIR { color: blue; }
.BLOCK { color: yellow; }
.LINK { color: aqua; }
.SOCK { color: fuchsia;}
.EXEC { color: green; }
</style>
</head>
<body>
<h1>Directory Tree</h1><p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./">.</a><br>
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./firefox/">firefox</a><br>
&nbsp;&nbsp;&nbsp; └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/./firefox/00-proxy.yml">00-proxy.yml</a><br>
<br><br><p>
2 directories, 1 file
</p>
<hr>
<p class="VERSION">
tree v2.2.1 © 1996 - 2024 by Steve Baker and Thomas Moore <br>
HTML output hacked and copyleft © 1998 by Francesc Rocher <br>
JSON output hacked and copyleft © 2014 by Florian Sesser <br>
Charsets / OS/2 support © 2001 by Kyosuke Tokoro
</p>
</body>
</html>