Qu'est-ce que le format de fichier DTX ?
Un fichier .dtx est un fichier Source LaTeX Documenté - le format standard pour distribuer des paquets LaTeX sur CTAN (le Comprehensive TeX Archive Network). Le format implémente une approche de programmation lettrée : un seul fichier .dtx entrelace le code source exécutable du paquet avec sa documentation complète mise en forme dans un fichier texte brut autonome.
Le mécanisme repose sur DocStrip, un utilitaire inclus dans chaque distribution TeX. Des commentaires de garde sous la forme % <guard> marquent les lignes qui appartiennent à l'implémentation et celles qui sont de la pure documentation. L'exécution de latex package.ins (en utilisant le fichier d'installation compagnon .ins) supprime les marqueurs de documentation et extrait les fichiers de paquet .sty ou .cls utilisables. L'exécution de pdflatex package.dtx permet au contraire de composer le manuel complet - avec le code source annoté et coloré syntaxiquement.
Presque tous les paquets CTAN sont livrés sous la forme d'une paire .dtx + .ins. Le fichier .ins est un court script DocStrip qui indique à l'extracteur quels fichiers de sortie produire et où les placer.
Les fichiers .dtx sont en texte brut UTF-8 (ou ASCII) et s'ouvrent dans n'importe quel éditeur de texte, bien que les éditeurs spécialisés TeX tels que TeXstudio ou Texmaker offrent la coloration syntaxique. La classe de document ltxdoc, qui fait partie du noyau LaTeX, est utilisée pour composer la documentation .dtx et fournit des environnements pour annoter les définitions de macros aux côtés de leur code source.
Sécurité et sûreté
RISQUE : LOWLes fichiers DTX sont des fichiers sources en texte brut ; ils ne présentent aucun risque d'exécution directe lorsqu'ils sont ouverts dans un éditeur de texte. La compilation d'un .dtx non fiable avec LaTeX comporte le même risque que l'exécution de n'importe quel document LaTeX : un code TeX malveillant pourrait exécuter des commandes système si --shell-escape est activé. Ne compilez pas de fichiers .dtx provenant de sources non fiables avec shell-escape activé.
Détails du format
en brefProgrammes qui ouvrent les fichiers DTX
latex package.ins via le menu Outils pour extraire les fichiers .sty. latex package.ins dans le terminal pour extraire .sty/.cls ; exécutez pdflatex package.dtx pour générer la documentation PDF. latex package.ins via le menu Outils pour extraire les fichiers .sty. latex package.ins via le menu Outils pour extraire les fichiers .sty. Détails techniques
spécifications approfondies| Encodage | Texte brut - ASCII ou UTF-8 |
| Mécanisme | Système de programmation lettrée DocStrip (Frank Mittelbach, 1989) |
| Syntaxe de garde | Les commentaires % <guard> contrôlent quelles lignes sont extraites comme code ou composées comme documentation |
| Fichier compagnon | Le script d'installation .ins pilote le processus d'extraction DocStrip |
| Commande d'extraction | latex package.ins - produit les fichiers de sortie .sty ou .cls |
| Commande de documentation | pdflatex package.dtx - compose le manuel de la source annotée |
| Classe de documentation | ltxdoc (fait partie du noyau LaTeX) ; fournit les environnements \DescribeMacro et \DescribeEnv |
| Taille de fichier typique | 5 Ko - 500 Ko (les gros paquets avec une documentation complète peuvent atteindre plusieurs Mo) |
| Plateforme de distribution | CTAN (Comprehensive TeX Archive Network) - pratiquement tous les paquets CTAN utilisent le .dtx |
| Systèmes d'exploitation | Windows, Linux, macOS |
| Fichiers de sortie | .sty (paquet) ou .cls (classe de document) extraits par DocStrip de la source .dtx |
| Conteneur | Texte brut ; pas d'enveloppe binaire ni de compression |
| Publié | 1989 (DocStrip mechanism introduced with LaTeX2e era) |
| Dernière version | no versioned format spec; governed by current DocStrip and ltxdoc packages in TeX Live |
| Standard ouvert | Oui · libre de droits |
| Spécification | ctan.org |
Conversions DTX
Q&R de la communauté
posées par les utilisateursPas encore de questions - soyez le premier à poser une question sur les fichiers DTX.
Foire aux questions
Comment installer un paquet .dtx dans LaTeX ?
latex package.ins (le fichier d'installation compagnon) pour extraire le fichier .sty, puis déplacez-le dans votre arborescence texmf locale et lancez texhash. Ou utilisez le gestionnaire de paquets de votre distribution (tlmgr / MiKTeX Package Manager).Puis-je ouvrir un fichier .dtx sans avoir LaTeX installé ?
Quelle est la différence entre .dtx et .ins ?
Comment lire la documentation d'un paquet .dtx ?
pdflatex package.dtx pour générer un manuel PDF. De nombreux paquets CTAN hébergent également le PDF déjà compilé.