diff --git a/doc/check/function.md b/doc/check/function.md index c2c91583d..2966de16b 100644 --- a/doc/check/function.md +++ b/doc/check/function.md @@ -6,7 +6,7 @@ Une fonction de vérification est une fonction complémentaire au type qui perme Voici un exemple simple de validation des valeurs : -``` +```xml @@ -19,7 +19,7 @@ Voici un exemple simple de validation des valeurs : En YAML : -``` +```yml variables: - variable: name: my_variable @@ -37,7 +37,7 @@ Dans cette exemple, la valeur de la variable "my_variable" va être validé par Voici le contenu de la fonction : -``` +```python def islower(value): if value is None: return @@ -58,7 +58,7 @@ Il est possible de définir des [paramètres](../param/README.md) à cette fonct Dans la contrainte, il est possible de spécifier le niveau d'erreur et le mettre en avertissement : -``` +```xml my_variable @@ -66,7 +66,7 @@ Dans la contrainte, il est possible de spécifier le niveau d'erreur et le mettr En YAML : -``` +```yml - check: - name: islower level: warning diff --git a/doc/check/redefine.md b/doc/check/redefine.md index fedf67dfd..414ee9208 100644 --- a/doc/check/redefine.md +++ b/doc/check/redefine.md @@ -4,7 +4,7 @@ Dans un premier dictionnaire déclarons notre variable et sa fonction de vérification : -``` +```xml @@ -17,7 +17,7 @@ Dans un premier dictionnaire déclarons notre variable et sa fonction de vérifi En YAML : -``` +```yml variables: - variable: name: my_variable @@ -30,7 +30,7 @@ constraints: Dans un second dictionnaire il est possible de redéfinir le calcul : -``` +```xml @@ -43,7 +43,7 @@ Dans un second dictionnaire il est possible de redéfinir le calcul : En YAML : -``` +```yml variables: - variable: name: my_variable @@ -65,7 +65,7 @@ Dans un second dictionnaire il est possible de supprimer cette vérification. Dans un premier dictionnaire déclarons notre variable et notre fonction de vérification : -``` +```xml @@ -78,7 +78,7 @@ Dans un premier dictionnaire déclarons notre variable et notre fonction de vér En YAML : -``` +```yml variables: - variable: name: my_variable @@ -91,7 +91,7 @@ constraints: Dans un second dictionnaire supprimer cette vérification : -``` +```xml @@ -99,7 +99,7 @@ Dans un second dictionnaire supprimer cette vérification : En YAML : -``` +```yml variables: - variable: name: my_variable diff --git a/doc/condition/condition.md b/doc/condition/condition.md index 9821885a4..1bfdcfe4e 100644 --- a/doc/condition/condition.md +++ b/doc/condition/condition.md @@ -8,7 +8,7 @@ Nous allons nous concentrer ici sur la condition hidden_if_in, mais [il existe d La condition hidden_if_in permet de cacher une variable où une famille à l'utilisateur, mais cette variable est toujours accessible dans un calcul, un vérification ou dans un template. -``` +```xml @@ -24,7 +24,7 @@ La condition hidden_if_in permet de cacher une variable où une famille à l'uti En YAML : -``` +```yml variables: - variable: name: condition @@ -51,7 +51,7 @@ Donc ici la variable est caché à l'utilisateur si la variable "condition" est Il est également possible de mettre plusieurs paramètre : -``` +```xml @@ -68,7 +68,7 @@ Il est également possible de mettre plusieurs paramètre : En YAML : -``` +```yml variables: - variable: name: condition @@ -105,7 +105,7 @@ Ces deux comportements peuvent être changé à tout moment avec l'attribut "app Exemple : -``` +```xml yes maybe @@ -115,7 +115,7 @@ Exemple : En YAML : -``` +```yml - condition: - name: hidden_if_in source: condition diff --git a/doc/condition/redefine.md b/doc/condition/redefine.md index 664f8c90c..0ab50d75e 100644 --- a/doc/condition/redefine.md +++ b/doc/condition/redefine.md @@ -6,7 +6,7 @@ Dans un second dictionnaire il est possible de supprimer cette condition. Dans un premier dictionnaire déclarons notre variable et notre calcule : -``` +```xml @@ -22,7 +22,7 @@ Dans un premier dictionnaire déclarons notre variable et notre calcule : En YAML : -``` +```yml variables: - variable: name: condition @@ -41,7 +41,7 @@ constraints: Dans un second dictionnaire supprimer ce calcul : -``` +```xml @@ -49,7 +49,7 @@ Dans un second dictionnaire supprimer ce calcul : En YAML : -``` +```yml variables: - variable: name: condition diff --git a/doc/dev/README.md b/doc/dev/README.md index de8d633b2..184d6b5ea 100644 --- a/doc/dev/README.md +++ b/doc/dev/README.md @@ -10,7 +10,7 @@ Commençons par créer un dictionnaire simple. Voici un premier dictionnaire /srv/rougail/dictionaries/00-base.xml : -``` +```xml @@ -36,7 +36,7 @@ Un nouveau fichier 'example.py' va être créé dans le répertoire local En plus du dictionnaire précédent, créons un dictionnaire extra /srv/rougail/extra_dictionaries/00-base.xml -``` +```xml @@ -62,7 +62,7 @@ rougail.save('example.py') Nous créons un dictionnaire complémentaire pour ajouter notre template /srv/rougail/dictionaries/00-template.xml : -``` +```xml @@ -130,7 +130,7 @@ Il peut être intéressant de réaliser un patch à un template pour corriger un Testons en créant le patch /srv/rougail/patches/example.conf.patch : -``` +```patch --- /srv/rougail/templates/example.conf 2021-02-13 19:41:38.677491087 +0100 +++ tmp/example.conf 2021-02-13 20:12:55.525089820 +0100 @@ -1,3 +1,5 @@ @@ -160,7 +160,7 @@ Deux choses importantes à savoir sur les patchs : Nous créons un dictionnaire complémentaire pour ajouter un calcul à la variable "my_variable" dans /srv/rougail/dictionaries/00-fill.xml : -``` +```xml diff --git a/doc/dev/config.md b/doc/dev/config.md index cff1eddc4..75426100f 100644 --- a/doc/dev/config.md +++ b/doc/dev/config.md @@ -38,7 +38,7 @@ Les familles et variables de ces dictionnaires sont classés, par défaut, dans Par exemple pour ajouter l'extra "example" il faut faire : -``` +```python RougailConfig['extra_dictionaries']['example'] = ['/dir1', '/dir2'] ``` diff --git a/doc/family/auto.md b/doc/family/auto.md index 55f516bc0..6d2b3f7dc 100644 --- a/doc/family/auto.md +++ b/doc/family/auto.md @@ -5,7 +5,7 @@ Le nom et la description de la famille et des variables qu'elle contient sera en Par exemple : -``` +```xml val1 val2 @@ -17,7 +17,7 @@ Par exemple : En YAML : -``` +```yml variables: - variable: name: variable diff --git a/doc/family/leadership.md b/doc/family/leadership.md index 838267c12..bf35edb71 100644 --- a/doc/family/leadership.md +++ b/doc/family/leadership.md @@ -33,7 +33,7 @@ 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 : -``` +```xml @@ -45,7 +45,7 @@ Voici un exemple de définition d'une variable meneuse et de deux variables mene En YAML : -``` +```yml variables: - family: name: family @@ -65,7 +65,7 @@ variables: 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 : -``` +```xml @@ -75,7 +75,7 @@ Pour ajouter, dans un nouveau dictionnaire, une variable suiveuse à notre group En YAML : -``` +```yml variables: - family: name: family diff --git a/doc/family/simple.md b/doc/family/simple.md index c3f545c14..89426357b 100644 --- a/doc/family/simple.md +++ b/doc/family/simple.md @@ -4,20 +4,20 @@ Une famille est un conteneur de variables. Elle peut contenir également des fam Pour décrire une famille il faut mettre au minimum un nom : -``` +```xml ``` En YAML : -``` +```yml - family: name: my_family ``` Cette famille doit être placé dans une balise [variables](../variables.md) : -``` +```xml @@ -25,7 +25,7 @@ Cette famille doit être placé dans une balise [variables](../variables.md) : En YAML : -``` +```yml variables: - family: name: my_family @@ -33,7 +33,7 @@ variables: Ou dans une autre famille : -``` +```xml @@ -43,7 +43,7 @@ Ou dans une autre famille : En YAML : -``` +```yml variables: - family: name: my_family @@ -58,13 +58,13 @@ Attention, une famille vide sera automatiquement supprimée. En plus d'un nom, il est possible de mettre une "description" à la famille. C'est une information "utilisateur" qui nous permettra d'avoir des informations complémentaires sur le contenu de cette famille : -``` +```xml ``` En YAML : -``` +```yml variables: - family: name: my_family @@ -73,13 +73,13 @@ variables: En plus de la description, il est possible de préciser une aide complémentaire : -``` +```xml ``` En YAML : -``` +```yml variables: - family: name: my_family @@ -94,13 +94,13 @@ Changer le [mode](../mode.md) d'une famille permet de définir le [mode](../mode Pour définir le [mode](../mode.md) : -``` +```xml ``` En YAML : -``` +```yml - family: name: my_family mode: expert @@ -115,13 +115,13 @@ Par contre ces variables sont accessibles lorsqu'on va utiliser ces variables. Pour cacher une famille : -``` +```xml