rougail/doc/family/simple.md

Une famille

Synopsis

Une famille est un conteneur de variables et de sous-famille.

Paramètres

Paramètre	Commentaire
name	Nom de la famille.
string	C'est avec ce nom qu'on va pouvoir interagir avec la famille.
mandatory	Il est préférable de suivre la
	convention sur les noms de variable.
-----------------------------------------	----------------------------------------------------------------------
type / _type	Type de la famille.
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.
	Valeurs possible :
	- family ← part defaut
	- leadership
	- dynamic
	> [!NOTE]
	> Si une sous-famille ou une sous-variable a déjà le nom "type" il
	> est possible d'utiliser l'attribut "_type".
-----------------------------------------	----------------------------------------------------------------------
description /	La description de la famille.
_description	Information utilisateur permettant de comprendre l'utilité de la
string	variable.
	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.
_help	Si une sous-famille ou une sous-variable a déjà le nom "help"
string	il est possible l'attribut "_help".
-----------------------------------------	----------------------------------------------------------------------
mode / _mode	Mode de la famille/
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.
	Ce mode permet aussi de définir le mode par défaut des variables
	ou des familes inclusent dans cette famille.
	Si une sous-famille ou une sous-variable a déjà le nom "mode" il est
	possible l'attribut "_mode".
	Values:
	- basic
	- normal ← default
	- expert
-----------------------------------------	----------------------------------------------------------------------
hidden / _hidden	Famille invisible
boolean ou	Permet de cacher une familles ainsi que les variables ou les
calculation	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	Famille désactivée
boolean ou	Permet de désactiver une familles ainsi que les variables ou les
calculation	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".

Warning

Une famille sans sous-famille ou sous-variable sera automatiquement supprimée.

---
version: '1.0'
my_family:
  type: family
  description: This is a great family
  help: This the help of a great family
  mode: expert