diff --git a/doc/README.md b/doc/README.md index c606f47c..e127fa3a 100644 --- a/doc/README.md +++ b/doc/README.md @@ -11,6 +11,7 @@ Rougail est un bibliothèque python3 qui permet de charger des dictionnaires (fi - [Les dictionnaires](dictionary/rougail.md) - [Les dictionnaires extra](dictionary/extra.md) + - [Convention d'écriture d'un dictionnaire](dictionary/convention.md) ### Les variables diff --git a/doc/check/function.md b/doc/check/function.md index 016164c2..26ac408a 100644 --- a/doc/check/function.md +++ b/doc/check/function.md @@ -8,12 +8,12 @@ Voici un exemple simple de validation des valeurs : ``` - + - - my_variable - + + my_variable + ``` @@ -46,7 +46,7 @@ Dans la contrainte, il est possible de spécifier le niveau d'erreur et le mettr ``` - my_variable + my_variable ``` diff --git a/doc/check/redefine.md b/doc/check/redefine.md index bb8914ce..359c3266 100644 --- a/doc/check/redefine.md +++ b/doc/check/redefine.md @@ -6,12 +6,12 @@ Dans un premier dictionnaire déclarons notre variable et sa fonction de vérifi ``` - + - - my_variable - + + my_variable + ``` @@ -19,12 +19,12 @@ Dans un second dictionnaire il est possible de redéfinir le calcul : ``` - + - - my_variable - + + my_variable + ``` @@ -40,12 +40,12 @@ Dans un premier dictionnaire déclarons notre variable et notre fonction de vér ``` - + - - my_variable - + + my_variable + ``` @@ -53,9 +53,9 @@ Dans un second dictionnaire supprimer cette vérification : ``` - - - + + + ``` diff --git a/doc/condition/condition.md b/doc/condition/condition.md index adf84c53..40c490b9 100644 --- a/doc/condition/condition.md +++ b/doc/condition/condition.md @@ -10,15 +10,15 @@ La condition hidden_if_in permet de cacher une variable où une famille à l'uti ``` - - + + - - True - my_variable - + + True + my_variable + ``` @@ -34,16 +34,16 @@ Il est également possible de mettre plusieurs paramètre : ``` - - + + - - yes - maybe - my_variable - + + yes + maybe + my_variable + ``` @@ -69,8 +69,8 @@ Exemple : ``` - yes - maybe - my_variable + yes + maybe + my_variable ``` diff --git a/doc/condition/redefine.md b/doc/condition/redefine.md index b076205c..c56fbbe8 100644 --- a/doc/condition/redefine.md +++ b/doc/condition/redefine.md @@ -8,15 +8,15 @@ Dans un premier dictionnaire déclarons notre variable et notre calcule : ``` - - + + - - True - my_variable - + + True + my_variable + ``` @@ -24,6 +24,6 @@ Dans un second dictionnaire supprimer ce calcul : ``` - + ``` diff --git a/doc/dev/README.md b/doc/dev/README.md index cfd79ba3..de8d633b 100644 --- a/doc/dev/README.md +++ b/doc/dev/README.md @@ -13,11 +13,11 @@ Voici un premier dictionnaire /srv/rougail/dictionaries/00-base.xml : ``` - - - my_value - - + + + my_value + + ``` @@ -39,11 +39,11 @@ En plus du dictionnaire précédent, créons un dictionnaire extra /srv/rougail/ ``` - - - my_value_extra - - + + + my_value_extra + + ``` @@ -65,11 +65,11 @@ Nous créons un dictionnaire complémentaire pour ajouter notre template /srv/ro ``` - - - - - + + + + + ``` @@ -163,11 +163,11 @@ Nous créons un dictionnaire complémentaire pour ajouter un calcul à la variab ``` - - - my_variable - - + + + my_variable + + ``` diff --git a/doc/dictionary/convention.md b/doc/dictionary/convention.md new file mode 100644 index 00000000..efeecd68 --- /dev/null +++ b/doc/dictionary/convention.md @@ -0,0 +1,13 @@ +# Convention de rédaction d'un dictionnaire + +## Ordonnancement du dictionnaire + +L'ordre des informations mise dans le dictionnaire est idéalement : + +- services +- variables +- constraintes + +## Le nom d'espace + +Le nom d'espace dans un dictionnaire est de deux espaces. diff --git a/doc/family/auto.md b/doc/family/auto.md index 1209dd30..dcf942fb 100644 --- a/doc/family/auto.md +++ b/doc/family/auto.md @@ -7,11 +7,11 @@ Par exemple : ``` - val1 - val2 + val1 + val2 - + ``` diff --git a/doc/family/leadership.md b/doc/family/leadership.md index 8d135021..a2e96cd2 100644 --- a/doc/family/leadership.md +++ b/doc/family/leadership.md @@ -35,11 +35,11 @@ Voici un exemple de définition d'une variable meneuse et de deux variables mene ``` - - - - - + + + + + ``` @@ -49,8 +49,8 @@ Pour ajouter, dans un nouveau dictionnaire, une variable suiveuse à notre group ``` - - - + + + ``` diff --git a/doc/family/simple.md b/doc/family/simple.md index ac3e9cdc..324f653e 100644 --- a/doc/family/simple.md +++ b/doc/family/simple.md @@ -12,7 +12,7 @@ Cette famille doit être placé dans une balise [variables](../variables.md) : ``` - + ``` @@ -20,9 +20,9 @@ Ou dans une autre famille : ``` - - - + + + ``` diff --git a/doc/fill/README.md b/doc/fill/README.md index 624b14fe..797d7ef8 100644 --- a/doc/fill/README.md +++ b/doc/fill/README.md @@ -4,3 +4,4 @@ Une variable calculée est une variable donc sa valeur est le résultat d'une fo - [Valeur calculée de la variable](value.md) - [Réfinition](redefine.md) + - [Exemples de calcule](examples.md) diff --git a/doc/fill/examples.md b/doc/fill/examples.md new file mode 100644 index 00000000..10bdfe98 --- /dev/null +++ b/doc/fill/examples.md @@ -0,0 +1,48 @@ +# Exemples de calcule + +## Calculer les noms de modèle à généré à partir d'une variable + +Créeons deux variables multiples, une pour accueillir la liste des éléments du nom variable (ici `zones_list`), la seconde étant le nom du fichier calculé (ici `netwokd_configurations`) : + +``` + + + zone1 + zone2 + zone3 + + +``` + +Calculons la valeur de la seconde variable à partir de la première : + +``` + + + /systemd/network/10- + zones_list + -risotto.network + + True + netwokd_configurations + + +``` + +Le contenu de la variable `netwokd_configurations` sera alors : + +- /systemd/netword/10-zone1/risotto.network +- /systemd/netword/10-zone2/risotto.network +- /systemd/netword/10-zone3/risotto.network + +Enfin déclarer une balise file en utilisant ces deux variables : + +``` + + + netwokd_configurations + + +``` + diff --git a/doc/fill/value.md b/doc/fill/value.md index 4702d11e..1f82fc22 100644 --- a/doc/fill/value.md +++ b/doc/fill/value.md @@ -6,12 +6,12 @@ Créons une variable dont la valeur est retournée par la fonction "return_no" : ``` - + - - my_calculated_variable - + + my_calculated_variable + ``` @@ -30,7 +30,7 @@ Attention, si une valeur par défaut est définit dans la variable "my_calculate ``` - yes + yes ``` Cette valeur par défaut sera complètement ignorée. C'est le calcul qui en définira la valeur. @@ -59,24 +59,24 @@ Il est également possible de calculer [une variable d'une famille dynamique](.. ``` - - val1 - val2 + + val1 + val2 + + + val + + + + val - - val - - - - val - - + - - my_variable - my_calculated_variable_dyn_ - + + my_variable + my_calculated_variable_dyn_ + ``` @@ -90,11 +90,11 @@ Dans ce cas, il faut explicitement demander la valeur du suffix dans la fonction ``` - - my_variable - - my_calculated_variable_dyn_ - + + my_variable + + my_calculated_variable_dyn_ + ``` diff --git a/doc/service/README.md b/doc/service/README.md index 56564ac4..b1932fb4 100644 --- a/doc/service/README.md +++ b/doc/service/README.md @@ -11,9 +11,9 @@ Il faut, à la création du service, préciser son nom : ``` - - - + + + ``` @@ -69,7 +69,7 @@ Il est possible de désactiver un service. Pour cela il faut rajouter l'attribut ``` - + ``` @@ -79,17 +79,17 @@ Il est possible de définir une [condition](../condition/README.md) de type "dis ``` - - + + - + - - False - test - + + False + test + ``` diff --git a/doc/service/file.md b/doc/service/file.md index 7c774d2f..2ccafe75 100644 --- a/doc/service/file.md +++ b/doc/service/file.md @@ -10,9 +10,9 @@ Il est nécessaire, au minimum, de spécifier le chemin complet du fichier : ``` - - /etc/squid/squid.conf - + + /etc/squid/squid.conf + ``` @@ -30,14 +30,14 @@ Il est possible également de définir le nom du fichier dans une variable : ``` - - my_variable - + + my_variable + - - /etc/squid/squid.conf - + + /etc/squid/squid.conf + ``` @@ -49,15 +49,15 @@ Il est même possible de définir une variable de type multiple, ce qui génère ``` - - my_variable - + + my_variable + - - /etc/squid1/squid.conf - /etc/squid2/squid.conf - + + /etc/squid1/squid.conf + /etc/squid2/squid.conf + ``` @@ -73,19 +73,19 @@ En effet, il est possible de passer le contenu d'une variable au template : ``` - - my_variable1 - + + my_variable1 + - - /etc/squid1/squid.conf - /etc/squid2/squid.conf - - - squid1 - squid2 - + + /etc/squid1/squid.conf + /etc/squid2/squid.conf + + + squid1 + squid2 + ``` @@ -117,18 +117,18 @@ Il est aussi possible de définir une [condition](../condition/README.md) de typ ``` - - /etc/squid/squid.conf - + + /etc/squid/squid.conf + - + - - False - squid - + + False + squid + ``` diff --git a/doc/service/ip.md b/doc/service/ip.md index ebebf738..229eb21f 100644 --- a/doc/service/ip.md +++ b/doc/service/ip.md @@ -28,19 +28,19 @@ Il est possible de définir une [condition](../condition/README.md) de type "dis ``` - - variable_ip - + + variable_ip + - - + + - - False - test_ip - + + False + test_ip + ``` diff --git a/doc/service/override.md b/doc/service/override.md index 65cabba5..2306294b 100644 --- a/doc/service/override.md +++ b/doc/service/override.md @@ -10,9 +10,9 @@ Il suffit d'avoir un template dont le nom est par défaut le nom du service avec ``` - - - + + + ``` diff --git a/doc/services.md b/doc/services.md index 3dae9c89..1a0e61ea 100644 --- a/doc/services.md +++ b/doc/services.md @@ -7,7 +7,7 @@ Il est placé à la racine du dictionnaire : ``` - + ``` diff --git a/doc/variable/README.md b/doc/variable/README.md index 9e5b86d2..30d4f147 100644 --- a/doc/variable/README.md +++ b/doc/variable/README.md @@ -8,10 +8,10 @@ Une variable est déjà un nom. C'est à dire qu'on pourra utiliser plus tard la ``` - - - - + + + + ``` @@ -123,7 +123,7 @@ Il est possible de fixer les valeurs par défaut d'une variable : ``` - value + value ``` @@ -131,8 +131,8 @@ Pour une variable multiple, il est possible de préciser plusieurs valeurs : ``` - value 1 - value 2 + value 1 + value 2 ``` @@ -152,7 +152,9 @@ Attention trois attributs ne sont redéfinisable : Créons notre variable : - +``` + +``` Et redéfinisons là : @@ -186,7 +188,7 @@ Voici une variable a valeur automatiquement modifiée : ``` - my_value + my_value ``` @@ -205,7 +207,7 @@ Voici un variable à valeur en lecture seule automatique : ``` - False + False ``` diff --git a/doc/variable/choice.md b/doc/variable/choice.md index 855361be..94836998 100644 --- a/doc/variable/choice.md +++ b/doc/variable/choice.md @@ -6,9 +6,9 @@ Il est possible d'imposer une liste de valeur pour une variable particulière : ``` - val1 - val2 - val3 + val1 + val2 + val3 ``` @@ -19,10 +19,10 @@ Si la variable est obligatoire ou si une valeur est précisée (la variable pass ``` - val1 - val2 - val3 - val1 + val1 + val2 + val3 + val1 ``` @@ -32,11 +32,11 @@ Par défaut les choix sont de type "string". Il est possible de préciser des no ``` - val1 - val2 - 3 - True - + val1 + val2 + 3 + True + ``` @@ -48,7 +48,7 @@ Pour ajouter un choix à une variable à choix existante, rien de plus simple, j ``` - val4 + val4 ``` @@ -58,8 +58,8 @@ Si on veut supprimer un choix ou redéfinir complètement la liste, il faut red ``` - val1 - val2 + val1 + val2 ``` @@ -71,7 +71,7 @@ Une variable à valeur multiple peut servir de source des choix : ``` - other_variable + other_variable ``` @@ -82,10 +82,10 @@ Seul un choice de type "variable" est possible par variable. ``` - - 0 - 10 - - 9 + + 0 + 10 + + 9 ``` diff --git a/doc/variable/leadership.md b/doc/variable/leadership.md index 2a2cf072..1b96f8e2 100644 --- a/doc/variable/leadership.md +++ b/doc/variable/leadership.md @@ -33,17 +33,17 @@ Voici un exemple de définition d'une variable meneuse et de deux variables mene ``` - - - - - + + + + + - - follower1 - follower2 - + + follower1 + follower2 + ``` @@ -53,10 +53,10 @@ Il est possible d'en définit d'autres : ``` - - follower1 - follower2 - + + follower1 + follower2 + ``` @@ -66,17 +66,17 @@ Voici un exemple de définition d'une variable meneuse et de deux variables mene ``` - - - - - + + + + + - - follower1 - follower2 - + + follower1 + follower2 + ``` @@ -90,13 +90,13 @@ Pour ajouter, dans un nouveau dictionnaire, une variable suiveuse à notre group ``` - - - + + + - - follower3 - + + follower3 + ``` diff --git a/doc/variables.md b/doc/variables.md index b54758af..435416a6 100644 --- a/doc/variables.md +++ b/doc/variables.md @@ -7,6 +7,6 @@ Il est placé à la racine du dictionnaire : ``` - + ```