Zettlr on Framatophe

Guide pratique d'artisanat numérique à l'université

situveuxmonadresse@demande-la.moi (Christophe Masutti) — Sat, 27 Dec 2025 00:00:00 +0000

Je viens de créer un guide qui s’adresse aux étudiants et enseignants-chercheurs qui souhaitent progresser dans la maîtise d’une chaîne de production numérique, de la prise de notes à la production d’un cours, d’un article, d’un rapport, d’une thèse, ou d’un livre.

Créé avec Zensical, le successeur de MKDocs, ce guide a pour objectif de vous aider construire votre environnement de travail avec des logiciels libres.

Vous pouvez le trouver à cette adresse : libruniv-c29483.frama.io.

Voici un extrait de l’introduction

La vie de chercheur·euse ou d’étudiant·e est souvent un combat contre la machine. Au fil des années, j’ai vu combien nos dispositifs numériques — les conditions matérielles de notre travail intellectuel — peuvent devenir des poisons psychiques et physiques lorsqu’ils sont subis. Quand l’outil est mal compris, il cesse d’être une extension de la pensée pour devenir une entrave.

Chacun·e connaît ce naufrage : le traitement de texte ralenti à la centième page, la bibliographie qui foire la veille d’un rendu, l’idée géniale perdue dans le brouillard des fichiers nommés au hasard… Le problème n’est pas l’absence de compétences de base — tout le monde sait envoyer un mail ou lancer un diaporama. Le problème, c’est l’absence de fondations saines. Nous ne construisons pas notre environnement numérique selon nos besoins, mais selon des habitudes.

Évidemment, certains secteurs disciplinaires, à commencer par les sciences informatiques, seront bien plus exempts de ces difficultés puisque la condition pour intégrer un cursus est un niveau de compétences numériques élevé. En dehors, cependant, l’usage des logiciels bureautiques classiques est considéré comme un horizon indépassable. Le reste est perçu comme une aventure en territoire inconnu. On calcule alors, souvent mal, le rapport entre l’énergie nécessaire pour apprendre de nouveaux outils et celle, épuisante, dépensée à produire laborieusement des connaissances avec des logiciels inadaptés.

Ce n’est ni de la procrastination, ni de l’inadaptation : c’est un manque d’accompagnement. Les étudiant·es ignorent l’existence même d’alternatives ; les enseignant·es-chercheur·euses confirmé·es, prisonnier·es du « ça marche comme ça », s’épuisent dans des méthodes artisanales peu efficaces mais familières.

Ces situations créent des verrous numériques. Les suites propriétaires, comme Microsoft Office, nous emprisonnent dans des systèmes opaques : elles promettent la sécurité d’un cloud inconnu (et souvent malveillant) et nous dépossèdent de la maîtrise de nos fichiers. On multiplie les sauvegardes redondantes, on s’égare entre les notes manuscrites et les documents en ligne, et l’on finit par succomber aux promesses des services basés sur des grands modèles de langages (on dit aujourd’hui : « IA ») qui proposent de trier nos vracs numériques à notre place. Résultat : une perte totale de concentration et de sens.

Ce guide propose de briser ces verrous

Il ne s’agit pas seulement de « mieux cliquer », mais de reprendre le contrôle sur votre production intellectuelle par le logiciel libre.

Organisation et production de texte

situveuxmonadresse@demande-la.moi (Christophe Masutti) — Sun, 07 Jul 2024 00:00:00 +0000

Les années passent et il est indéniable que les habitudes prises au fil du temps montrent leur efficacité au regard de la pratique plus que de la logique. Néanmoins, il me semble que mon organisation logicielle et mon flux de production peuvent intéresser. C’est pourquoi je vous les présente ici.

Les objectifs

Utiliser exclusivement des logiciels libres et des formats ouverts pour assurer la pérennité de la production dans le temps ;
Pouvoir utiliser les logiciels que je veux (et au fil de mes découvertes) indépendamment de l’organisation de mes fichiers pour ne pas dépendre d’un logiciel en particulier ;
Ne pas se retrouver prisonnier d’un format, fût-il libre ;
Assurer la sauvegarde de mes sources et de mes travaux ;
Pouvoir travailler sur plusieurs machines, à plusieurs endroits si je le souhaite.

Les choix stratégiques

Ayant l’habitude de travailler avec une suite bureautique comme LibreOffice et les formats ouverts, il me fallait trouver un processus qui soit capable de produire de tels formats. En revanche, l’utilisation de logiciels de traitement de texte, comme LibreOffice Writer, est assez lourde : bien qu’il soit possible d’utiliser les raccourcis claviers, l’ensemble propose une pléthore de menus et autres options qu’il n’est finalement pas pertinent d’avoir à disposition lorsqu’on produit du texte. Par ailleurs, la règle qui prévaut avec les suites bureautiques consiste à s’occuper de la mise en page après avoir produit du texte. Dans ce cas, pourquoi ne pas séparer les deux processus ? Séparer la production de texte de sa valorisation finale.

Il existe, d’un côté, des outils pour produire et organiser et, de l’autre côté, des outils pour finaliser et mettre en page. Se concentrer sur la production implique cependant d’avoir des outils spécifiques : faciliter l’écriture, y compris du point de vue ergonomique, permettre d’interagir facilement avec d’autres logiciels (gestion bibliographique, synchronisation des fichiers, etc), privilégier le texte dans l’interface sans l’enfermer dans un formatage dont il sera difficile de s’extraire par la suite.

