documentation

doc/dev/README.md

@@ -23,16 +23,16 @@ Voici un premier dictionnaire /srv/rougail/dictionaries/00-base.xml :
 
 Construisons les objets tiramisu :
 
-```
+```python
 from rougail import RougailConvert
 
 rougail = RougailConvert()
-rougail.save('example1.py')
+rougail.save('example.py')
 ```
 
-Un nouveau fichier 'example1.py' va être créé dans le répertoire local
+Un nouveau fichier 'example.py' va être créé dans le répertoire local
 
-## Convertisons un dictionnaire et un dictionnaire extra en objet tiramisu
+## Convertisons un dictionnaire extra en objet tiramisu
 
 En plus du dictionnaire précédent, créons un dictionnaire extra /srv/rougail/extra_dictionaries/00-base.xml
 
@@ -49,13 +49,13 @@ En plus du dictionnaire précédent, créons un dictionnaire extra /srv/rougail/
 
 Construisons les objets tiramisu :
 
-```
+```python
 from rougail import RougailConvert, RougailConfig
 
 RougailConfig['extra_dictionaries']['example'] = ['/srv/rougail/extra_dictionaries/']
 
 rougail = RougailConvert()
-rougail.save('example2.py')
+rougail.save('example.py')
 ```
 
 ## Templatisons un template
@@ -83,24 +83,28 @@ The extra value: %%example.my_variable_extra
 
 Générons le fichier tiramisu :
 
-```
+```python
 from rougail import RougailConvert, RougailConfig
 
 RougailConfig['extra_dictionaries']['example'] = ['/srv/rougail/extra_dictionaries/']
 
 rougail = RougailConvert()
-rougail.save('example3.py')
+rougail.save('example.py')
 ```
 
-Créer les répertoires utils pour la templatisation : mkdir /srv/rougail/destinations /srv/rougail/tmp
+Créer les répertoires utils pour la templatisation :
+
+```bash
+mkdir /srv/rougail/destinations /srv/rougail/tmp
+```
 
 Générons le template :
 
-```
+```python
 import asyncio
+from example import option_0
 from tiramisu import Config
 from rougail import RougailTemplate
-from example3 import option_0
 
 async def template():
     config = await Config(option_0)
@@ -150,11 +154,11 @@ Add by a patch
 Deux choses importantes à savoir sur les patchs :
 
 - le nom du patch est obligatoire le nom du template source + ".patch"
-- la deuxième ligne toujours commencer par "+++ tmp/" + le nom du template source
+- la deuxième ligne doit toujours commencer par "+++ tmp/" + le nom du template source
 
 ## Créons une fonction personnalisé
 
-Nous créons un dictionnaire complémentaire pour ajouter un calcul à la variable my_variable_extra dans /srv/rougail/dictionaries/00-fill.xml :
+Nous créons un dictionnaire complémentaire pour ajouter un calcul à la variable "my_variable" dans /srv/rougail/dictionaries/00-fill.xml :
 
 ```
 <?xml version='1.0' encoding='UTF-8'?>
@@ -169,7 +173,7 @@ Nous créons un dictionnaire complémentaire pour ajouter un calcul à la variab
 
 Puis créons la fonction "return_no" dans /srv/rougail/functions.py :
 
-```
+```python
 def return_no():
     return 'no'
 ```
@@ -184,4 +188,4 @@ The extra value: my_value_extra
 Add by a patch
 ```
 
-La valeur de la variable my_variable est bien calculé à partir de la fonction "return_no".
+La valeur de la variable "my_variable" est bien calculé à partir de la fonction "return_no".

doc/dev/config.md

@@ -2,7 +2,7 @@
 
 La configuration de rougail se trouve dans l'objet RougailConfig :
 
-```
+```python
 from rougail import RougailConfig
 ```
 
@@ -10,7 +10,7 @@ C'est un simple dictionnaire python avec différentes clefs.
 
 Pour modifier il suffit de faire :
 
-```
+```python
 RougailConfig[key] = value
 ```
 
@@ -24,9 +24,9 @@ Les dictionnaires sont chargés dans l'ordre des répertoires. Chaque répertoir
 
 Il n'y a pas de classement par ordre alphabétique de l'ensemble des fichiers XML de tous les répertoires.
 
-Les familles et variable de ces dictionnaires sont classés, par défaut, dans l'espace de nom "rougail". Il est possible de changer le nom de cet espace de nom avec la clef "variable_namespace".
+Les familles et variables de ces dictionnaires sont classés, par défaut, dans l'espace de nom "rougail". Il est possible de changer le nom de cet espace de nom avec la clef "variable_namespace".
 
-- les dictionnaires extra avec la clef "extra_dictionaries". La valeur est un dictionnaire avec l'ensemble des espaces de nom de extra. La clef étant l'espace de nom et la valeur étant une liste de répertoire.
+- les dictionnaires extra avec la clef "extra_dictionaries". La valeur est un dictionnaire avec l'ensemble des espaces de nom. La clef étant l'espace de nom et la valeur étant une liste de répertoire.
 
 Par exemple pour ajouter l'extra "example" il faut faire :
 

doc/family/simple.md

@@ -24,8 +24,9 @@ Ou dans une autre famille :
         <family name="second_family"/>
     </family>
 </variables>
+```
 
-Attention, il famille vide sera automatiquement supprimée.
+Attention, une famille vide sera automatiquement supprimée.
 
 ## Description et aide de la famille