Le mpg-blog

LaTeX et autres geekeries

Trouver les documentations (La)TeX

with one comment

Une des grandes forces de LaTeX est son système de modules (packages) et le nombre colossal de modules disponibles. Dans un sens, c’est aussi une de ses faiblesses, car il est parfois difficile pour l’utilisateur de trouver ses repères dans cet écosystème complexe. Heureusement, l’immense majorité des modules LaTeX (et plus généralement, des outils reliés) sont fournis avec une documentation spécifique et détaillées. Il est très utile de savoir trouver cette documentation et y accéder rapidement.Avant d’aller plus loin, notons que pour rechercher des informations sur LaTeX, google (ou tout autre moteur de recherche) n’est pas forcément votre ami. Certes, le web regorge de fils de discussion sur LaTeX, de FAQ, de pages de trucs et astuces, mais la qualité de ces ressources est très variable, en particulier parce qu’elles datent parfois du siècle dernier.

La documentation spécifique d’un module, en revanche, est écrite et mise à jour par l’auteur du module lui-même. Sans me lancer dans une grande tirade concernant la qualité de l’information sur le web, j’aimerais souligner qu’il me paraît utile (et pas seulement dans le monde de LaTeX) de savoir identifier la source d’information faisant autorité et de prendre l’habitude de s’y référer ; les autres sources d’information ont bien sûr leur intérêt mais constituent à mon avis un complément plutôt qu’un substitut à la documentation originale.

En ligne

Tous les modules présents dans les distributions modernes (TeX Live et MikTeX) proviennent du CTAN, le Comprehensive TeX archive network, qui accueille, outre les modules, leur documentation au format PDF (et leur source).

Pour y accéder, le moyen le plus commode est sans doute d’utiliser l’URL « magique » http://ctan.org/pkg/nom-du-module. Par exemple, si l’on cherche des renseignements sur biblatex, on peut visiter http://ctan.org/pkg/biblatex. En dessous de la description, on trouvera un champ « Documentation on CTAN » avec des liens vers les principaux documents décrivant le module.

Si l’on ne connaît pas précisément le nom du paquet sur le CTAN (qui n’est pas forcément le même que le nom du module LaTeX), on peut essayer la page de recherche du CTAN.

En local

L’inconvénient d’accéder à la documentation sur le web, c’est qu’on a pas toujours accès au réseau au moment où l’on travaille (par exemple dans le train). Heureusement, les distributions TeX en installent une copie sur votre disque dur. Même quand vous avez accès au réseau, cette version est souvent plus rapide à consulter. Des outils sont disponibles pour vous aider à localiser le document cherché.

Sous MikTeX, l’outil privilégié s’appelle mthelp. Il s’utilise en ligne de commande (faire Window-R puis taper cmd pour obtenir une invite de commande sous Windows), en tapant mthelp nom-du-module. Selon les cas, il ouvre directement la documentation dans votre lecteur PDF, ou bien crée une liste de liens vers les documents potentiellement intéressants, et charge ces liens dans votre navigateur.

Sous TeX Live, on utilise texdoc, également en ligne de commande. L’utilisation de base est la même : texdoc nom-du-module. Par contre, ceci ouvre toujours le document correspondant ; on peut aussi obtenir une liste de résultats en tapant texdoc -l nom-du_module à la place, et ensuite choisir le document à ouvrir depuis la liste. Sous MacTeX, TeX Live utility propose (entre autres) une interface graphique pour utiliser texdoc.

TeX Live inclus aussi un outil graphique de recherche de documentation, texdoctk. Celui-ci propose une navigation par catégorie, et un mode de recherche. Attention, le recherche ne s’effectue pas dans l’ensemble de la documentation, uniquement dans le catalogue de texdoctk (mise à jour : il y a désormais deux modes de recherche). Notons que texdoctk n’est pas maintenu (je m’assure régulièrement que la base de données ne recense que des fichiers qui existent, mais c’est tout). Par ailleurs, malgré la similarité des noms, texdoc et texdoctk n’ont en fait aucun rapport.

Depuis 2008, j’ai repris le développement de texdoc. Cet article est le premier d’une série dans laquelle je présenterai ses principales fonctionnalités, quelques réflexions sur son évolution, et des plans pour la suite du développement.

Written by mpg

mars 11th, 2010 at 1:49

Posted in TeX et compagnie

Tagged with

One Response to 'Trouver les documentations (La)TeX'

  1. [...] je le mentionnais dans un billet précédent, TeX Live propose deux utilitaires pour accéder à la documentation : texdoc, en ligne de [...]