C’est là qu’un troisième terme intervient : la conversion. À partir d’une production essentiellement textuelle, il doit être possible de convertir la production vers des formats soit directement destinés à être transmis, soit destinés à entrer dans un flux de mise en page spécifique. Par exemple, je convertis du texte vers un format LaTeX pour peaufiner une mise en page ou je le convertis vers un format ODT pour le transmettre à une autre personne qui a besoin de ce format, ou bien encore je produis du HTML ou du epub pour d’autres usages encore. Et cette conversion doit être la plus « propre » possible.

Les outils de production doivent être choisis en fonction des goûts et des pratiques. Comme il s’agit de texte, c’est donc vers les éditeurs de texte qu’il faut se tourner. Parmi ceux-ci, certains sont plus spécialisés que d’autres ou disposent d’options et d’extensions utiles à la production elle-même ou visant à améliorer la pratique de l’utilisateur.

Le format de référence

S’agissant d’un format dont la permanence dans le temps doit être assurée, le format devrait reposer sur une base de texte (plain text), écrit directement dans l’éditeur, formaté de manière simple et lisible humainement. Pour cela on laissera la possibilité d’exprimer des directives de mise en page et de hiérarchisation du texte, faciles à apprendre et gênant le moins possible la lecture. Au lieu de se contenter de texte simplement exprimé, on utilisera le langage markdown, un langage de balisage léger, simple à l’apprentissage comme à l’écriture et qui ne gêne pas la lecture (surtout si l’éditeur dispose d’une interprétation du markdown).

L’organisation

J’utilise une interprétation personnelle de la méthode Zettelkasten pour gérer mes connaissances et mes notes. Cela suppose une gestion rigoureuse des dossiers et des fichiers.

J’utilise aussi un logiciel de gestion bibliographique (Zotero) et un logiciel de gestion de livres numériques (Calibre), et j’apprécie l’utilisation d’un correcteur grammatical (comme Grammalecte).

Je sauvegarde mes sources et mes productions finales sur un serveur distant avec Nextcloud. Je travaille mes textes en les synchronisant avec Git sur un serveur Gitlab. Tandis que Nextcloud me permet d’avoir accès à mes sources depuis n’importe quel dispositif (tablette, liseuse, téléphone portable et ordinateur), travailler avec Git me permet de synchroniser lorsque je travaille sur différentes machines et de versionner mes productions intermédiaires et mes notes. Pour la bagatelle, l’ensemble est de toute façon sauvegardé de manière quotidienne sur un autre serveur avec Borg backup/Borgmatic.

Le choix des éditeurs

Un éditeur de texte doit comprendre à minima une coloration syntaxique permettant de visualiser les balises markdown. Mais ce n’est pas suffisant pour travailler sur des articles de recherche académique, par exemple. Il faut pour cela que l’éditeur puisse :

proposer une interface agréable et hautement configurable pour une utilisation quotidienne,
permettre d’écrire « au kilomètre » sans avoir besoin de saisir la souris à la moindre occasion,
permettre si possible une interaction avec un logiciel de gestion bibliographique, par exemple pour saisir facilement les clés de références bibliographiques citées,
proposer divers outils destinés à l’organisation de l’écriture : l’arborescence des fichiers, une navigation dans le texte, un gestionnaire de mots-clés pour les références croisées, une correction orthographique et grammaticale, etc.
permettre de temps à autre une interaction avec le reste du système d’exploitation, par exemple avoir accès au terminal pour lancer des commandes de conversion, ou de gestion de fichiers,
avoir accès à des petits programme de conversion « intégrés » pour un premier aperçu des résultats de production finale

Certains éditeurs de texte proposent tout cela en même temps, avec un système de plugins et il est parfois facile de se noyer dans la configuration d’un éditeur de texte. Comprenez : un éditeur de texte digne de ce nom doit pourvoir s’adapter à la pratique de son utilisateur, et non l’inverse. Si bien que les besoins étant relatifs, les solutions qui se présentent dans le monde des logiciels libres sont quasiment infinies. Il est même possible de programmer son propre plugin et refaire tout le mapage des commandes si on prend le cas des éditeurs Emacs ou Vim.

J’ai donc porté mes choix vers plusieurs éditeurs qui correspondent à mes usages et me permettent de choisir l’un ou l’autre selon mes envies et ce que je prévois de faire durant une session de travail :

Zettlr : parce que ce logiciel a été pensé littéralement pour la production de textes scientifiques,
Vim : parce qu’il s’utilise dans le terminal et qu’un Vim bien configuré avec les bons plugins est très efficace (plugins utilisés: vim-pandoc, vim-pandoc syntax, Nerd Tree, Grammalecte, vim-airline…)
Gedit : un éditeur simple, prêt à l’emploi, sans fioritures.
On peut aussi citer les éditeurs spécialisés pour markdown tel Ghostwriter.

Pourquoi ne pas…

Utiliser Emacs ? je l’ai fait et le ferai encore. En ce moment c’est Vim. Emacs propose, du point de vue de mes besoins, les mêmes possibilités.
Utiliser directement LibreOffice : certes les extensions de type Zotero et Grammalecte sont disponibles pour LibreOffice, et il est possible d’exporter depuis LibreOffice dans de nombreux formats. Par contre, LibreOffice ne propose pas une interface que je puisse conformer à mes usages et mes besoins, et tout particulièrement la possibilité d’écrire au kilomètre sans que mes mains quittent le clavier pour se saisir à tout bout de champ de la souris. Je réserve donc LibreOffice à un autre usage en fin de processus.
Utiliser des logiciels de gestion de notes comme Obsidian ou Logseq : parce que justement leur usage spécialisé est trop éloigné de mes usages académiques.

