The `docstrip` pack­age pre­pares a LaTeX pack­age source file for ac­tual use, by re­mov­ing the doc­u­men­ta­tion and meta-data.

learn more… | top users | synonyms

3
votes
0answers
22 views

Including compiled PDFs in documentation built by l3build

I am building a project with l3build. There are some examples I want to present in the documentation, showing their source code, annotated with DocStrip, as well as including the output they produce ...
2
votes
1answer
67 views

Does DocStrip dislike glossaries?

I had a rather nice idea, pop any glossary terms into a DTX file. I can partition any terms by domain/topic into styles files called domain.sty/topic.sty and load whatever is relevant. So I run ...
5
votes
1answer
166 views

\inputencoding{latin1} cannot be used in the user documentation of a .dtx file if it is \DocInput

Third edit: (As pointed out by Ulrike, my problem in fact doesn't concern listingsutf8 but only inputenc, so I reflect this by giving to the question another title and another MWE.) The following MWE ...
12
votes
3answers
539 views

What to put into the dtx file?

Many packages are written as a single dtx file from that everything that composes the package is extracted. Apart from documentation and package code (the sty or cls), the installation instructions (...
4
votes
1answer
43 views

Variant of DocStrip's \file that doesn't add .tex extension

For a class I want to upload on CTAN, several files are generated thanks to DocStrip's utility: \generate{\file{⟨output⟩}{\from{⟨input⟩}{⟨optionlist⟩}}} Quoting Heiko Oberdiek in What path provide ...
4
votes
1answer
224 views

What path provide in a .dtx file (located in source/ folder) to reach files located in doc/ folder?

For a class I want to upload on CTAN, I'd like the provided files to be organized as follows when installed by TeX distributions: 〈ROOT PATH〉/doc/latex/myclass/ myclass.pdf sample/sample.tex ...
4
votes
2answers
94 views

Why is it not possible to embed \if construction in docstrip

I would like to create a DTX files which could be compiled in two different ways depending of a user's choice. One way to get only the user documentation, and another to get user documentation and ...
5
votes
1answer
68 views

Why does compiling this .dtx produce a blank page at the beginning?

This is my first time using docstrip. I've written the attempt.dtx file shown below. However, if I compile attempt.dtx using pdflatex attempt.dtx the generated documentation starts by a blank page (...
10
votes
1answer
190 views

How do I use l3docstrip?

I've got a bundle I'd like to properly document (and begin to release) that uses expl3 intimately, and it should be documented similarly to expl3 itself (as seen in texdoc interface3. I did a little ...
3
votes
1answer
186 views

Removing \CheckSum and \CharacterTable for some generated files

How can you prevent \CheckSum and \CharacterTable appearing in some of the generated files (examples include README, ChangeLog, LaTeX example files, ...)?
9
votes
2answers
167 views

What is the ^^A in DTX sources?

After fleshing out (with my own project) Joseph Wright's lovely model, I've noticed that the explicit control character ^^A is used at the end of some lines. Its use appears similar to that of % to ...
9
votes
1answer
256 views

How do I move the package implementation to the back of the documentation?

I'm trying to learn how to use .dtx files, docstrip etc to produce both package code and documentation from a single file. My primary source of information so far has been Joseph Wright's model dtx ...
11
votes
3answers
442 views

(How) Can I write a .dtx file without having to comment out *everything*?

I have a reasonable understanding now of how .dtx files work. But it's a great pain having to put a % character before every line of documentation. Also, depending on which editor you're using, it ...
11
votes
3answers
253 views

What does the “driver” section do in a .dtx file?

I've read the docstrip documentation, but have yet to form an intuition about how package documentation is extracted when I simply run pdflatex package.dtx. Let's say I'm using the simple dtxtut ...
20
votes
2answers
5k views

What is the docstrip utility?

What is the docstrip utility? I have seen the string below many times, in many sources: generated with the docstrip utility but what is it? Is it a kind of LaTeX editor?
4
votes
1answer
103 views

\batchinput (docstrip) in a different directory

docstripprovides the macro \batchinput, which calls a separate ins file. This file can be in a different directory with, say: \batchinput{../contrib/xx.ins} and they are generated, but in the same ...