rougail/doc/dev/config.md

# Personnalisons la configuration de Rougail

La configuration de rougail se trouve dans l'objet RougailConfig :

```python
from rougail import RougailConfig
```

C'est un simple dictionnaire python avec différentes clefs.

Pour modifier il suffit de faire :

```python
RougailConfig[key] = value
```

## Les répertoires des dictionnaires

Il existe deux types de répertoires de dictionnaires :

- les dictionnaires principaux avec la clef "dictionaries_dir". La valeur par défaut est ['/srv/rougail/dictionaries']. Cette variable doit contenir la liste des répertoires contenants des dictionnaires.

Les dictionnaires sont chargés dans l'ordre des répertoires. Chaque répertoire est chargé les uns après les autres. A l'intérieur de ces répertoires les fichiers XML seront classés par ordre alphabétique.

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 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. 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 :

```
RougailConfig['extra_dictionaries']['example'] = ['/dir1', '/dir2']
```

Les dictionnaires sont chargés dans le même ordre que les dictionnaires principaux.

## La DTD

Rougail a besoin du fichier de DTD pour lire les fichiers dictionnaire.

Par défaut le fichier de la DTD est dans le sous répertoire "data" du répertoire de code. Le nom du fichier est rougail.dtd.

Pour pouvez changer le répertoire de destination de la DTD et le nom du fichier avec la clef "dtdfilename".

## Le fichier de fonction

Le fichier qui contient les fonctions personnalisés est géré dans la clef "functions_file" et a comme valeur par défaut "/srv/rougail/functions.py".

## Le répertoire des templates

Le répertoire des templates est géré dans la clef "templates_dir" et a comme valeur par défaut : "/srv/rougail/templates".

## Le moteur de templates par défaut

Le moteur de template est géré dans la clef "default_engine" et a comme valeur par défaut : "creole". Les valeurs possible sont "none", "creole" ou "jinja2".

## Le répertoire des patchs

Le répertoire des patches est géré dans la clef "patches_dir" et a comme valeur par défaut : "/srv/rougail/patches".

## Le répertoire temporaire

Le répertoire temporaire est utile lors de la génération de template. Il contient une copie des templates avec, éventuellement, les patches appliqués sur les templates.

Le répertoire de temporaire est géré dans la clef "tmp_dir" et a comme valeur par défaut : "/srv/rougail/tmp".

## Le répertoire de destination des fichiers générés

Le répertoire de destination des fichiers générés est géré dans la clef "destinations_dir" et a comme valeur par défaut : "/srv/rougail/destinations".

## La variable auto_freeze

La propriété auto_freeze n'est appliqué que une variable spécifique passe à True. Par défaut le nom de la variable est "instancied_module", mais il est possible de changer le nom de cette variable via la clef "auto_freeze_variable".