L’organisation

Rien ne vaut un bon vieux diagramme !

Comme on peut le voir, quatre dossiers principaux sont en jeu : Bibliographies, Templates, Notes, Travaux. Je ne sors pas de ces dossiers et ils sont systématiquement synchronisés avec Git sur un dépôt Gitlab.

Bibliographies : il contient les fichiers bibliographiques que j’utilise et tout particulièrement un fichier .json généré avec Zotero et qui se met à jour automatiquement à chaque ajout dans Zotero. C’est sur ce fichier que pointent mes éditeurs (Zettlr et Vim) pour interagir avec la bibliographie et entrer les clés de références.

Templates : il contient les styles et modèles utilisés pour les productions en sortie de flux. À savoir : les fichiers .csl pour les styles bibliographiques utilisés, les fichiers css utilisés pour sortir des fichiers HTML ou certains PDF, ou encore des modèles .odt qui me permettent de plaquer directement des styles à une sortie .odt « brute ».

Notes : Il s’agit de mes fichiers d’écriture selon la méthode Zettelkasten.

Travaux : là où sont rédigés les textes destinés à sortir du flux, par exemple des articles destinés à la publication. Notons que les sorties elles-mêmes n’ont pas vocation à être versionnées avec Git (seuls les fichiers sources le sont), et sont donc exportées dans d’autres dossiers (sauvegardés sur Nextcloud).

La conversion et la production

Pour convertir les fichiers markdown vers toutes sortes de formats (odt, html, pdf, docx pour l’essentiel), j’utilise Pandoc. Ce dernier présente de nombreux avantages :

une version de Pandoc est directement intégrée à Zettlr

il permet d’utiliser les templates et les moteurs qui configurent la sortie voulue, par exemple un fichier .css qui sera utilisé avec le moteur de rendu wkhtmltopdf pour produire un PDF avec une mise en page satisfaisante, ou encore un fichier .tex qui contient déjà les en-têtes voulus pour produire un beau PDF, etc. Voir pour tout cela le manuel de Pandoc.
surtout il permet d’utiliser le moteur Citeproc et les fichiers CSL qui formatent la bibliographie dans le fichier de sortie.

Cependant, j’utilise LaTeX et LibreOffice souvent en phase de pré-production. Par exemple, lorsque je soumets un article à un comité de lecture, ce dernier souhaite un fichier odt ou docx et propose des corrections sur ce fichier ; c’est donc LibreOffice qui entre en scène. Il faut alors quitter le flux de production personnel pour envisager un nouveau flux. Autre situation : je convertis le markdown en .tex lorsque le modèle utilisé ne suffit pas à obtenir une mise en page spéciale et qu’il faut travailler cette fois directement avec LaTeX (bien que, en utilisant Pandoc, il soit possible d’intégrer directement du code LaTeX dans le fichier markdown).

Dans tous les cas, l’essentiel du travail se fait en amont et un article finalisé (et publié) réintègre toujours le flux pour en avoir une version markdown finale.

Un mot sur les autres logiciels

Zotero : ce logiciel de gestion bibliographique est fort connu. Il présente l’avantage de pouvoir être utilisé dans les autres logiciels avec ses plugins : dans Firefox pour sauvegarder une référence automatiquement, dans Vim, dans Zettlr, dans LibreOffice. Il permet aussi de stocker les articles et autres sources référencées soit sur le serveur de stockage de Zotero (payant) soit sur un Nextcloud (via le protocole webdav).
Calibre : c’est un logiciel de gestion de livres numériques. Ma collection étant assez importante, il me fallait pouvoir gérer cela autrement qu’avec Zotero, d’autant plus que j’y branche ma liseuse ou ma tablette en vue d’une lecture sur un autre support que l’ordinateur.

Astuces

Je ne vais pas ici vous expliquer comment configurer Vim au poil. Cela demanderait un développement assez long. Mais je vous conseille pour débuter le petit livret de Vincent Jousse, Vim pour les humains. Vous y apprendrez comment prendre en main Vim rapidement et comment installer des plugins. Le reste ira très bien.

Pour commencer avec Zettlr, c’est plus simple : dès l’installation de ce logiciel un tutoriel très bien fait et entièrement en français vous sera proposé.

Le markdown en un tutoriel pour historiens : Dennis Tenen et Grant Wythoff, Rédaction durable avec Pandoc et Markdown.

Comment faire avec Zotero pour obtenir un fichier (.bib ou .json) de bibliographie qui se mettra à jour automatiquement ? Voici :

Installez le Plugin Better Bibtex pour Zotero,
Dans Zotero, sélectionnez la bibliothèque que vous souhaitez exporter, clic droit puis Exporter la bibliothèque,
Sélectionnez le format Better BibTeX Json et cochez la case Garder à jour
Sauvegardez et entrez le chemin vers ce fichier dans Zettlr (ou dans votre .vimrc pour configurer le plugin Vim-Pandoc)
Désormais, lorsque la bibliothèque Zotero subira des modifications, le fichier d’export sera toujours à jour (et vous retrouverez vos nouvelles références)

Lettres et articles avec Zettlr ou Pandoc

situveuxmonadresse@demande-la.moi (Christophe Masutti) — Sun, 11 Apr 2021 00:00:00 +0000

