Je constate que la commande texdoc ouvre toujours des documents anglophones, même si les extensions sur lesquelles je m'informe sont également documentées en français. C'est par exemple le cas pour kpfonts, de Christophe Caignaert, ou pour xlop, de Jean-Côme Charpentier.
Comment faire pour que texdoc affiche ces documentations en français si elles existent ?
Si l'on connaît le nom de la version française, il faut taper texdoc <frversion>.
Sinon, taper texdoc -l <package> pour lister toutes les docs correspondant à l'extension et trouver la version française si elle existe ; puis texdoc <frversion>.
@Pathe Manuel Pégourié-Gonnard, auteur de texdoc, n'en assure plus la maintenance et, malheureusement, personne ne l'a reprise (j'ai vaguement le projet de le faire, mais pas avant plusieurs mois). Ceci étant, je me demande si le jeu en vaut la chandelle : les documentations qui n'existent pas qu'en anglais sont rares et, parmi elles, celles qui ne sont pas en anglais sont assez souvent obsolètes par rapport à leur version anglaise.
@denis Il y aura toujours des surprises qui augmentent la difficulté (ici par exemple comment peut-on savoir sans ouvrir le pdf ?). Il peut arriver aussi qu'un auteur préfère monpackage.pdf pour la version française et monpackage_en.pdf pour la version en anglais.
@touhami Oui, en effet. Pour cette classe, le problème est que la convention de nommage des documentations utilisée par texdoc n'est pas respectée (cf. ma réponse ci-dessous).
Pour connaître tous les documents que texdoc identifient comme pouvant documenter un package particulier, il suffit d'utiliser l'option -l. Exemple pour xlop:
Ensuite, il suffit de choisir le numéro du document que l'on souhaite (ici 2 pour la documentation en français).
Choisir la documentation par défaut
Pour rendre ce choix permanent, vous pouvez modifier l'un des fichiers de configuration de texdoc. Pour savoir où ils sont (ou où ils peuvent être), tapez la commande suivante :
Maintenant, la documentation par défaut de xlop fournie par texdoc sera la documentation en français. Il faut ajouter une ligne de ce type pour tous les packages proposant une documentation en français (ils ne sont pas très nombreux).
En fait, la détection de la langue est déjà implémentée par texdoc. Elle s'appuie sur :
la langue favorite, basée sur la « locale » utilisée (variables système telles que LANG et LC_ALL sur systèmes Unix) et sinon configurable dans le fichier de configuration texdoc.cnf au moyen de lang=⟨code⟩, où ⟨code⟩ est constituée de 2 lettres, par exemple fr ;
les noms des fichiers PDF de documentation qui doivent être de la forme ⟨nom du package⟩-⟨lang⟩.pdf.
Ici, ça ne marche donc pas pour xlop et kpfonts qui n'ont pas adopté la convention du point 2 (xlop-doc au lieu de xlop et kpfonts-Doc-French au lieu de kpfonts-fr) et la solution proposée par Paul permet de s'en sortir. Mais le mieux serait de suggérer aux auteurs de ces packages de corriger cela.
En revanche, ça devrait fonctionner par exemple avec le package paresse qui adopte la convention. Chez moi :
@fred02840 Sous Linux et Mac OS, dans n'importe quel émulateur de terminal. Sous Windows, dans l'Invite de commande MS-DOS (à moins qu'un meilleur émulateur de terminal ait été installé).
@fred02840 Le caractère $ (ou, dans ma réponse, le caractère %) ne doit pas être saisi. C'est juste pour montrer l'invite (ou le "prompt") de l'interpréteur de commandes.
Professeurs de mathématiques dans le secondaire, connaissez-vous le package ProfCollege de Christophe Poulain ? Il est aussi utile que bien documenté !
Si l'on connaît le nom de la version française, il faut taper
texdoc <frversion>
.Sinon, taper
texdoc -l <package>
pour lister toutes les docs correspondant à l'extension et trouver la version française si elle existe ; puistexdoc <frversion>
.Fort bien. Est-il possible d'éditer des préférences de texdoc pour que cette préférence francophone soit prise en compte automatiquement ?
@Pathe Je ne crois pas que
texdoc
sache quelles sont les langues des documentations que renvoietexdoc -l ⟨package⟩
.Ce serait utile. À qui et où puis-je suggérer cette amélioration ?
@Pathe Manuel Pégourié-Gonnard, auteur de
texdoc
, n'en assure plus la maintenance et, malheureusement, personne ne l'a reprise (j'ai vaguement le projet de le faire, mais pas avant plusieurs mois). Ceci étant, je me demande si le jeu en vaut la chandelle : les documentations qui n'existent pas qu'en anglais sont rares et, parmi elles, celles qui ne sont pas en anglais sont assez souvent obsolètes par rapport à leur version anglaise.@denis koma-script:
scrguide
est la version allemande (non anglaise) etscrguien
est la version anglaise!!!@touhami Je ne vois pas ce que tu veux dire par ce commentaire.
@denis Il y aura toujours des surprises qui augmentent la difficulté (ici par exemple comment peut-on savoir sans ouvrir le pdf ?). Il peut arriver aussi qu'un auteur préfère
monpackage.pdf
pour la version française etmonpackage_en.pdf
pour la version en anglais.@touhami Oui, en effet. Pour cette classe, le problème est que la convention de nommage des documentations utilisée par
texdoc
n'est pas respectée (cf. ma réponse ci-dessous).