Suport technique et veille technologique

LinuxFr.org : les journaux  -  classeur, un script python quick&dirty pour avoir tout son texte dans un seul fichier

 -  11 janvier - 

Cher journal,

Il y a quelques semaines je demandais sur le forum linuxfr comment utiliser vim pour avoir tous les fichiers textes d'un document dans un même buffer.

S'en est suivi une réponse fleuve de Gil Cot transformée elle même en journal.

Pour résumer, mon problème était le suivant : J'aime bien rédiger ma documentation en markdown: ça fait de beaux diff, c'est lisible en texte brut et c'est convertible en tout un tas de format avec pandoc (à condition de passer un peu de temps à tout configurer quand même).

Mais pour la doc de projet informatique, j’essaie de mettre les fichiers au plus près du code, avec des fichier de documentation dans chaque répertoire. Comme pour le projet fpgamacro qui a un README.md par module. Textes que je rassemble ensuite pour créer un seul document grâce à de la cuisine Makefile/Pandoc.

Sauf que quand on multiplie les petits fichiers ça devient compliqué de switcher avec vim (mais c'est le même problème avec tous les éditeurs en fait) et j'aimerais bien les rassembler dans un même «buffer» pour avoir une vue sur tout le texte.

Un ami m'a ensuite fait remarquer que mon problème ne se cantonne pas à vim, quelques soit l'éditeur, il est pénible d'avoir à switcher entre des onglets ou autres fenêtres. Donc autant faire un petit script qui colle (merge) tous ces fichiers dans un seul pour l'éditer. Et avoir un deuxième script (ou une option) pour les redécouper et mettre à jour les fichiers texte à leurs place.

C'est donc l'objet de Classeur. Un logiciel écrit en python qui permet de «coller» tous les fichiers textes donnés en argument avec des séparateurs donnant le chemin du fichier collé :

$ classeur -m intro.md chapitre1.md pouet.md annexes.md -o my_merged_doc.md
Merging intro.md
Merging chapitre1.md
Merging pouet.md
Merging annexes.md
Merged 4 files in my_merged_doc.md

On peut éditer le fichier my_merged_doc.md pour écrire sa doc. Chaque fichier est chapeauté du chemin/nom du fichier édité entouré de caractères ciseaux «✂✂✂»:

$ cat my_merged_doc.md 
✂✂✂ intro.md ✂✂✂
= Introduction =

J'adore LinuxFR, c'est un super rocher.
✂✂✂ chapitre1.md ✂✂✂
= Comment s'accrocher à un rocher =

Dans ce chapitre nous parlerons de l'art de s'accrocher aux rocher malgré les
marées.
✂✂✂ pouet.md ✂✂✂
prout
✂✂✂ annexes.md ✂✂✂
= Annexes =

Toutes les références marine.

Une fois que l'on est content de son texte et que l'on souhaite mettre à jours les fichiers correspondants on utilise la commande «split» pour redécouper en suivant bien les ciseaux et remettre les textes dans leurs fichiers respectifs.

$ classeur -s my_merged_doc.md 
Splitting my_merged_doc.md with scissors «✂✂✂»
Found file intro.md
Found file chapitre1.md
Found file pouet.md
Found file annexes.md

Il ne reste plus qu'à faire un diff avec git et/ou commiter pour avoir sa doc à jour.

Bien placé dans son Makefile, classeur simplifie la vie de celles et ceux qui écrivent de la doc et qui doivent jongler avec tous ces feuillets qui traînent à droite et à gauche.

J'ai même fait un petit dessin/logo parce que j'avais envie de jouer avec ma tablette :

Voila, c'est tout. Je ne suis pas sûr que ça méritait une dépêche à la vue de la quantité de code pondu. Et je suis sûr qu'on peut faire ça avec les commandes Shell/Bash classiques, mais j'avais pas envie de me souvenir des commandes à chaque fois.

Je rêve de pouvoir ajouter une option permettant de mettre les pages du pdf généré dans le texte à l'image des bandeaux de découpe des fichiers (✂✂✂), mais c'est une autre histoire.

• Le dépôt de Classeur

Commentaires : voir le flux Atom ouvrir dans le navigateur

par martoni