[Conseils d'utilisation] fr.comp.text.tex

[Manuel Pégourie-Gonnard]

Archive-Name: fr/chartes/comp.text.tex
Dernière modification: le 12/03/10 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 12 mars 2010.


% 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
- 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. Exemples :
- 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.
Responsable(s) : Manuel Pégourié-Gonnard.