Utiliser le célèbre convertisseur de document pandoc signifie manier (un tout petit peu) la ligne de commande. Rien de sorcier, pour peu d’être assez ouvert d’esprit pour comprendre qu’en matière de traitement de texte tout n’est pas censé se régler au clic de souris. Cela dit, le logiciel Zettlr permettent de s’affranchir de la ligne de commande tout en utilisant la puissance de pandoc. Zettlr propose une interface optimale pour écrire du texte en markdown et exporter dans différents formats. Il suffit d’aller voir dans les préférences avancées de Zettlr pour constater que ce dernier utilise une sorte de ligne de commande universelle avec pandoc pour réaliser ses exports. Pour ce qui concerne l’export en PDF, Zettlr utilise aussi LaTeX qu’il faudra installer sur la machine au préalable, tout comme pandoc.

J’ai écrit un petit billet sur Zettlr. Vous pouvez aller le lire pour mieux comprendre ce que je vais raconter ci-dessous.

Si vous n’avez pas envie de lire ce billet et souhaitez directement vous servir des modèles que je propose, vous trouverez l’ensemble sur ce dépôt GIT. Il y a un fichier README suffisant.

Pandoc et LaTeX

Qu’en est-il de la mise en page ? C’est là que les avantages combinés de pandoc et de LaTeX entrent en jeu : il est possible, en quelque sorte, de « programmer » la mise en page en élaborant des modèles qui utilisent différentes variables renseignées dans le fichier source en markdown. Bien entendu, on peut créer des modèles pour tout type d’export avec pandoc et d’ailleurs ce dernier utilise une batterie de modèles par défaut, mais ces derniers ne sont pas toujours adaptés à la sortie finale : qu’on utilise Zettlr ou non (ou n’importe quel éditeur de texte), il faut savoir compléter son fichier markdown avec des informations destinées à être taitées par pandoc.

Pour information, si pandoc s’utilise en ligne de commande, c’est parce qu’il y a toute une batterie d’options et de commandes que pandoc est capable d’exécuter. Pour éviter de les entrer systématiquement en ligne de commande, on peut les indiquer simplement dans l’en-tête du fichier markdown (ou dans un fichier séparé). Pour mieux comprendre de quoi il s’agit, vous pouvez vous reporter à ce document.

Pour donner un exemple trivial : si vous voulez que votre document markdown une fois exporté comporte un titre, un nom d’auteur et une date, il vous suffit de les indiquer de cette manière dans l’en-tête au début du document (on les appellera des « métadonnées ») :

``
% Le titre
% Prénom Nom
% 17/02/2021
``

Ou bien, en utilisant le format YAML :

``
---
title: "Le titre"
date: "17 février 2021"
author: "Prénom Nom"
...

``

Ainsi, pandoc les interprétera et, en utilisant un modèle par défaut ou un modèle de votre cru, reportera ces variables aux emplacements voulus dans la mise en page.

Si vous voulez écrire un article académique et le sortir en PDF en utilisant pandoc qui lui-même utilisera LaTeX, il vous faut donc réunir les éléments suivants :

un modèle LaTeX (ou se contenter des modèles LaTEX par défaut de pandoc),
des métadonnées à entrer après s’être bien renseigné sur la manuel d’utilisation de pandoc,
un fichier de bibliographie,
un fichier de style de présentation de la bibliographie.

En comptant les options courantes de pandoc que vous souhaitez utiliser, vous risquez de vous retrouver avec une ligne de commande assez longue… pour éviter cela, vous pouvez automatiser le tout avec un makefile que vous pourrez réutiliser plus tard pour d’autres documents, mais bigre… cela commence à devenir bien complexe pour qui n’a pas forcément envie d’y passer trop de temps, à moins de concevoir une fois pour toute une chaîne éditoriale que vous adapterez au fil du temps (c’est une option).

Zettlr et les modèles

Un grand avantage de Zettlr est de vous décharger de plusieurs de ces contraintes, en plus d’offrir une interface vraiment pratique entièrement destinée à l’écriture. Pour réaliser des exports, il vous faudra seulement installer pandoc. Et pour réaliser des exports PDF, il vous faudra installer LaTeX (je préconise une installation complète, par exemple Texlive-full).

Le fichier et le style CSL de bibliographie ? il vous suffit de les renseigner dans les préférences de Zettlr une fois pour toutes.

Le modèle de sortie PDF ? idem, vous le renseignez dans les préférences d’export PDF.

Et pour exporter ? il vous suffira de cliquer sur l’icône PDF.

Tout cela demeure assez simple, sauf que si vous rédigez un article sans chercher à travailler la question des métadonnées, votre sortie PDF risque de vous décevoir : pandoc utilisera le modèle par défaut, c’est-à-dire la classe [article]de LaTeX, qui en soi est une excellente mise en page, mais ne colle pas forcément à vos souhaits.

Réaliser des modèles pour pandoc est chose assez facile. En effet, si vous comprenez des notions informatiques basiques comme « pour…si…ou…alors », la syntaxe des modèles pandoc ne posera guère de problème. Il faudra néanmoins maîtriser LaTeX si vous voulez créer un modèle LaTeX.

Mes modèles article, rapport et lettre

Pour vous éviter d’y passer trop de temps, je vous propose d’utiliser mes modèles élaboré pour des articles, des rapports ou des lettres simples.

J’ai pris le parti de réaliser un modèle LaTeX destiné à chaque fois à la sortie voulue, là où le modèle pandoc par défaut permet de créer un article, une présentation ou un livre en indiquant simplement la classe voulue. Ce modèle par défaut inclu donc de nombreuses variables mais à trop vouloir être généraliste, je pense qu’on loupe l’essentiel.

