O que é o formato de ficheiro DTX?
Um arquivo .dtx é um arquivo Documented LaTeX Source - o formato padrão para distribuir pacotes LaTeX no CTAN (Comprehensive TeX Archive Network). O formato implementa uma abordagem de programação literária: um único arquivo .dtx intercala o código-fonte executável do pacote com sua documentação tipográfica completa em um arquivo de texto simples independente.
O mecanismo depende do DocStrip, um utilitário incluído em todas as distribuições TeX. Comentários de guarda na forma % <guard> marcam quais linhas pertencem à implementação e quais são pura documentação. Executar latex package.ins (usando o arquivo instalador .ins complementar) remove os marcadores de documentação e extrai os arquivos de pacote .sty ou .cls utilizáveis. Executar pdflatex package.dtx, em vez disso, tipografa o manual completo - com código-fonte anotado e realce de sintaxe.
Quase todos os pacotes do CTAN são enviados como um par .dtx + .ins. O arquivo .ins é um pequeno script DocStrip que informa ao extrator quais arquivos de saída produzir e onde colocá-los.
Arquivos .dtx são texto simples UTF-8 (ou ASCII) e abrem em qualquer editor de texto, embora editores compatíveis com TeX, como TeXstudio ou Texmaker, forneçam realce de sintaxe. A classe de documento ltxdoc, parte do kernel do LaTeX, é usada para tipografar a documentação .dtx e fornece ambientes para anotar definições de macros ao lado de seu código-fonte.
Segurança e proteção
RISCO: LOWArquivos DTX são arquivos de código-fonte em texto simples; eles não representam risco direto de execução quando abertos em um editor de texto. Compilar um .dtx não confiável com LaTeX acarreta o mesmo risco que executar qualquer documento LaTeX: código TeX malicioso pode executar comandos de shell se o --shell-escape estiver ativado. Não compile arquivos .dtx de fontes não confiáveis com shell-escape ativado.
Detalhes do formato
em resumoProgramas que abrem arquivos DTX
latex package.ins através do menu Ferramentas para extrair arquivos .sty. latex package.ins no terminal para extrair .sty/.cls; execute pdflatex package.dtx para gerar a documentação em PDF. latex package.ins através do menu Ferramentas para extrair arquivos .sty. latex package.ins através do menu Ferramentas para extrair arquivos .sty. Detalhes técnicos
especificação profunda| Codificação | Texto simples - ASCII ou UTF-8 |
| Mecanismo | Sistema de programação literária DocStrip (Frank Mittelbach, 1989) |
| Sintaxe de guarda | Comentários % <guard> controlam quais linhas são extraídas como código vs. tipografadas como documentação |
| Arquivo complementar | Script instalador .ins conduz o processo de extração do DocStrip |
| Comando de extração | latex package.ins - produz arquivos de saída .sty ou .cls |
| Comando de documentação | pdflatex package.dtx - tipografa o manual da fonte anotada |
| Classe de documentação | ltxdoc (parte do kernel LaTeX); fornece ambientes \DescribeMacro e \DescribeEnv |
| Tamanho típico do arquivo | 5 KB - 500 KB (pacotes grandes com documentação completa podem chegar a vários MB) |
| Plataforma de distribuição | CTAN (Comprehensive TeX Archive Network) - virtualmente todos os pacotes CTAN usam .dtx |
| Sistemas operacionais | Windows, Linux, macOS |
| Arquivos de saída | .sty (pacote) ou .cls (classe de documento) extraídos pelo DocStrip da fonte .dtx |
| Contêiner | Texto simples; sem invólucro binário ou compressão |
| Lançado | 1989 (DocStrip mechanism introduced with LaTeX2e era) |
| Versão mais recente | no versioned format spec; governed by current DocStrip and ltxdoc packages in TeX Live |
| Padrão aberto | Sim · livre de royalties |
| Especificação | ctan.org |
Conversões de DTX
Perguntas e Respostas da Comunidade
perguntado por usuáriosAinda não há perguntas - seja o primeiro a perguntar sobre arquivos DTX.
Perguntas frequentes
Como instalo um pacote .dtx no LaTeX?
latex package.ins (o arquivo instalador complementar) para extrair o arquivo .sty, depois mova-o para sua árvore texmf local e execute texhash. Ou use o gerenciador de pacotes da sua distribuição (tlmgr / MiKTeX Package Manager).Posso abrir um arquivo .dtx sem o LaTeX instalado?
Qual é a diferença entre .dtx e .ins?
Como leio a documentação de um pacote .dtx?
pdflatex package.dtx para gerar um manual em PDF. Muitos pacotes do CTAN também hospedam o PDF pré-compilado.