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.
25
questions
4
votes
1
answer
91
views
Can I use ltxdoc, makeidx, doc and bookmarks? If so, how?
Is it possible to use ltxdoc.cls with makeidx and bookmark?
MNWE:
\documentclass{ltxdoc}
\usepackage{makeidx}
\usepackage{bookmark}
\makeindex
\begin{document}
\DescribeMacro{\mymacro}\marg{argument}\...
- 189k
5
votes
1
answer
83
views
How to modify doc's v3 documentation macros à la doctools?
I used the ltxdoc class with doc and doctools to document prooftrees. That documentation currently requires the compatibility option doc2 as my modifications don't work with version 3 of doc.
I'm ...
- 189k
2
votes
1
answer
157
views
equal symbol (=) behaves unacceptably in `doc`
I want to make a document with the package doc. When I type = in \changes, words before = disappear. Why would this happen?
\documentclass{article}
\usepackage{doc}
\begin{document}
\RecordChanges
\...
- 1,328
1
vote
1
answer
87
views
Which code is executed when generating .sty from .dtx?
I am trying to understand how to generate .sty using .dtx. Suppose I want the following code to be in the .sty file:
\NewDocumentCommand{\foo}{ }{}
\NewDocumentCommand{\bar}{ }{}
\ifluatex
\let\baz\...
- 3,066
0
votes
1
answer
35
views
Why can I no longer remove "General:" when using \PrintChanges as of doc 3?
As of version 3, the doc package provides reportchangedates option to display dates along with package changes. I want to remove the word "General" and the colon that follows it from the ...
- 3,212
4
votes
1
answer
148
views
What causes Unused global option(s) error after updating to latex-base 2022-06-01-PL1?
After applying today's kernel updates (2022-06-01-PL1) it seems loading the doc package now causes an Unused global option(s) warning over options passed to the article document class that was not ...
- 3,212
1
vote
0
answers
27
views
Improve the undesirable empty line produced by docstrip [closed]
In my .ins file, I have this setup before \generate:
\input docstrip.tex
\keepsilent
\askforoverwritefalse
\begingroup
\catcode`\^^M=\active%
\obeyspaces%
\gdef\copyright{%
\ds@heading% This is file.....
- 7,808
1
vote
0
answers
32
views
Strange sorting in Change History with docstrip
I am slowly moving from writing packages from scratch to using Doc and DocStrip instead. Recently I noticed a strange sorting in the "Change History" section of my documents.
I am using ...
- 5,224
2
votes
1
answer
162
views
Documentation of `l3doc` functions
By digging through some Question and Answers from here, I stumbled upon the MWE in this question. The part
% \begin{function}{\mymacro}
% \begin{syntax}
% \cs{mymacro}\marg{Arg1}
% \end{...
- 5,224
1
vote
2
answers
53
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,637
2
votes
1
answer
95
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 ...
- 2,070
1
vote
1
answer
65
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 ...
- 227
0
votes
1
answer
41
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 ...
- 3,212
1
vote
1
answer
31
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{...
- 44.7k
3
votes
0
answers
116
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
1
answer
43
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 ...
- 412
0
votes
1
answer
3k
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 ...
- 55
1
vote
2
answers
2k
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 ...
- 249
1
vote
1
answer
78
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 ...
- 647
1
vote
2
answers
135
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 \...
- 978
0
votes
1
answer
69
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 ...
- 978
18
votes
3
answers
571
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 ...
- 70.5k
3
votes
1
answer
545
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 ...
- 2,913
24
votes
1
answer
604
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 ...
- 33.3k
2
votes
0
answers
123
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}
% \...
- 9,530