diff --git a/doc/README.md b/doc/README.md index 0faf2312..c606f47c 100644 --- a/doc/README.md +++ b/doc/README.md @@ -28,7 +28,6 @@ Rougail est un bibliothèque python3 qui permet de charger des dictionnaires (fi - [Les calcules automatiques](fill/README.md) - [Les vérifications des valeurs](check/README.md) - [Les conditions](condition/README.md) - - [Les variables meneuses ou suiveuses](variable/leadership.md) ## Les templates diff --git a/doc/family/README.md b/doc/family/README.md index 1aff0572..85da5368 100644 --- a/doc/family/README.md +++ b/doc/family/README.md @@ -2,4 +2,5 @@ - [Une famille](simple.md) - [Famille crée dynamiquement](auto.md) + - [Les variables meneuses ou suiveuses](leadership.md) diff --git a/doc/family/leadership.md b/doc/family/leadership.md new file mode 100644 index 00000000..8d135021 --- /dev/null +++ b/doc/family/leadership.md @@ -0,0 +1,56 @@ +# Variable meneuse ou suiveuse + +## Variable meneuse + +Une variable meneuse est une variable qui va guider la longueur d'autre variables (appelé variables suiveuse). + +Une variable meneuse est une [variable](../variable/README.md) qui est obligatoirement de type multiple. + +Une variable meneuse peut être obligatoire. + +Le [mode](../mode.md) par défaut correspond au plus petit mode définit par l'utilisateur des variables suiveuses. + +## Variable suiveuse + +Une variable suiveuse est une variable donc la longueur n'est pas déterminé par elle-même, mais est identique à celle de la variable meneuse dont elle dépend. + +Une variable suiveuse est une variable placer juste derrière une variable meneuse ou une autre variable suiveuse. + +L'ordre de définition des variables suiveuses est important. + +Cette variable peut être de type multiple. Dans ce cas, pour un index determiné, il est possible de mettre plusieurs valeurs à une même variable. + +Une variable suiveuse peut être obligatoire. Cela signifie que lorsqu'une variable meneuse est renseigné, il faut obligatoirement que la variable suiveuse est également une valeur à l'index considéré. +Si aucune valeur n'est définit pour la variable meneuse, aucune valeur n'est a spécifié pour la variable suiveuse. + +Le [mode](../mode.md) par défaut d'une variable suiveuse correspond au [mode](../mode.md) de la variable meneuse. + +Si une variable meneuse est caché ou désactivé, les variables suiveuses le seront également. + +## Définition des variables meneuse et suiveuse + +Les variables meneuses et suiveuses doivent dans une famille de type "leadership". + +Voici un exemple de définition d'une variable meneuse et de deux variables meneuses : + +``` + + + + + + + +``` + +## Ajout d'une nouvelle variable suiveuse + +Pour ajouter, dans un nouveau dictionnaire, une variable suiveuse à notre groupe, rien de plus simple, il suffit définir une ou des nouvelles variables dans la famille : + +``` + + + + + +``` diff --git a/doc/fill/value.md b/doc/fill/value.md index d1efaa72..4702d11e 100644 --- a/doc/fill/value.md +++ b/doc/fill/value.md @@ -49,8 +49,8 @@ Si une condition "hidden_if_in" est spécifié à la variable, la valeur sera mo ## Variable meneuse ou suiveuse avec valeur calculé -Une [variable suiveuse](../variable/leadership.md) ne peut pas être calculé automatiquement. -Une [variable meneuse](../variable/leadership.md) peut être calculé automatiquement. +Une [variable suiveuse](../family/leadership.md) ne peut pas être calculé automatiquement. +Une [variable meneuse](../family/leadership.md) peut être calculé automatiquement. Si la variable n'est pas multiple, il ne faut pas que le calcule retourne une liste. ## Variable dynamique avec une valeur calculée diff --git a/doc/param/variable.md b/doc/param/variable.md index 1b4062fe..2fe100b6 100644 --- a/doc/param/variable.md +++ b/doc/param/variable.md @@ -6,7 +6,7 @@ Imaginons que la variable "my_variable" pré-existe. La valeur de la variable se my_variable ``` -[Les variables meneuses ou suiveuses](../variable/leadership.md) peuvent être utilisé sans soucis comme paramètre. +[Les variables meneuses ou suiveuses](../family/leadership.md) peuvent être utilisé sans soucis comme paramètre. ## Paramètre avec variable potentiellement non existante diff --git a/doc/variable/README.md b/doc/variable/README.md index af87388f..f3a1ea3a 100644 --- a/doc/variable/README.md +++ b/doc/variable/README.md @@ -1,4 +1,255 @@ # Variable - - [Une variable](simple.md) - - [Variable meneuse ou suiveuse](leadership.md) +## Un variable + +Une variable est forcement dans [variables](../variables.md) ou dans une [famille](../family/README.md). + +Une variable est déjà un nom. C'est à dire qu'on pourra utiliser plus tard la variable via ce nom. + +``` + + + + + + +``` + +## Description et aide sur la variable + +En plus d'un nom, il est possible de mettre une "description" à la variable. C'est une information "utilisateur" qui nous permettra d'avoir des informations complémentaires sur le contenu de cette variable : + +``` + +``` + +En plus de la description, il est possible de préciser une aide complémentaire : + +``` + +``` + +Cette aide peut être utilisé à tout moment comme valeur [d'un paramètre](../param/information.md). + +## Le type de la variable + +Une variable a un type. Ce type permet de définir les valeurs acceptées par cette variable : + +- string : chaine de caractère (type par défaut) +- number : un nombre +- float : un chiffre flottant +- boolean : "True" ou "False", si aucune valeur n'est défini la valeur par défaut de cette variable sera "True", ces variables sont également obligatoire par défaut +- password : un mot de passe +- mail : une adresse mail +- filename : nom de fichier au sens Unix (exemple : "/etc/passwd") +- date : une date au format "%Y-%m-%d" (exemple : "2021-01-30") +- unix_user : nom d'utilisateur au sens Unix +- ip : n'importe quelle adresse IPv4 +- cidr : n'importe quelle adresse IPv4 au format CIDR +- local_ip : adresse IPv4 sur un réseau local, si l'adresse IPv4 n'est pas local, un warning sera afficher mais la valeur sera accepté tout de même +- netmask : masque d'une adresse IPv4 +- network : adresse réseau +- network_cidr : adresse réseau au format CIDR +- broadcast : adresse de diffusion +- netbios : nom netbios +- domain : nom de domaine +- hostname : nom d'hôte +- web_address : adresse web (http://www.cadoles.com/) +- port : port +- mac : adresse MAC +- schedule : périodicité du schedule, les valeurs possibles sont "none", "daily", "weekly" ou "monthly" +- schedulemod : type de schedule, les valeurs possibles sont "pre" ou "post" + +Pour définir le type d'une variable : + +``` + +``` + +## Variable à valeur multiple + +Par défaut une variable ne peut acceuillir qu'une seule valeur. Il peut être utile de pouvoir spécifier plusieurs valeurs à une même variable. + +Pour définir une variable à valeur multiple : + +``` + +``` + +## Variable invisible + +Il est possible de cacher une variable. + +Cacher une variable signifie qu'elle ne sera pas visible lorsqu'on modifie la configuration du service. +Par contre cette variable sera accessibles lorsqu'on va l'utiliser. + +Pour cacher une variable : + +``` +