Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
1_generalites:documentations_libres:comment_faire_un_exemple_complet_minimal [2018/06/03 15:18]
samcarter
1_generalites:documentations_libres:comment_faire_un_exemple_complet_minimal [2020/12/03 14:13] (Version actuelle)
yannick.tanguy Renommage des sections de base: correction des liens internes.
Ligne 1: Ligne 1:
---- +====== Comment faire un « exemple minimal » ? ======
-title: How to make a "​minimum example"​ +
-category: documentation +
-permalink: /​FAQ-minxampl +
-date: 2014-06-10 +
----+
  
-[Our advice on asking questions](FAQ-askquestion) +L'​article « [[1_generalites:​documentations_libres:​comment_poser_une_question|Comment poser une question ​?]] » suggère de préparer un « exemple minimal » illustrant la problématique que vous rencontrezToutefois, si vous rencontrez un problème dans un document ​de deux cents pagescette suggestion n'est sans doute pas très explicite sur la manière de procéder. Voici donc quelques méthodes et recommandations sur ce sujet.
-suggests that you prepare a "​minimum example"​ (also commonly known +
-as a "​_minimal_ example"​) of failing behaviour,​ +
-as a sample to post with your question. ​ If you have a problem in a +
-two hundred page document, ​it may be unclear how to proceed from this +
-problem to a succinct demonstration of your problem.+
  
-There are two valid approaches to this taskbuilding upand hacking +Pour être efficace, votre exemple doit être un //exemple complet minimal// (ECM) : 
-down.+  * //complet// : l'​exemple doit être compilable sans ajouter une seule ligne. En particuliersi vous utilisez <​latex>​\LaTeX</​latex>,​ il doit commencer par ''​\documentclass'',​ contenir ​ ''​\begin{document}''​ et ''​\end{document}''​. Evitez d'​utiliser des extensions non-standard ou fournissez un lien vers celles-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. Il est indispensable de supprimer de votre préambule tous les appels de packages et définitions de commandes inutiles à la reproduction du problème
  
-_Building up_ starts +===== Les deux méthodes pour produire un exemple minimal =====
-with a basic document structure +
-(for LaTeX, this would have `\documentclass`,​ +
-`\begin{document}`,​ `\end{document}`) and adds +
-things. ​ First to add is a paragraph or so around the actual point +
-where the problem occurs. ​ (It may prove difficult to find the actual +
-line that's provoking the problem. ​ If the original problem is an +
-error, reviewing  +
-["the structure of TeX errors"​](FAQ-errstruct) +
-may help.)+
  
-Note that there are things that can go wrong in one part of the +==== La méthode additive ====
-document as a result of something in another part: the commonest is +
-problems in the table of contents (from something in a section title, +
-or whatever), or the list of &​lsaquo;​_something_&​rsaquo;​ (from something in a +
-`\caption`). ​ In such a case, include the section title or caption +
-(the caption probably needs the `figure` or +
-`table` environment around it, but it _doesn'​t_ need +
-the figure or table itself).+
  
-If this file you've built up shows the problem alreadythen you're done. +La //méthode additive// commence par une structure de document de base : par exemple, pour <​latex>​\LaTeX</​latex>,​ il y aura les commandes ''​\documentclass'​', ''​\begin{document}''​, ''​\end{document}''​)À cette structure de base s'​ajoutent ensuite progressivement d'​autres éléments
-Otherwisetry adding packages; the optimum is a file with only one +
-package in it, but you may find that the guilty package won't even load +
-properly unless another package has been loaded ​(Another common case +
-is that package `A` only fails when package `B` has been +
-loaded.)+
  
-_Hacking down_ starts +Le premier élément à ajouter est le paragraphe encadrant le point où le problème se produit. Il peut cependant s'​avérer difficile de trouver la ligne qui provoque le problème. Si le problème d'​origine est une erreur ​(La)TeXla question « [[1_generalites:​erreurs:​structure_d_un_message_d_erreur|Quelle est la structure des erreurs TeX ?]] » peut vous aider.
-with your entire document, and +
-removes bits until the file no longer fails (and then of course +
-restores the last thing removed).  Don't forget to hack out any +
-unnecessary packages, but mostly, the difficulty is choosing what to +
-hack out of the body of the document; this is the mirror of the +
-problem abovein the "​building up" route.+
  
