Rewrite documentation with MkDocs

This commit is contained in:
thomas girod
2024-07-16 18:39:54 +02:00
parent a1296dc7af
commit 07b625d4aa
181 changed files with 3322 additions and 3361 deletions

71
docs/howto/translation.md Normal file
View File

@ -0,0 +1,71 @@
Le code du site est entièrement écrit en anglais,
le texte affiché aux utilisateurs l'est également.
La traduction en français se fait
ultérieurement avec un fichier de traduction.
Voici un petit guide rapide pour apprendre à s'en servir.
## Dans le code du logiciel
Imaginons que nous souhaitons afficher "Hello"
et le traduire en français.
Voici comment signaler que ce mot doit être traduit.
Si le mot est dans le code Python :
```python
from django.utils.translation import gettext as _
help_text=_("Hello")
```
Si le mot apparaît dans le template Jinja :
```jinja
{% trans %}Hello{% endtrans %}
```
## Générer le fichier django.po
La traduction se fait en trois étapes.
Il faut d'abord générer un fichier de traductions,
l'éditer et enfin le compiler au format binaire pour qu'il soit lu par le serveur.
```bash
./manage.py makemessages --locale=fr --ignore "env/*" -e py,jinja
```
## Éditer le fichier django.po
```locale
# locale/fr/LC_MESSAGES/django.po
# ...
msgid "Hello"
msgstr "" # Ligne à modifier
# ...
```
!!!note
Si les commentaires suivants apparaissent, pensez à les supprimer.
Ils peuvent gêner votre traduction.
```
#, fuzzy
#| msgid "Bonjour"
```
## Générer le fichier django.mo
Il s'agit de la dernière étape.
Un fichier binaire est généré à partir du fichier django.mo.
```bash
./manage.py compilemessages
```
!!!tip
Pensez à redémarrer le serveur si les traductions ne s'affichent pas