Questions tagged [docstrip]

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.

Filter by
Sorted by
Tagged with
1
vote
2answers
37 views

Using edef'd text with doctex pre/postamble

I'm updating my DocTeX template(s) given the model DTX file by Joseph Wright, who includes a readme guard from which the readme.txt is generated. The \delcarepre/postamble macros from DocTeX prefix \...
0
votes
1answer
39 views

Multiple copyright messages in ones doctex templates

I just realized that I have three copyright sections in my DocTeX templates ??? I was trying to merge my templates, generated from the DTXTut by Scott Pakin, with the model DTX file, proposed by ...
1
vote
1answer
120 views

Templates in DocTeX : Documenting and producing code within the macrocode environment

I'm writing a DocTeX file (*.dtx) to create a family of classes. From this file I am also generating and documenting the templates that illustrate their usage. %\iffalse %<*template> %\fi % % ...
1
vote
1answer
42 views

How to generate a Makefile from dtx // keeping the tab width

For a complete documentation I would like to maintain and explain the Makefile within my dtx-file. Two problems occur: docstrip always adds an extension to the generated file (\file{Makefile}{\from{\...
0
votes
0answers
27 views

Docstrip: Suppress output of lines outside guards?

Is it possible make the docstrip utility's \generate ignore all lines, that have not been marked by the %<*guard>...%</guard> construct? This ties in to my (duplicate) question Can ...
0
votes
0answers
10 views

Can docstrip be configured to output ONLY tagged snippets? [duplicate]

In the DTX file format, all lines that are meant to appear exclusively in the typeset document, but not in the files output by \generate have to be commented. Any line, that is not commented, is ...
3
votes
1answer
95 views

How can I extract standalone.tex from standalone.dtx?

standalone's manual explains three ways of using the package. standalone.sty: \usepackage{standalone}: for use with a non-standalone class, setting \standalonefalse; standalone.cls: \documentclass{...
0
votes
1answer
109 views

Help needed: DocStrip with multiple files

I am maintaining a bunch of files, presenting packages and classes for my university corporate design. In order to use literate programming and have better documentation, I am playing around with ...
4
votes
0answers
78 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
124 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 ...
4
votes
1answer
392 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 ...
11
votes
3answers
971 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
70 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 ...
5
votes
1answer
421 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 ...
5
votes
2answers
144 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
91 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 (...
9
votes
1answer
346 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
294 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
195 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 ...
10
votes
1answer
296 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 ...
13
votes
3answers
833 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
387 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 ...
26
votes
2answers
8k 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
134 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 ...