rougail/doc/family/simple.md

69 lines
1.9 KiB
Markdown
Raw Normal View History

2021-02-06 17:11:17 +01:00
# Une famille
2021-01-30 19:42:46 +01:00
2021-02-12 18:08:28 +01:00
Une famille est un conteneur de variables. Elle peut contenir également des familles.
2021-01-30 19:42:46 +01:00
Pour décrire une famille il faut mettre au minimum un nom :
2021-02-06 16:14:24 +01:00
```
<family name="my_family"/>
```
2021-01-30 19:42:46 +01:00
2021-02-06 17:42:54 +01:00
Cette famille doit être placé dans une balise [variables](../variables.md) :
2021-01-30 19:42:46 +01:00
2021-02-06 16:14:24 +01:00
```
<variables>
2021-02-06 16:01:35 +01:00
<family name="my_family"/>
2021-02-06 16:14:24 +01:00
</variables>
```
2021-01-30 19:42:46 +01:00
2021-02-12 18:08:28 +01:00
Ou dans une autre famille :
```
<variables>
<family name="my_family">
<family name="second_family"/>
</family>
</variables>
2021-02-14 18:03:15 +01:00
```
2021-02-12 18:08:28 +01:00
2021-02-14 18:03:15 +01:00
Attention, une famille vide sera automatiquement supprimée.
2021-02-12 18:08:28 +01:00
2021-02-06 16:28:33 +01:00
## Description et aide de la famille
2021-01-30 19:42:46 +01:00
En plus d'un nom, il est possible de mettre une "description" à la famille. C'est une information "utilisateur" qui nous permettra d'avoir des informations complémentaires sur le contenu de cette famille :
2021-02-06 16:14:24 +01:00
```
<family name="my_family" description="This is a great family"/>
```
2021-01-30 19:42:46 +01:00
En plus de la description, il est possible de préciser une aide complémentaire :
2021-02-06 16:14:24 +01:00
```
<family name="my_family" help="This is a great family"/>
```
2021-01-30 19:42:46 +01:00
2021-02-06 16:01:35 +01:00
## Mode de la famille
2021-01-30 19:42:46 +01:00
2021-02-19 17:06:49 +01:00
Le [mode](../mode.md) par défaut d'une famille correspond au [mode](../mode.md) du mode le plus petit entre la famille parente, les variables enfants ou des familles enfants qui sont contenu dans cette famille.
2021-01-30 19:42:46 +01:00
2021-02-12 18:08:28 +01:00
Changer le [mode](../mode.md) d'une famille permet de définir le [mode](../mode.md) par défaut des variables ou des familles inclusent dans cette famille.
2021-01-30 19:42:46 +01:00
2021-02-06 17:42:54 +01:00
Pour définir le [mode](../mode.md) :
2021-01-30 19:42:46 +01:00
2021-02-06 16:14:24 +01:00
```
<family name="my_family" mode="expert"/>
```
2021-01-30 19:42:46 +01:00
2021-02-06 16:28:33 +01:00
## Famille invisible
2021-01-30 19:42:46 +01:00
Il est possible de cacher une famille, ainsi que toutes les variables et des familles inclusent dans cette famille.
2021-01-30 19:42:46 +01:00
Cacher une famille signifie qu'elle ne sera pas visible lorsqu'on modifie la configuration du service.
Par contre ces variables sont accessibles lorsqu'on va utiliser ces variables.
Pour cacher une famille :
2021-02-06 16:14:24 +01:00
```
<family name="my_family" hidden="True"/>
```