Questions tagged [doc]

doc is a package for documenting the source code of LaTeX packages and classes. doc is commonly used with the ltxdoc class and with the docstrip utility to extract the package code from the source. Questions about the .doc file format used by the Word processing software should be tagged with {msword} instead.

Filter by
Sorted by
Tagged with
0
votes
0answers
12 views

Putting user doc and dev doc together in a dtx file

I am in the process of documenting a largeish package, and would like to use ltxdoc for that. I would like the produced pdf file to consist in the usual two parts, user documentation then code ...
1
vote
2answers
23 views

doc package: multiple macros with one definition

I'm writing class documentation with the doc package (well, via ltxdoc documentclass). I have several similar options like font sizes and line spacing, that I want to group together in one macro ...
2
votes
1answer
51 views

Troubleshooting \PrintIndex \PrintChanges

The code below contains a change markup and the intent is that it be printed. I get: ERROR: LaTeX Error: \verb ended by end of line. How can I fix it? foo.dtx % \iffalse meta-comment % !TEX program ...
1
vote
1answer
48 views

LaTeX doc package document keys for keyval package

I am trying to document a package that uses keyval for key/value argument parsing. I wish to document the key/value options for some of the commands in the same way that I document macros and ...
0
votes
1answer
29 views

Can I reset codline numbering when importing code from multiple dtx files?

I have studied Will Robertson's DTXGALLERY examples and now have my package set up as a bundle consisting of three packages. Each package's code lives in separate dtx files, two of which are imported ...
1
vote
1answer
18 views

CodelineIndex from doc package: sorting page vs codeline index entries

In the following sample "documentation" of a macro \foo using the doc package, index entries for \foo are in an unnatural order. How can this be avoided? \documentclass{article} \usepackage{...
2
votes
0answers
88 views

\box\@labels and macrocode environment

I'm not sure what macrocode environment intends to do with \box\@labels. Initially \box\@labels is void. When macrocode environment ends, it leaves some contents: \box15= \hbox(0.0+0.0)x0.0 .\...
3
votes
1answer
31 views

Problem with equals sign in doc \changes

When documenting a class/package with the doc package (or some derivative), what's the best way of including a literal equals sign in the text of a \changes command? Since = is used as a special ...
0
votes
1answer
1k views

Converting Lyx to Word

I am using Lyx2.3.3. I have installed Pandoc. I reconfigured Lyx ( Tools> reconfigure). I should then be able to simply export lyx file to the MS Word Office open XML, however I get an error as shown ...
1
vote
2answers
203 views

Is it common to save each chapter of a document as a separate file?

I’m due to start my dissertation and saw a few people recommend the technique of having one master file which links to each chapter which in itself is saved as a separate file. If this is optimal, how ...
1
vote
1answer
62 views

How to use doc package \efill

I'm using indexing with the doc package and I've run in to an issue. When I have keys that are more than one word they justify over the whole column. I wanted to use the \efill macro to get the keys ...
1
vote
2answers
87 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
56 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 ...
18
votes
3answers
548 views

About what TeX does after it finds commented conditionals with ltxdoc

When I thought I understood the concept of the doc package, LaTeX proved me wrong. I was trying to make a file to use with ltxdoc when I realised I could not use conditionals in the preamble because ...
2
votes
1answer
332 views

Change the comment character (%) for the doc class

When generating files from a *.dtx source, Docstrip discards lines starting with the comment character % (unless they contain guards %<guard>content). When typesetting the documentation with ...
20
votes
0answers
427 views

How to customize `l3doc`?

As I'm currently writing a package and started to use dtx format I wondered if there are alternative classes just using doc, so I started to use l3doc (since I use expl3 syntax). I'm pretty satisfied ...
2
votes
0answers
115 views

Wrong bookmarks with hypdoc

The following MWE points out that, with hypdoc package, the bookmark of the change history section is wrong: "Change History" instead of "Other title for change history". \documentclass{article} % \...