13/06/2014 jusqu'au 15/07/2031
Expert éminent sénior
À lire avant de poster : qu'est-ce qu'un ECM ?
Un ECM est un Exemple Complet Minimal.
Cela signifie qu'il reproduit, avec le minimum nécessaire à la compréhension, le problème que vous rencontrez.
- Exemple :
- Bien souvent quelques lignes d'un texte d'exemple suffisent. Inutile donc de poster l'intégralité de votre document de 200 pages.
- Il doit bien sûr reproduire le problème et/ou l'état de vos tentatives de programmation (dans le cas de nouvelles commandes, par exemple).
- Complet :
- L'exemple doit être compilable sans aucune modification de la part des contributeurs.
- Il doit comporter un préambule (ce qui est compris entre \documentclass et \begin{document}).
- Si vous utilisez des extensions ou classes de document personnelles, il est impératif de les mettre en pièces jointes de votre message.
- Si votre problème est lié à des images, il est impératif de les mettre en pièces jointes de votre message. Les contributeurs n'ont pas obligatoirement une image sous la main.
- Si le problème concerne des commandes d'inclusion de fichier .tex (\include, \input...), fournissez également un exemple de fichier inclus.
- Minimal :
- Le minimalisme d'un ECM est très important car il facilite énormément la localisation du problème et permet d'identifier rapidement les soucis dus à des interactions.
- Toutes les extensions qui ne sont pas nécessaires à la reproduction de votre problème doivent être enlevées de l'ECM.
- Dans le cas où le problème nécessiterait une grande quantité de texte (plus d'une page), utilisez l'extension lipsum et sa commande éponyme cela rendra le code plus lisible.
- Dans le cas où le problème nécessiterait l'intégration d'une image, utilisez l'extension mwe qui permet de visualiser de "fausses" images.
Voici un exemple d'ECM :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
| \documentclass[11pt,a4paper]{article}
\usepackage[T1]{fontenc} % Encodage des fontes
\usepackage[latin1]{inputenc} % Encodage du(des) fichier(s)
\usepackage[frenchb]{babel} % Gestion des standards multilingues.
% \usepackage{lipsum} % Du texte pour les exemples
%% Les packages vraiment nécessaires.
%% Les (re-)définitions de commandes/longueurs/compteurs directement incriminés.
\begin{document}
%% Quelques lignes qui mettent en lumière le problème.
% \lipsum
\end{document} |
Faites cet exercice avant de poster, cela vous permettra ainsi qu'aux contributeurs d'isoler efficacement la source du problème que vous rencontrez.
Peut-être même que cela vous permettra de le résoudre par vous-même.
Et rappelez-vous que bien souvent, un problème bien posé et expliqué est déjà à moitié résolu.