Pour utiliser mes modèles, il vous suffit de réutiliser les fichiers markdown renseigner les différents éléments présents dans les en-têtes YAML de ces fichiers. Si vous voulez modifier les modèles eux-mêmes, il vous suffit de les éditer : j’ai tâché de commenter et de bien séparer les éléments importants.

Ces modèles utilisent KOMA-script, la classe scrartcl pour les article, scrreprt pour les rapports et scrlttr2 pour les lettres. Si vous connaissez LaTeX, vous comprendrez que KOMA-script est un excellent choix pour des documents européens (il fut créé au départ pour des documents de langue allemande, mais il fut rapidement adapté à différentes pratiques d’écriture, dont le Français).

Pour résumer très simplement :

si vous écrivez une lettre, renseignez dans Zettlr le chemin vers le modèle dans les préférences d’export PDF,
si vous écrivez un article ou un rapport, renseignez dans Zettlr le chemin vers le modèle dans les préférences d’export PDF et notez que le modèle utilise les styles CSL pour la bibliographie (pas de biblatex ou de natbib, donc),
si vous ne voulez pas utiliser Zettlr, et uniquement pandoc, je vous ai indiqué dans le README les lignes de commande à utiliser (ce sont celles qu’utilise Zettlr, en fait).

Vous trouverez l’ensemble sur ce dépôt GIT.

Zettlr : markdown puissance dix

situveuxmonadresse@demande-la.moi (Christophe Masutti) — Tue, 18 Feb 2020 00:00:00 +0000

Le logiciel libre a toujours quelque chose de magique. Cédant au plaisir coupable d’une attitude consommatrice, on se met à essayer frénétiquement plusieurs solutions logicielles, rien que « pour voir ». Zettlr fera-t-il partie de ces nombreux éditeurs markdown que je recense dans l’espoir de trouver le Graal du genre ? Attention : on n’essaye pas Zettlr sans en comprendre d’abord les objectifs.

Comparaison et flux de travail

Dès les premières pages de présentation dans la documentation de Zettlr, on voit clairement que pour se servir de ce logiciel, il faut de bonnes raisons.

On peut expliquer ces raisons en comparant Zettlr avec d’autres éditeurs spécialisés dans le markdown. Essayons par exemple de le comparer Ghostwriter (j’en ai parlé dans ce billet), du point de vue utilisateur.

La première différence c’est que là où Ghostwriter propose une interface très facile et rapide à prendre en main… Zettlr n’est pas aussi explicite. Bien sûr, on peut d’emblée commencer à écrire en markdown, enregistrer un fichier, mais ce n’est pas le but unique de Zettlr. Si Ghostwriter se concentre avant tout sur la partie éditeur, Zettlr est à la fois dédié à l’écriture et à la gestion de connaissances. Et pour cause, il a été créé et il est utilisé essentiellement dans le monde universitaire. C’est donc dans un contexte qui concerne les documents longs qu’il faut appréhender Zettlr, là où Ghostwriter servira bien la cause pour écrire un billet de blog, par exemple.

En fait tout se joue dans la manière dont on intègre un éditeur markdown dans un flux de travail. Dans mon cas, l’éditeur que j’utilise ne constitue pas un nœud décisif, ce qui fait que, selon les situations, je peux opter pour un autre éditeur (spécialisé ou non dans le markdown) pour continuer à travailler sur le même document.

J’aime bien avoir cette possibilité d’utiliser plusieurs éditeurs pour un même fichier, indépendamment du système sur lequel je travaille. Ensuite, pour produire le document final, j’exporte directement dans un format donné (si l’éditeur le permet) ou bien j’utilise pandoc qui me permet de transformer le fichier markdown en à peu près tout ce que je veux. Dans ce cas, je « sors » de l’éditeur pour utiliser la ligne de commande, puis une fois le document produit, j’utilise un autre logiciel pour terminer ma production selon le format choisi (LibreOffice pour.odt, un éditeur TeX pour(La).TeX, un éditeur de texte pour le .html, LibreOffice pour .docx, etc.). Pour les questions liées à la gestion de la bibliographie, c’est un peu complexe, puisque je suis contraint d’ouvrir, en plus de mon éditeur, un gestionnaire de bibliographie tel Zotero ou JabRef, repérer les clé bibtex des références, les insérer sous la forme [@dupont1955].

Tout dépend des goûts, mais on voit bien qu’un éditeur markdown trouve vite ses limites lorsqu’on commence à intégrer le markdown dans une démarche de rédaction plus « soutenue » et afin de rédiger des documents longs. Des allers-retour avec d’autres logiciels (notamment pour la gestion de la bibliographie) sont nécessaires.

Bien sûr les éditeurs comme Ghostwriter permettent de faire des exports en différents formats. Ils peuvent même créer du PDF en utilisant LaTeX (c’est d’ailleurs l’option recommandée pour un bon résultat, à condition d’avoir préalablement installé LaTeX). Mais il faut savoir se méfier des solutions qui prétendent tout faire. Ainsi, lorsqu’on commence à manipuler de la bibliographie, les « exports-gadgets » sont plus encombrants qu’autre chose. Cependant, il faut reconnaître que Zettlr a plutôt bien réussi à intégrer ces fonctionnalités d’export.

Pour ce qui me concerne, la solution que j’ai adoptée consiste à utiliser un éditeur de texte nommé Atom qui dispose d’extensions permettant d’écrire en markdown, faire de l’autocomplétion avec du Bibtex, intégrer un convertisseur avec pandoc et utiliser la console pour lancer des commandes (et plein d’autres choses). Cela me permet d’avoir mon flux de travail concentré pour l’essentiel sur un seul logiciel et utiliser les fonctionnalités au besoin, en gardant l’avantage de segmenter l’activité.

