Traduction de la documentation Vim

Quelques scripts

Convertir les fichiers des manuels de Vim en HTML

Trouver un marqueur dans les manuels en ligne

Un peu de PHP pour trouver rapidement un marqueur dans les fichiers HTML. Le fichier de marqueurs généré par Vim ("tags") est nécessaire.

Générer le fichier usr_toc.txt

Greffon de relecture

Voici un outil d'aide à la relecture de fichiers textes, qui est notamment utilisé dans le cadre de la traduction de la documentation de Vim. Cet outil est composé de plusieurs fichiers :

Vous pouvez aussi téléchargez une archive .tar.gz contenant ces 4 fichiers.

Cet outil permet aux relecteurs et aux traducteurs de :

A quoi ça sert

(Extrait du fichier d'aide)

==============================================================================
1. Introduction                                         *rq-intro*

Cet outil a été mis en place pour formaliser le travail des relecteurs.
Initialement conçu pour les relectures des fichiers traduits lors de la
traduction française des manuels de Vim, il peut également convenir à d'autres
travaux similaires.

Pour que traducteur et relecteur passent le moins de temps possible à
comprendre ce que l'autre a voulu signifier, un certain nombre de structures
et de formalismes ont été mis en place.

L'objectif de l'outil est de simplifier la tâche de relecture, tant du point
de vue du relecteur, que de celui du traducteur qui reprend son fichier
traduit. Pour cela, l'outil de relecture s'attache à 3 tâches principales :

- La rédaction des remarques, en créant les champs et en les remplissant dans
  la mesure du possible (notamment le numéro de ligne et leur contenu) et en y
  mettant un peu d'ordre, voir |rq-format-remarques|.

- La navigation dans les remarques, celle-ci pouvant se faire depuis le
  fichier relu ou depuis les remarques (un peu à l'image de Quickfix, en
  mettant à jour les positions des curseurs dans les différentes fenêtres),
  voir |rq-greffon|.

- La prise en compte des remarques, en ajustant les décalages causés par la
  suppression ou l'ajout de caractères dans le fichier relu, ainsi que la
  rédaction de réponses/commentaires dans le fichier de remarques si débat il
  y a (et il y en a souvent !), voir |rq-greffon|.

L'outil comprend un greffon permettant des traitements entre le fichiers en
cours de relecture et un fichier contenant les remarques et les commentaires
formulés par le relecteur. Un fichier de syntaxe permet la coloration du
fichier de remarques.

==============================================================================

Comment ça marche

Pour que le greffon fonctionne comme prévu, le fichier relu et le fichier de remarques doivent être ouverts dans le même Vim. Après :

(Extrait du greffon)

" - globaux :
"              ,n      Saute à l'emplacement de la remarque suivante
"              ,p      Saute à l'emplacement de la remarque précedente
"              ,f      Saute à l'emplacement de la première remarque
"              ,l      Saute à l'emplacement de la dernière remarque
"              ,N      Comme ",n", pour une remarque à traiter
"              ,P      Comme ",p", pour une remarque à traiter
"              ,F      Comme ",f", pour une remarque à traiter
"              ,L      Comme ",l", pour une remarque à traiter
"              ,a      Ajoute une réponse à une remarque
"              ,x      Reporte le texte proposé dans le fichier relu
" - pour le fichier de remarques uniquement :
"              ,s      Saute à la ligne concernée par la remarque courante
"              ,j      Saute à la prochaine réponse courante du correspondant
"              ,k      Saute à la précédente réponse courante du correspondant
"              ,g      Insère des statistiques à propos des remarques
"              ,e      Crée l'en-tête du fichier de remarques 
"              ,R      Ajoute une remarque vide
"              ,w      Enregistre sans mise à jour des en-têtes
" - pour le fichier relu uniquement :
"              ,s      Retourne dans le fichier de remarques
"              ,r      Ajoute une remarque à propos de la ligne courante

Exemple

Voici un fichier original, la traduction proposée par le traducteur, et les remarques formulées par un relecteur, agrémentées des arguments de chacun sur les passages faisant débat.

Le même fichier de remarques, en couleur.

-- 

Mes deux centimes d'euro :

Personnellement, je fractionne mon Vim horizontalement avec la version originale en haut, la traduction au milieu et les remarques en bas. Je lie le défilement des versions originale et traduite avec un

	:set scb

dans chaque fenêtre concernée et j'utilise intensivement

	:mksession! fichierrelu.vim

pour m'y retrouver d'une relecture à une autre.


Questions/remarques/suggestions : david.blanchet-AT-free.fr - 16 avril 2005

~
~
~
:wq