rougail/doc/dictionary/convention.md

20 lines
657 B
Markdown

---
gitea: none
include_toc: true
---
# Conventions
## Convention de nom d'un fichier de dictionnaire
L'ordre des dictionnaires est important pour l'ordre de création des variables et des familles.
Les fichiers devront donc démarrés par deux numéros suivit d'un tiret.
Par exemple : `00-base.xml`
## Convention du nom des familles et variables
La seule restriction sur le nom des familles et variables est que le nom ne doit pas commencer par le caractère "\_".
Néanmoins il est préférable de n'utiliser que des lettres minuscule ASCII, des chiffres et le caractère "\_".
C'est la convention typographique snake case qui est donc utilisée.