-If you've added package ​(or more than one)add `\listfiles` to +Notez qu'il y des choses qui peuvent mal tourner dans une partie du document en conséquence d'une erreur dans une autre partie : un cas courant est celui des problèmes dans la table des matières ​(du fait d'une bizarrerie dans un titre de sectionou autre) ou des problèmes dans une liste de tables ou une liste des figures (à partir d'una anomalie dans une commande ''​\caption''​). Dans ce casincluez le titre de la section ou de la légende (la légende ​probablement besoin de l'environnement ''​figure''​ ou ''​table''​ autour d'​elle,​ mais //n'a pas besoin// de la figure ou de la table elle-même).
-the preamble too: that wayLaTeX will produce ​list of the +
-packages you've used and their version numbers. ​ This information may +
-be useful evidence for people trying to help you.+
  
-The process of "​building up"and to some extent that of +Si le fichier que vous avez ainsi créé fait surgir le problèmevous avez terminé. Sinonessayez d'​ajouter progressivement des extensions utilisées dans votre document original ​le mieux est d'​avoir un fichier avec une seule extension mais vous pourrez peut-être constater que l'​extension responsable de vos malheurs ne se chargera pas correctement à moins qu'une autre extension n'ait été chargée. Il est aussi possible que l'​extension ''​A''​ échoue uniquement lorsque l'​extension ''​B''​ a été chargée, ce qui arrive fréquemment.
-"​hacking down"can be helped by stuff available on CTAN: +
-  ​+
  
--  the [`minimal`](https://​ctan.org/​pkg/​minimal) class (part of the LaTeX distribution) +==== La méthode soustractive ====
-    does what its name says: it provides nothing more than what is +
-    needed to get LaTeX code going, and +
--  the [`mwe`](https://​ctan.org/​pkg/​mwe) bundle provides a number of images in formats +
-    that (La)TeX documents can use, and a small package [`mwe`](https://​ctan.org/​pkg/​mwe) +
-    which loads other useful packages (such as [`blindtext`](https://​ctan.org/​pkg/​blindtext) and +
-    [`lipsum`](https://​ctan.org/​pkg/​lipsum),​ both capable of producing dummy text in a +
-    document).+
  
-What if none of of these cut-down derivatives of your document ​will +La //méthode soustractive//​ commence avec votre document ​en entier puis en supprime des éléments jusqu'à ce que le fichier ne génère plus l'​erreur. Est alors réintégré le dernier élément supprimé. La seule réelle difficulté est ici de déterminer quelle partie supprimer à chaque étape. N'​oubliez pas d'ailleurs de supprimer toutes les extensions inutiles
-show your error? ​ Whatever you do, don't post the whole of the document: if +
-you can, it may be useful to make a copy available on the web +
-somewhere: people will probably understand if it's impossible&​nbsp;&​hellip;​  +
-or inadvisable,​ in the case of something confidential.+
  
-If the whole document is indeed necessary, it could be that your +===== Quelques commandes et extensions qui peuvent aider =====
-error is an overflow of some sort; the best you can do is to post the +
-code "​around"​ the error, and (of course) the full text of the error.+
  
-It may seem that all this work is rather excessive for preparing a +Si vous avez ajouté plus d'une extension, placez la commande ''​\listfiles''​ dans le préambule de votre documentAinsi, <​latex>​\LaTeX</​latex>​ produira une liste des extensions que vous avez utilisées avec leur numéro de versionce qui peut être très utile pour donner des pistes pour vous aider.
-simple post There are two responses to thatboth based on the +
-relative inefficiency of asking a question on the internet.+
  
-Firstpreparing a minimum document very often leads _you_ to the +La méthode additive etdans une certaine mesure, la méthode soustractive peuvent bénéficier : 
-answerwithout all the fuss of posting and looking for responses.+  * de la classe [[ctanpkg>​minimal|minimal]] (qui appartient à la distribution <​latex>​\LaTeX</​latex>​) qui fournit ce qu'​elle indique : rien de moins que ce qui est nécessaire à <​latex>​\LaTeX</​latex>​ pour fonctionner ; 
 +  * de la liasse [[ctanpkg>​mwe|mwe]] (MWE pour //minimal working example// ou « exemple minimal fonctionnel ») qui fournit des images dans des formats utilisables dans des documents <​latex>​\LaTeX</​latex>​ ainsi qu'une extension [[ctanpkg>​mwe|mwe]] qui charge d'​autres extensions telles que [[ctanpkg>​blindtext|blindtext]] et [[ctanpkg>​lipsum|lipsum]]toutes deux capables de produire du [[https://​fr.wikipedia.org/​wiki/​Lorem_ipsum|faux-texte]].
  
-Second, your prime aim is to get an answer as quickly as possible; a +===== Quelques conseils complémentaires =====
-well-prepared example stands a good chance of attracting an answer +
-"in a single pass": if the person replying to your post finds she +
-needs more information,​ you have to find that request, post again, and +
-wait for your benefactor to produce a second response.+
  
-All things considereda good example file can save you a dayfor +Si aucune de ces méthodes ne vous réussitvous pourriez vous dire qu'il faut poster l'​intégralité de votre document. Ne le faites pas : 
-perhaps half an hour's effort invested.+  * préférez la mise à disposition d'une copie sur un site sur le web. Cela reste évidemment déconseillésurtout si le contenu de votre document est confidentiel ; 
 +  * si l'​ensemble du document est nécessaire,​ cela peut être le signe que votre document produit en fait un débordement des capacités de <​latex>​\LaTeX</​latex>;​ le mieux est alors de publier le code « autour » de l'​erreur et le texte intégral de l'erreur.
  
-Much of the above advice, differently phrased, may also be read on the +Toutes ces méthodes semblent demander beaucoup de travail pour préparer une simple question. Mais il s'agit ici d'​être efficace : 
-web at [http://www.minimalbeispiel.de/​mini-en.html](http:​//www.minimalbeispiel.de/​mini-en.html)+  * préparer un exemple minimal vous mène souvent à trouver la solution ​//par vous-même// et vous évite toute la démarche ​de poster votre question et d'​analyser les réponses ​
-source of +  * vous souhaitez en général une réponse rapide ​un exemple soigneusement écrit a bien plus de chances d'​obtenir une réponse directe et pertinenteUn exemple moins bien rédigé risque d'​amener à des questions complémentaires ​de la part de vos lecteurs... ce qui va allonger d'​autant votre temps pour obtenir votre réponse
-that article may be found at +
-[http://​www.minimalbeispiel.de/​](http://​www.minimalbeispiel.de/), in +
-both German and English.+
  
 +En résumé, un bon exemple peut vous économiser une journée de votre temps, souvent pour un peu moins d'une demi-heure de votre temps pour constituer l'​exemple minimal.
  
 +La plus grande partie de ce qui a été indiqué ici peut se retrouver de façon plus approfondie dans un document disponible en [[https://​www.minimalbeispiel.de/​|allemand]] comme en [[https://​www.minimalbeispiel.de/​mini-en.pdf|anglais]].
 +
 +-----
 +
 +//Source:// [[faquk>​FAQ-minxampl|How to make a "​minimum example"​]]
 +
 +{{htmlmetatags>​metatag-keywords=(LaTeX,​documentation)
 +metatag-og:​title=(Comment faire un « exemple minimal »)
 +metatag-og:​site_name=(FAQ LaTeX francophone)
 +}}
1_generalites/documentations_libres/comment_faire_un_exemple_complet_minimal.1528031901.txt.gz · Dernière modification: 2018/06/03 15:18 (modification externe)
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0