Alors, si de tels couteaux suisses existent, me demanderez-vous, pourquoi s’intéresser à Zettlr ? parce que les couteaux suisses demandent un temps d’apprentissage assez long, disposent d’une foule de fonctionnalités au point de s’y perdre et que Zettlr cherche à concentrer l’essentiel (avec quelques bémols toutefois).

De la gestion de connaissance

Avant de parler des fonctionnalités concrètes de Zettlr, il faut questionner l’ambition générale de ce logiciel.

Il a été créé essentiellement pour les chercheurs et les écrivains. C’est d’ailleurs un chercheur en sciences humaines, Hendrik Erz, qui a créé Zettlr afin de pouvoir sortir du carcan « traitement de texte » qui ne correspond pas vraiment aux besoins lorsqu’on écrit ou prend des notes dans une activité de production de connaissances (là où le traitement de texte devrait intervenir à une étape ultérieure de « mise au propre »).

Quels sont ces besoins ? pouvoir écrire en se concentrant sur ce qu’on écrit, tout en disposant d’une aide pour accéder aux ressources cognitives qu’on aura prit soin d’organiser en amont.

Cette organisation passe par la gestion bibliographique (à l’aide de logiciels dédiés tels Zotero) ainsi que par la gestion des notes et autres notices ou fiches que l’on stocke dans un système de pensée qui nous est propre.

Pour ce qui concerne la gestion bibliographique, l’utilisation de logiciels dédiés (et capables de sortir différents formats de bibliographie) est une habitude que bon nombre de chercheurs ont déjà (si ce n’est pas le cas, il y a un problème). Zettlr permet d’intégrer l’utilisation de références bibliographiques au cours du travail d’écriture dans l’éditeur markdown. Il suffit de renseigner le fichier .bib (ou CSL Json, qu’on obtient avec Zotero) puis Zettlr permet son utilisation au cour de la frappe. Cela rappelle par exemple l'extension Zotero qu’on installe dans LibreOffice, mais de manière plus brute et beaucoup plus fluide.

Pour ce qui concerne la mobilisation des connaissances, Zettlr a été conçu pour créer un système de Zettelkästen. On le note en allemand (ici au pluriel) parce que, pour un néophyte qui se rendrait dans les options de configuration de Zettlr, il y a une rubrique entièrement dédiée au « flux de travail Zettelkasten », et très franchement ça peut surprendre (sauf qu’on comprend aussi pourquoi Zettlr se nomme ainsi).

Une Zettelkasten signifie littéralement « boîte » (der Kasten) à notices ou pense-bêtes (der Zettel). Personnellement j’appelle cela une « boîte à fiches ». Dans ce cas, direz-vous, il y a déjà des logiciels spécialisés dans les « notes », y compris en permettant de synchroniser en ligne, avec une interface pour smartphone, etc. Oui, évidemment, et il n’est pas idiot de penser que, dans la mesure où ces logiciels de prise de notes utilisent le plus souvent le markdown, ces notes peuvent aussi être ouvertes avec Zettlr (c’est que je fais). Mais cela va plus loin.

Zettlr permet de créer des fiches tout en créant soi-même un système de rangement. C’est ce qui est expliqué ici. Le logiciel ne cherche pas à formater les notes ou à créer une seule manière de les rédiger ou les stocker : c’est à vous de créer votre système de rangement. On utilise alors pour cela les outils courants de liens externes entre les fiches et les mots-clés qu’on note pour chaque fiche. Un genre wiki, si on veut (même si un logiciel comme Dokuwiki sera bien plus puissant), mais sans quitter Zettlr.

L’intérêt réside selon moi dans la création et le nommage des fiches. Selon le besoin, il est possible de configurer l’identifiant de la fiche (le nom du fichier) et créer des liens entre les fiches en profitant de l’assistant (menu contextuel qui liste les noms de fiche). Ces fonctionnalités sont très simples, on pourra même les qualifier de basiques, mais à l’utilisation quotidienne, elle permettent un réel gain de temps… Et à propos de temps on notera que si Zettlr propose un format d’export en Org (pour Emacs), ce n’est pas pour rien !

Aide à la saisie

Zettlr est d’abord un éditeur markdown et le moins qu’on puisse dire est qu’il accompli ce rôle avec brio. L’aide à la saisie, indissociable de l’interface, est soignée.

Outre un petit menu, en haut, dédié à la mise en forme, on notera :

la visibilité automatique des titres de section, avec la possibilité de masquer la section ;
l’aide à la saisie de tableaux ;
quelques raccourcis et astuces (voir la documentation) tels la combinaison Ctrl + alt + F qui permet d’entrer une référence de note de bas de page automatiquement, ou encore Ctrl + alt + pointage curseur qui permet de saisir le même texte à deux endroits en même temps…

Correction en cours de frappe

L’ajout d’une fonction de correction basée sur des dictionnaires est quelque chose d’assez banal. Zettlr l’intègre pour plusieurs langues et c’est un atout très important. Mais pour un éditeur markdown, la possibilité de configurer soi-même la correction en cours de frappe est, osons le dire, assez exceptionnel. Ainsi, dans Paramètres > AutoCorrect il est possible d’activer l’utilisation des guillemets selon le contexte linguistique, mais aussi toutes sortes de saisies utiles, en particulier pour la typographie. Ainsi, on peut faire en sorte que la frappe d’un double point soit remplacée par une séquence qui associe une espace insécable (AltGr + Esp) et un double point, et toutes autres joyeusetés relatives aux règles typographiques.

