36 lines
2.9 KiB
Markdown
36 lines
2.9 KiB
Markdown
---
|
|
gitea: none
|
|
include_toc: true
|
|
---
|
|
|
|
# Une famille
|
|
|
|
## Synopsis
|
|
|
|
Une famille est un conteneur de variables et de sous-famille.
|
|
|
|
⚠️ Une famille sans sous-famille ni sous-variable sera automatiquement supprimée.
|
|
|
|
## Exemple
|
|
|
|
```yml
|
|
---
|
|
version: '1.0'
|
|
my_family:
|
|
type: family
|
|
description: This is a great family
|
|
help: This is the help of a great family
|
|
mode: expert
|
|
```
|
|
|
|
## Paramètres
|
|
|
|
| Paramètre | Commentaire |
|
|
|-----------|-------------|
|
|
| **name**<br/>`string`<br/>`mandatory` | Nom de la famille.<br/>C'est avec ce nom qu'on va pouvoir interagir avec la famille.<br/>Il est préférable de suivre la [convention sur les noms de variable](convention.md). |
|
|
| **type**, **\_type**<br/>`string` | Type de la famille.<br/>Le type n'est pas obligatoire même si parfois c'est nécessaire de le faire pour aider le moteur.<br/>**Valeurs possible :**<br/>- `family` ← par defaut<br/>- `leadership`<br/>- `dynamic`<br/>📝 Si une sous-famille ou une sous-variable a déjà le nom "type" il est possible d'utiliser l'attribut "\_type". |
|
|
| **description**, **\_description**<br/>`string` | La description de la famille.<br/>Information utilisateur permettant de comprendre l'utilité de la variable.<br/>📝 Si une sous-famille ou une sous-variable a déjà le nom "description" il est possible d'utiliser l'attribut "\_description". |
|
|
| **help**, **\_help**<br/>`string` | Aide complémentaire associée à famille.<br/>📝 Si une sous-famille ou une sous-variable a déjà le nom "help" il est possible d'utiliser l'attribut "\_help". |
|
|
| **mode**, **\_mode**<br/>`string` | [Mode](../variable/mode.md) de la famille<br/>Le mode par défaut d'une famille est le mode le plus petit des familles parentes, les variables enfants ou des familles enfants qui sont contenus dans cette famille.<br/> Ce mode permet aussi de définir le mode par défaut des variables ou des familes inclusent dans cette famille.<br/>**Values:**<br/>- basic<br/>- normal ← default<br/>- expert<br/>📝 Si une sous-famille ou une sous-variable a déjà le nom "mode" il est possible l'attribut "\_mode". |
|
|
| **hidden**, **\_hidden**<br/>`boolean` ou [`calculation`](../condition/README.md) | Famille invisible<br/>Permet de cacher une familles ainsi que les variables ou les familles inclusent dans cette famille.<br/>Cela signifie que la famille ne sera plus visible pour l'utilisateur mais sera visible pour un calcul.<br/>📝 Si une sous-famille ou une sous-variable a déjà le nom "hidden" il est possible l'attribut "\_hidden". |
|
|
| **disabled**, **\_disabled**<br/>`boolean` ou [`calculation`](../condition/README.md) | Famille désactivée<br/>Permet de désactiver une familles ainsi que les variables ou les familles inclusent dans cette famille.<br/>Cela signifie que la famille ne sera plus visible pour l'utilisateur mais "galement pour un calcul.<br/>📝 Si une sous-famille ou une sous-variable a déjà le nom "disabled" il est possible l'attribut "\_disabled". |
|