Écrire des articles scientifiques avec PaperShell

Une recette simple pour écrire des articles scientifiques avec LaTeX.

Ingrédients

Avant de commencer, assurez-vous d'avoir un environnement de travail qui contient tous les bons outils.

Distribution LaTeX

Sous Ubuntu, on installe TeX-Live à travers la commande install-tl-ubuntu (on peut utiliser apt-get, mais on obtient une version un peu plus vieille de TeX-Live).

Sous Windows, on installe MiKTeX et on s'assure que le répertoire bin de MiKTeX est dans le PATH du système (pour pouvoir l'appeler depuis la ligne de commande).

C'est le logiciel minimal qu'il vous faut pour travailler.

Aspell

Aspell est un correcteur orthographique. Son principal avantage est qu'il peut ignorer toutes les commandes LaTeX dans un fichier et ne corriger que le texte qui se trouve autour.

Sous Ubuntu, on l'installe facilement via la commande

  sudo apt-get install aspell aspell-en aspell-fr

Les deux derniers packages (aspell-en et aspell-fr) installent des dictionnaires pour Aspell (le premier pour l'anglais, le second pour le français).

Dans Windows, on télécharge la version Win32 d'Aspell, ainsi que les dictionnaires précompilés dont vous avez besoin (typiquement: anglais et français, ils sont dans la même page). Comme pour MiKTeX, on s'assure que le répertoire bin qui contient aspell.exe est dans le PATH du système.

LanguageTools

Un autre outil gratuit, cette fois qui vérifie la grammaire, donc la conjugaison, l'accord des verbes, etc. On télécharge la version "stand-alone for your Desktop", dont on décompresse l'archive quelque part. Dans la suite, on notera %LTDIR% le répertoire où LanguageTools a été décompressé.

OpenDetex

OpenDetex est un outil qui permet de retirer toutes les commandes d'un fichier LaTeX et n'en garder que le texte, pour ensuite l'envoyer à un autre logiciel. Comme LanguageTools, contrairement à Aspell, est incapable d'ignorer les commandes LaTeX dans un fichier, on doit d'abord passer celui-ci dans OpenDetex pour pouvoir le vérifier.

Étape 1: créer une coquille d'article

J'ai créé une coquille qui fournit un environnement complet dans lequel rédiger

Étape 2: vérifier l'orthographe

Cette étape est directement prise en charge par PaperShell, en utilisant le script aspell-check.sh (pour Linux) ou aspell-check.bat (pour Windows). Le fonctionnement d'Aspell est assez simple et ressemble à l'image ci-dessous.

Aspell screenshot

Aspell risque d'arrêter sur des mots techniques qui ne sont pas dans son dictionnaire (comme "XML", "subformula" ou "JavaScript"). Si on est certain que ces mots sont bien écrits, on peut utiliser l'option "Add" pour qu'Aspell ajoute ce mot au dictionnaire local et n'arrête plus dessus à l'avenir.

Autant que possible, passer par les scripts (i.e. ne pas appeler Aspell directement), puisqu'on y gère entre autres le dictionnaire personnalisé sauvegardé localement dans le dossier de l'article (où vont se trouver les mots ajoutés manuellement).

Étape 3: vérifier la grammaire

Pour vérifier la grammaire, on doit d'abord créer un fichier duquel toutes les commandes LaTeX du fichier paper.tex ont été retirées. C'est ici qu'on fait appel à OpenDetex:

  detex -e verbatim,equation,eqnarray,displaymath,tabular Source/paper.tex > paper-detex.txt

Le paramètre -e fait ignorer à OpenDetex certains environnements dans la source, qui en général contiennent du code et n'ont donc pas à être vérifiés.

On est maintenant prêt à utiliser LanguageTool. On le lance en double-cliquant sur languagetool.jar, ou en appelant

  java -jar %LTDIR%/languagetool.jar

On rappelle que %LTDIR% doit être remplacé par le répertoire où a été installé LanguageTool. On obtient une interface comme celle-ci:

LanguageTool screenshot

On choisit "File/Open" et sélectionne paper-detex.txt. LanguageTool va analyser le fichier et afficher la liste des erreurs trouvées. Comme la source résulte d'une conversion approximative d'un fichier LaTeX, ce ne sont pas nécessairement toutes les erreurs qui ont un sens.

Navigation