Commit graph

18 commits

Author SHA1 Message Date
2709913b05 [tutorial 011] Conditional desactived family (config and doc) 2024-09-07 19:06:33 +02:00
8613880131 [tutorial 010] A family
The "manual" mode structural descriptions are write in a new files to separate things. But Rougail will concatenate variables and families.

We create a family, which will contain other variables.

This family has:

- a description
- a type

As there is no variable inside this family, the type is mandatory. Without it, Rougail will create a variable.

In fact, this family will be deleted by Rougail too because it is empty.
2024-09-07 19:06:33 +02:00
bd5e2c3bf6 [tutorial 010] A family (config and doc) 2024-09-07 19:06:32 +02:00
b0323f2621 [tutorial 007] Choice type is optional
The type is optional in choice type (if we have choices attributes, it's a choice option).
2024-09-07 19:06:32 +02:00
2742559f6c [tutorial 007] Choice type is optional (config and doc) 2024-09-07 19:06:32 +02:00
cb298bcb68 [tutorial 006] A variable with type choice
"Foo" should not be an option to the "proxy_mode" variable.

Now the "proxy_mode" type is "choice", that means that there is a list of available values that can be selected.

We say that the "proxy_mode" variable is constrained (by choices): this variable accept, in fact, only a list of choices.
2024-09-07 19:06:31 +02:00
6dbf03291b [tutorial 006] A variable with type choice (config and doc) 2024-09-07 19:06:31 +02:00
58f8783710 [tutorial 005] A default value
Now we can define the default value of this variable.

If the user doesn't touch this variable's value, the value is "No proxy"

As user intervention is no more required, so the variable change it's default mode too (from "basic" to "standard").
2024-09-07 19:06:30 +02:00
f9aa793a86 [tutorial 005] A default value (config and doc) 2024-09-07 19:06:30 +02:00
fb7542ed97 [tutorial 004] The variable description
We can add a description to this first variable.

This information is useful for:

- documentation
- error message
- help user to known which value to set to this variable (for example with [the user data plugin Questionary](https://forge.cloud.silique.fr/gnunux/rougail-user-data-questionary)).
2024-09-07 19:06:29 +02:00
1b2f09b8da [tutorial 004] The variable description (config and doc) 2024-09-07 19:06:29 +02:00
103cb5760b [tutorial 003] A first variable
In the Firefox configuration, it is possible to define several configuration modes,
from no proxy at all ("No proxy") to a kind of automatic configuration mode from a file
("Automatic proxy configuration URL").

We’re gonna create a first variable called "proxy_mode":

- accepts only a string as value
- requires a value (that is, None is not an option)
2024-09-07 19:06:28 +02:00
35480173a8 [tutorial 003] A first variable (config and doc) 2024-09-07 19:06:28 +02:00
7ea014c4a4 [tutorial 002] A first variable
In the Firefox configuration, it is possible to define several configuration modes,
from no proxy at all ("No proxy") to a kind of automatic configuration mode from a file
("Automatic proxy configuration URL").

We’re gonna create a first variable called "proxy_mode":

- accepts only a string as value
- requires a value (that is, None is not an option)
2024-09-07 19:06:27 +02:00
c9186bff17 [tutorial 002] A first variable (config and doc) 2024-09-07 19:06:27 +02:00
cade5ad594 [tutorial 001] An empty file 2024-09-07 19:06:26 +02:00
8146d74bf6 [tutorial 001] An empty file (config and doc) 2024-09-07 19:06:26 +02:00
3ab1f5bc2b [init] Discover Rougail 2024-09-07 19:06:25 +02:00