Premiers pas

Cette page est là pour vous guider sur comment procéder à la traduction.

Afin d'éviter des installations fastidieuses, nous vous proposons de travailler directement sur gitlab. La documentation est découpée en de multiples fichiers, éventuellement regroupés dans un répertoire, entities pour les Entités, comme illustré dans la capture ci-dessous, e01.md, e02.md… pour les entités E1, E2…, properties pour les Propriétés, figures pour les schémas et figures…

Les fichiers principaux (entités, propriétés) sont écrits en markdown, qui est du texte avec des balises de mise en forme légères, cf. le bac à sable si vous ne connaissez pas.

Une fois la page sélectionnée,

il suffit de cliquer sur le bouton Edit ou Éditer

En haut de la zone d'édition de texte ce trouve deux onglets qui permettent à tout moment de basculer entre le mode édition Write et le mode Aperçu ou Preview

Si vous voulez en savoir plus sur gitlab: tutoriel gitlab

Les figures

Les figures sont au format SVG, format libre de dessin/schéma/graphique vectoriel facilement affichable dans une page web. Peu importe le logiciel utilisé (cf. ticket #45 pour le créer, du moment que le fichier est en SVG.

Conventions

dans les fichiers à traduire

Afin de faciliter la traduction, chaque fichier contient d'abord la version anglaise, puis la version française (évidemment en grande partie vide au départ).

Notez bien que la version anglaise est rédigé en mode "citation" ce qui s'affiche par un caractère > en début de chaque ligne quand on édite le texte en markdown. Merci de bien laisser cette mise en forme qui nous sera très utile pour reconstituer le texte intégrale en supprimant la partie anglaise.

Dès lors qu'il y a un tableau, il ne doit pas y avoir de retour à la ligne dans le texte markdown (c'est assez déroutant !-(. Soit il faut mettre deux espaces, soit la balise html: <br>

"S'approprier" un fichier à traduire

Merci, si vous souhaitez vous "approprier" un fichier, d'indiquer dans le titre anglais en première ligne du fichier, votre nom (ou id gitlab @bdavid, par exemple) et la plage de temps sur laquelle vous prévoyez ce travail.

À la sauvegarde (commit)

Avant de sauvegarder, indiquer à quelle étapes de traduction par les jalons suivants:

• traduction provisoire
• traduction avancée
• traduction à relire (ce qui permettra à un relecteur de prendre la main!)
• traduction finalisée

La majorité des traducteurs va sans doute réaliser la traduction directement sous gitlab, les autres pourront donc voir que les dernières modifications ont été faites par telle ou telle personne si on ajoute son identifiant ou nom dans le message du commit, comme illustrée dans la capture ci-dessu

Pour les habitués de git/gitlab

Il est évidemment possible de copier (pull) le projet sur sa machine, de commiter en local puis de charger (push) les modifications sur le serveur, notamment si vous voulez travailler sans connexion ethernet. Dans ce cas, avant de "puller", réalisez une petite modif en ligne pour que les autres voient que vous vous appropriez le fichier. N'hésitez pas à contacter @bdavid si vous avez des questions à ce sujet.
Cf. #10