[Conseils d'utilisation] fr.comp.text.tex
Manuel Pégourie-Gonnard
Derniￜre modification: le 02/08/09 par Manuel Pￜgouriￜ-Gonnard.
Conseils d'utilisation de fr.comp.text.tex
(ￜ lire avant d'ￜcrire)
Ce groupe est dￜdiￜ aux discussions en franￜais sur TeX, LaTeX, et les
outils ou formats associￜs : ConTeXt, Metafont, etc. Il n'est pas modￜrￜ.
Ces conseils d'utilisation prï¿œsentent aux nouveaux venus les usages
du groupe afin qu'ils puissent en tirer le meilleur profit.
Ils ont ￜtￜ rￜdigￜs et sont maintenus par Manuel Pￜgouriￜ-Gonnard
(m...@elzevir.fr). Derniￜre mise ￜ jour le 2 aoￜt 2009.
% Table des matiï¿œres
% ------------------
1. Conseils gï¿œnï¿œraux
2. Les FAQ ￜ et documentations existantes
3. La notion d'exemple complet minimal (ECM)
4. Renseignements complï¿œmentaires
% 1 Conseils gï¿œnï¿œraux
%--------------------
Les rï¿œgles d'utilisation des groupes de nouvelles en gï¿œnï¿œral, et de la
hiï¿œrarchie fr.* en particulier (pas de piï¿œces jointes, texte brut, de
prￜfￜrence encodￜ en latin1 voire en utf8), s'appliquent ici. Si vous
n'ï¿œtes pas familier avec ces derniï¿œres, vous pouvez consulter :
news://fr.bienvenue
http://www.usenet-fr.net/fr-chartes/index.html
ￜvitez en particulier de rￜpondre avant la citation. ￜ lire ￜ ce sujet :
http://www.usenet-fr.net/fur/usenet/repondre-sur-usenet.html
% 2 Les FAQ ￜ et documentations existantes
% ----------------------------------------
Une bonne habitude est de lire les FAQ ￜ, avant de poser une question
peut-ￜtre dￜjￜ rￜsolue. Pour fr.comp.text.tex vous les trouverez ￜ :
http://www.grappa.univ-lille3.fr/FAQ-LaTeX/
Plus ancienne mais facilement exploitable dans
sa version html avec un moteur de recherche.
http://faqfctt.fr.eu.org/
Plus rï¿œcente mais uniquement au format pdf.
Pensez aussi ￜ faire une recherche dans les archives du groupe :
http://groups.google.fr/group/fr.comp.text.tex/
Pour ceux pratiquant d'autres langues :
- anglaise : http://www.tex.ac.uk/cgi-bin/texfaq2html?introduction=yes
- allemande : http://www.dante.de/faq/de-tex-faq/html/de-tex-faq.html
Les documentations sur le CTAN ￜ. Une partie de la documentation gￜnￜrale est
listï¿œe dans la section correspondante du catalogue TeX en ligne :
http://www.ctan.org/tex-archive/help/Catalogue/bytopic.html#refmans
Un document particulier, le l2tabu, liste de pratiques ￜ ￜviter :
http://ctan.org/tex-archive/info/l2tabu/french/
La documentation des modules (packages) utilisï¿œs. Souvent accessible sur
votre disque dur en tapant ￜ texdoc <nom du module> ￜ dans un terminal
(*nix) ou en ligne de commande (windows). Les utilisateurs de MikTeX
peuvent aussi essayer ￜ mthelp <nom> ￜ. Et toujours sur le CTAN ￜ :
http://ctan.org/search.html#documentation
% 3 La notion d'exemple complet minimal (ECM)
% -------------------------------------------
Quand vous rencontrez un problï¿œme, et que votre code ne produit pas le
rï¿œsultat que vous attendez, il est indispensable d'accompagner la
description du problï¿œme d'un exemple de code qui permette de le reproduire.
Cet exemple doit ï¿œtre si possible complet et minimal, c'est ce qu'on appelle
un ECM.
Complet : l'exemple doit ï¿œtre compilable sans ajouter une seule ligne.
En particulier, si vous utilisez LaTeX, il doit commencer par
\documentclass{...}, appeler au moins les modules de base (inputenc,
fontenc, babel), contenir le \begin{document} et le \end{document}.
N'utilisez pas de modules non-standard ou fournissez un lien vers ceux-ci.
Minimal : l'exemple ne doit pas contenir une ligne de code superflue.
Ceci implique qu'il ne s'agit pas de votre document complet de 300 pages. Il
est indispensable de supprimer de votre prï¿œambule tous les appels de
modules et dￜfinitions de commandes inutiles ￜ la reproduction du problￜme.
La production d'un ECM est un exercice difficile mais instructif et souvent
suffisant pour rￜsoudre le problￜme. N'hￜsitez pas ￜ commenter/dￜcommenter
des portions de code pour trouver le rï¿œsultat complet minimal. Et n'oubliez
pas : ￜ Aide-toi, fr.comp.text.tex t'aidera. ￜ :-)
% 4 Renseignements complï¿œmentaires
% --------------------------------
Pensez ￜ donner tous les renseignements complￜmentaires utiles pour
reproduire le problï¿œme, comme les ï¿œventuels formats intermï¿œdiaires
utilisï¿œs, ainsi que les outils de conversion. Exemple :
- compilation directe en pdf
- compilation en dvi puis conversion en pdf par dvipdfm
- dvi, puis ps puis pdf par dvips et pstopdf
Prï¿œcisez au besoin la version des modules employï¿œs. Elle s'obtient dans le
fichier log, en plaï¿œant la commande \listfiles au tout dï¿œbut du source.
Quelquefois il peut ï¿œtre utile de joindre une partie du fichier log. Si
l'extrait utile est relativement long, incluez-le ￜ la fin de votre message
plutￜt qu'au milieu de celui-ci par souci de lisibilitￜ.
Dans de rares cas, il faudra montrer le rï¿œsultat d'une compilation sous
forme de dvi, ps, pdf, ou image. Les piï¿œces jointes n'ï¿œtant pas supportï¿œes
dans les forums fr.*, pensez ￜ mettre votre exemple en ligne (par
exemple sur cijoint.fr) et ￜ donner un lien. Ceci est ￜgalement valable
pour les extraits de code longs, les modules personnels par exemple.
-------
1. FAQ : Frequently Asked Questions (recueil de questions souvent posï¿œes).
2. CTAN : Comprehensive TeX Archive Network (ressource ￜ universelle ￜ pour
tout ce qui concerne TeX et ses amis comme LaTeX ou Metafont).
Nous espￜrons que ce document vous a ￜtￜ utile et vous permettra
d'ï¿œchanger de faï¿œon agrï¿œable et enrichissante avec les autres
contributeurs de fr.comp.text.tex :-)
--
Document publiￜ par MaintDoc depuis le 2008-04-07.
Reponsables : Manuel Pￜgouriￜ-Gonnard.