ECM

Exemple Complet Minimal

Lorsque l’on cherche de l’aide sur un forum ou une liste de discussion, on peut, en retour, recevoir une demande d’« ECM »... ECM, qu’es aquò ? Allons chercher la réponse chez les bons auteurs.

Extrait des conseils d’utilisation de fctt

Dernière modification : le 12/03/10 par Manuel Pégourié-Gonnard

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 donc ce qu’on appelle un ECM (Exemple Complet Minimal).

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-standards 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.

La FAQ LaTeX explique deux démarches structurées pour produire un ECM.

Extension utile

L’extension mwe (Minimal Working Example), disponible dans TeXlive et MikTeX, donne accès à des outils permettant de créer des ECM compilables par toutes et tous. Par exemple, cette extension fournit différentes images utilisables dans votre exemple de code.