[tutorial 011] Conditional desactived family (config and doc)
This commit is contained in:
parent
8613880131
commit
2709913b05
1 changed files with 8 additions and 12 deletions
20
README.md
20
README.md
|
@ -13,6 +13,7 @@ include_toc: true
|
|||
- [[tutorial 006] A variable with type choice](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_006/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_006~1..v1.1_006))
|
||||
- [[tutorial 007] Choice type is optional](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_007/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_007~1..v1.1_007))
|
||||
- [[tutorial 010] A family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010))
|
||||
- [[tutorial 011] Conditional desactived family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_011/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011))
|
||||
|
||||
|
||||
# Description
|
||||
|
@ -20,20 +21,11 @@ include_toc: true
|
|||
|
||||
<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
|
||||
|
||||
A family
|
||||
Conditional desactived family
|
||||
|
||||
The "manual" mode structural descriptions are write in a new files to separate things. But Rougail will concatenate variables and families.
|
||||
This family will be desactived if "proxy_mode" is not "manual proxy configuration".
|
||||
|
||||
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.
|
||||
Desactived a variable or a family means that this variable will never be accessible.
|
||||
|
||||
# Structure
|
||||
|
||||
|
@ -62,6 +54,10 @@ proxy_mode:
|
|||
manual:
|
||||
description: Manual proxy configuration
|
||||
type: family
|
||||
disabled:
|
||||
type: variable
|
||||
variable: proxy_mode
|
||||
when_not: 'Manual proxy configuration'
|
||||
|
||||
```
|
||||
## Generated documentation
|
||||
|
|
Loading…
Reference in a new issue