| Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente |
| 1_generalites:documentation:documents:documents_extensions:documentation_des_packages [2021/03/14 15:53] – Mise à jour de la page suite au déplacement des pages et ajout de french-translations. yannick.tanguy | 1_generalites:documentation:documents:documents_extensions:documentation_des_packages [2021/03/14 16:03] (Version actuelle) – Ajout d'un lien. yannick.tanguy |
|---|
| ====== Où trouver la documentation des extensions ? ====== | ====== Où trouver la documentation des extensions? ====== |
| |
| Cette FAQ vous suggère régulièrement des extensions qui pourront résoudre des problèmes particuliers. Dans certains cas, la réponse fournit toute la méthode pour y arriver. Dans d'autres (souvent ceux où la solution s'avère très spécifique), comment pouvez-vous vous y prendre ? Le recours à la documentation sera nécessaire et voici les différentes méthodes de la plus générale à la moins conseillée pour trouver cette documentation. | Cette FAQ vous suggère régulièrement des extensions qui pourront résoudre des problèmes particuliers. Dans certains cas, la réponse fournit toute la méthode pour y arriver. Dans d'autres (souvent ceux où la solution s'avère très spécifique), comment pouvez-vous vous y prendre ? Le recours à la documentation sera nécessaire et voici les différentes méthodes de la plus générale à la moins conseillée pour trouver cette documentation. |
| | |
| | Avant de commencer, il faut noter que les distributions elles-même sont aussi accompagnées de leur propre documentation, décrivant l'organisation des fichiers, les outils de bases, variables d'environnement, etc. Cette documentation se trouve sous plusieurs formes et/ou langues, dans des chemins qui devraient ressembler aux suivants : |
| | |
| | <code> |
| | Program Files/MiKTeX 2.5/doc/miktex/manual/index.html |
| | Program Files/MiKTeX 2.5/doc/miktex/miktex.pdf |
| | /usr/share/doc/texlive-doc/french/texlive-fr/live.html |
| | /usr/share/doc/texlive-doc/english/texlive-en/live.pdf |
| | </code> |
| | |
| |
| ===== Avec texdoc ou mthelp ===== | ===== Avec texdoc ou mthelp ===== |
| |
| La forme la plus courante de documentation des extensions <latex>\LaTeX</latex> se trouve dans le fichier ''dtx'' avec lequel le code est distribué (voir la question « [[1_generalites:documentation:documents:documents_extensions:fichiers_sources_dtx|Que sont les fichiers de source documentée (ou fichiers « dtx ») ?]] »). De tels fichiers sont censés être traités par <latex>\LaTeX</latex> lui-même mais il peut y avoir des problèmes occasionnels pour obtenir une documentation lisible. Les problèmes courants sont que l'extension elle-même est nécessaire pour traiter sa propre documentation (elle doit donc être décompressée avant le traitement) ou que le fichier ''dtx'' ne sera pas traité avec <latex>\LaTeX</latex>. Dans ce dernier cas, le fichier ''ins'' produira généralement un fichier ''drv'' (ou de nom similaire), que vous traitez à la place avec <latex>\LaTeX</latex> (il arrive que l'auteur de l'extension pense à préciser cela dans un fichier ''README''.) | La forme la plus courante de documentation des extensions <latex>\LaTeX</latex> se trouve dans le fichier ''dtx'' avec lequel le code est distribué (voir la question « [[1_generalites:documentation:documents:documents_extensions:fichiers_sources_dtx|Que sont les fichiers de source documentée (ou fichiers « dtx ») ?]] »). De tels fichiers sont censés être traités par <latex>\LaTeX</latex> lui-même mais il peut y avoir des problèmes occasionnels pour obtenir une documentation lisible. Les problèmes courants sont que l'extension elle-même est nécessaire pour traiter sa propre documentation (elle doit donc être décompressée avant le traitement) ou que le fichier ''dtx'' ne sera pas traité avec <latex>\LaTeX</latex>. Dans ce dernier cas, le fichier ''ins'' produira généralement un fichier ''drv'' (ou de nom similaire), que vous traitez à la place avec <latex>\LaTeX</latex> (il arrive que l'auteur de l'extension pense à préciser cela dans un fichier ''README''.) |
| | |
| | Pour plus d'information sur ce point, lisez la question : « [[1_generalites:documentation:documents:documents_extensions:documentation_des_packages3|Comment générer la documentation d'une extension ?]] ». |
| | |
| |
| ===== Avec la documentation séparée ===== | ===== Avec la documentation séparée ===== |
| ----- | ----- |
| |
| //Source:// [[faquk>FAQ-pkgdoc|Documentation of packages]] | //Sources :// |
| | * [[faquk>FAQ-pkgdoc|Documentation of packages]] |
| | * https://web.archive.org/web/20170314080827/https://elzevir.fr/imj/latex/tips.html#texdoc |
| | . |
| {{htmlmetatags>metatag-keywords=(LaTeX,documentation) | {{htmlmetatags>metatag-keywords=(LaTeX,documentation) |
| metatag-og:title=(Où trouver la documentation des extensions) | metatag-og:title=(Où trouver la documentation des extensions) |
| metatag-og:site_name=(FAQ LaTeX francophone) | metatag-og:site_name=(FAQ LaTeX francophone) |
| }} | }} |
| | |
