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