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