Travailler par projet

Comme le font beaucoup d’éditeurs, en particulier pour la programmation, l’utilisation de Zettlr sera d’autant plus efficace si vous optimisez la gestion des fichiers en créant un dossier par projet. C’est ce dossier que vous ouvrez alors, et c’est dans ce dossier que seront listés les fichiers que vous créez (dans le panneau de gauche). Ainsi, dans les options d’export, je conseillerais plutôt de cocher l’option qui consiste à sauvegarder les fichiers exportés dans le dossier en cours.

La bibliographie

Comme mentionné plus haut, Zettlr fournir un outil d’aide à la saisie de références bibliographiques.

Le principe qui a été retenu par les créateurs est celui-ci : dans les paramètres, vous entrez le chemin du fichier de bibliographie que vous avez créé. Vous pouvez entrer un fichier .bib ou un fichier .json créé par exemple avec Zotero.

À la différence de la gestion bibliographique via une extension Zotero ou JabRef dans le logiciel de traitement de texte tel LibreOffice, il faut entrer le chemin du fichier .bib ou .json dans les paramètres et ce seront ces données qui seront utilisées par Zettlr. Évidemment, si vous complétez votre bibliographie il faut s’assurer que Zettlr pourra bien trouver dans le fichier vos nouvelles références sans pour autant remplacer le fichier à chaque fois et devoir recharger Zettlr. Une fonctionnalité de Zotero vous sera très utile pour cela :

Dans Zotero, sélectionnez la bibliothèque que vous souhaitez exporter, clic droit puis Exporter la bibliothèque
Sélectionnez le format Better BibTeX ou Json et cochez la case Garder à jour
Sauvegardez et entrez le chemin vers ce fichier dans Zettlr
Désormais, lorsque la bibliothèque Zotero subira des modifications, le fichier d’export sera toujours à jour (et vous retrouverez vos nouvelles références)

À mes yeux, c’est une posture bancale. Certes, le fichier sera toujours à jour mais c’est une fonctionnalité qui dépend d’un autre programme (et tant pis si vous n’aimez pas Zotero). Par ailleurs, cela implique aussi que le fichier de bibliographie soit le même pour tous vos projets, ce qui signifie que si, comme moi, vous avez une biblio séparée pour chaque projet dans Zotero, la seule bibliothèque à exporter, c’est la principale. Cela dit, une fois configurée la bibliographie, Zettlr permet l’autocomplétion des références, ce qui est déjà d’une grande aide.

Ceci est valable aussi pour la configuration du format de bibliographie à la production de sortie, c’est-à-dire à l’export. En effet, pour formater la bibliographie, Zettlr permet de sélectionner le fichier de style CSL (que vous pourrez trouver sur ce dépôt ou via ce configurateur – reportez-vous à la section Bibliographie de ce billet pour comprendre de quoi il s’agit). Là encore, l’idée me semble bancale : si vous rédigez plusieurs documents avec des exigences différentes de format de bibliographie, il faut changer à chaque fois.

Donc idéalement, l’une des prochaines améliorations de Zettlr devrait inclure une solution d’extension Zotero ou JabRef capable de générer le fichier de bibliographie final à la volée et une solution de sélection de fichiers de style CSL. Plus facile à dire qu’à faire…

Export et pandoc

Pour utiliser les fonctionnalités d’export de Zettlr, il vous faut le logiciel pandoc installé sur votre système. Vous ne serez pas efficace si vous ne connaissez pas dans les grandes lignes le fonctionnement de ce logiciel… Qui ne connaît pas pandoc aura toutes les peines du monde à comprendre comment Zettlr exporte les fichiers dans un format choisi.

Pandoc est un logiciel de conversion muti-format très puissant et avec des résultats très propres (il ne s’encombre pas de formules polluantes qui rendent inutilisables les fichiers produits). Là où pandoc prend toute sa valeur dans notre cas, c’est qu’il permet de transformer le format markdown en à peu près tout ce que vous voulez. Par ailleurs, il est capable non seulement de convertir, mais aussi de convertir en utilisant des modèles et même d’autres logiciels qui paramètrent la conversion. Je vous invite à lire ce billet à propos de la manipulation de documents markdown et ce billet à propos de pandoc et LaTeX pour vous faire une idée (complétez aussi par celui-ci).

Ces lectures vont vous permettre de mieux comprendre la section des paramètres avancés de Zettlr.

Dans l’illustration, la liste des annexes concerne les fichiers que vous allez voir figurer dans le panneau latéral de droite (en cliquant sur la petit trombone) lorsque vous liez des documents annexes à votre document. Quant aux chemins vers pandoc et XeLaTeX, inutile de vous en soucier, pourvu que ces programmes soient bien installés.

Ce qui nous intéresse dans les paramètres avancés, c’est la commande pandoc réservée aux « utilisateurs avancés seulement ». Parce qu’en réalité, elle détermine comment pandoc doit fonctionner avec Zettlr. Essayons de comprendre.

Pandoc est un logiciel dont l’usage est simple. Ce n’est pas parce qu’il s’utilise en ligne de commande que cela en fait un logiciel compliqué. La preuve : pour utiliser pandoc, vous devez lancer la commande pandoc en précisant le fichier sur lequel vous voulez travailler, le nom du fichier à produire et les options et formats choisis pour la conversion. Ainsi la commande

$pandoc source.md -o sortie.odt

Consiste à produire un fichier .odt nommé « sortie » à partir d’un fichier nommé « source ». Le -o signifie « output » (vers la sortie).

Une variante pourrait être : $pandoc -f markdown -t odt bonjour.md … c’est à dire transformer le fichier « bonjour.md » du markdown vers (-f c-à-d. : from markdown vers -t c-à-d. : to) le .odt.

Ça va jusque là ? vous voyez il n’y a rien de compliqué. Continuons un peu.

Pandoc ne fait pas « que » convertir. Il est capable de convertir en utilisant des informations beaucoup plus complexes et qui permettent même d’enrichir le fichier de départ, surtout si ce dernier n’est qu’en markdown. Par exemple :

avec le programme citeproc il est capable d’interpréter un format de bibliographie (en CSL) et on aura pris soin de renseigner dans la ligne de commande à la fois l’option citeproc et le chemin vers le fichier de bibliographie ;
avec reveal.js il est capable de sortir, à partir d’un fichier markdown rédigé à cette intention, une très jolie présentation en HTML qu’il reste à afficher dans un navigateur en vue de faire une conférence.

Maintenant imaginez que vous n’avez pas le nom du fichier source ni le nom de sortie et que vouliez permettre à un utilisateur de choisir le format de sortie. Et bien il vous reste à créer une ligne de commande qui, au lieu de donner des instruction rigides, propose des valeurs (avec des $ qui seront utilisées (ou pas). Et vous voilà avec la ligne de commande que propose Zettlr dans les paramètres avancés.

Exporter en PDF

L’export au format PDF à partir de Zettlr suppose que vous ayez LaTeX (et XeLaTeX) installé sur votre système. Si tel est le ca,s il vous reste à vous rendre dans le menu fichier > Paramètres de PDF afin d’y renseigner divers éléments dont un modèle .tex qui pourra être utilisé. Rendez-vous sur la documentation de Pandoc pour apprendre à vous en servir.

Attention : Si vous avez une version de pandoc antérieure à 2.0 (c’est le cas pour beaucoup d’installations), Zettlr (via pandoc) retournera une erreur du type unrecognized option --pdf-engine=xelatex. L’explication se trouve ici. Il s’agit d’un changement qui a eu lieu pour pandoc 2.0 qui est passé de la commande --latex-engine=xelatex à la commande --pdf-engine=xelatex. Pour résoudre ce problème, remplacez simplement l’occurrence dans la ligne de commande pandoc que vous trouverez dans Paramètres > Paramètres avancés. Ou bien installez la dernière version de pandoc.

Attention (bis) : Dans les options du PDF, section Police sont indiquées les polices de caractères que pandoc utilisera pour la transformation en PDF via XeLaTeX. Si vous ne les avez pas sur votre système, un message d’erreur sera affiché. Indiquez à cet endroit les polices de caractères que vous souhaitez utiliser.

Les autres formats

Zettlr permet de faire des présentations en markdown puis de les exporter en utilisant reveal.js. Il vous reste donc à rédiger votre présentation et choisir parmi les modèles proposés (couleurs dominantes).

Vous pouvez aussi exporter directement en HTML : pour cela Zettlr dispose d’un modèle et exportera votre document en une page HTML contenant aussi les styles (on dit « standalone » ou option -s avec pandoc).

Quand aux autres formats, le choix reste intéressant :

Format	Destiné pour
HTML	Navigateur
.ODT	Traitement de texte type LibreOffice, MSWord, AbiWord, etc.
.DOCX	Microsoft
rST	ReStructuredText : mise en forme pour de la doc de langage type Python
RTF	Rich Text Format : format descriptif pour traitement de texte
TeX	Format pour TeX / LaTeX
TXT	Format texte (simple)
ORG	Pour Emacs Org (pour les utilisateurs d’org-mode, très puissant
Bdl / Pck	TextBundle (un conteneur markdown + description + fichiers liés) / Variante

… il manque selon moi la possibilité d’exporter en .epub, un tâche dont s’acquitte très bien pandoc et qui pourrait avoir son application pour l’écriture de livre, lorsqu’on a plusieurs chapitres dans des fichiers séparés. Peut-être que cette fonctionnalité sera ajoutée ultérieurement.

Conclusion

Zettlr est un excellent logiciel qui tire de nombreux avantages du markdown dans le flux de production de documents longs et dans la gestion de documentation personnelle. Il pêche encore par manque de pédagogie, mais il est sur la bonne voie. Par ailleurs, sur les aspects qui concernent l’exportation, ce que propose Zettlr est une interface graphique de pandoc. Les habitués de al ligne de commande, comme moi, ne seront pas franchement épatés : j’estime qu’il à ce niveau plus important d’apprendre à complètement se servir de pandoc. Et s’il lui faut une interface graphique (et je pense que ce serait plutôt bien), dans ce cas, je préférerais largement un programme uniquement dédié aux fonctions de conversion de pandoc (et pas au markdown).

Des directions devront être envisagées en fonction du public visé pour Zettlr. Par exemple, au vu de son fonctionnement global, il pourrait tout à fait être utilisé en binôme avec Git et par conséquent intégrer des options spécialisées dans le versionning. Une autre possibilité consisterait à utiliser une connexion à un dépôt Nextcloud afin de pouvoir synchroniser facilement l’écriture de documents en markdown. Bien sûr, qu’il s’agisse de Git ou de Nextcloud, il est déjà possible soit de commiter les fichiers à part, soit de travailler dans un dossier distant, mais il s’agit-là de tâches spécialisées avec lesquelles tout le monde n’est pas familier.