Questions tagged [documentation]
{documentation} is about the writing of *TeX package documentation and packages designed for documenting *TeX code, e.g. ltxdoc.
29
questions with no upvoted or accepted answers
4
votes
0
answers
100
views
More generic tool than TeXdoc?
I'm wondering if there is a more generic tool than TeXdoc to browse (and generate) documentation. With TeXdoc, one retrieves (as far as I know) the documentation .pdf of the package. This requires ...
- 4,113
4
votes
0
answers
122
views
Is there a `sty2dtx` for LaTeX3 syntax?
sty2dtx is a CLI tool to convert a commented style file into a Documented TeX file (dtx).
It was written and works wonderfully for LaTeX2e packages, but expl3 offers a lot of happy times for package ...
- 27.1k
3
votes
0
answers
82
views
Systematic and structured study of (Lua)(Xe)(La)TeX
I have a general question for the TeX.SE community.
I'm a regular user of LaTeX for the last 4 years or so.
I can say with some degree of confidence that I am conversant with the bare basics of (Xe)...
3
votes
0
answers
279
views
Document Class (or Alternative Solution) for Documenting Programming Code
Different from writing a report or thesis involving code, I have the goal of producing a transcription of a C++ solution involving many projects with many .h and .cpp files. Furthermore, this document ...
- 93
2
votes
0
answers
103
views
Is there a guide to writing good TeX package documentation?
I've put together a basic package which I think could be useful, and is working great. The code is simple, and I want to submit to CTAN.
However, first, I have to write documentation, and I've never ...
- 117
2
votes
0
answers
172
views
Code highlight in ltxdoc documentation
I wish to add LaTeX code highlight in a package documentation. Usually I use the following code to highlight LaTeX code (copied from classicthesis documentation):
\usepackage{listings}
\definecolor{...
- 7,462
2
votes
0
answers
124
views
How to compile pgfmanual
I'am trying to compile pgfmanual with texlive 2020. Codes are cloned from pgf-tikz/pgf.
I simply run make under path pgf/doc/generic/pgf/version-for-pgftex/en, but got an error pgfmanual-en-macros.tex ...
- 4,426
2
votes
0
answers
43
views
Can I safely move the LaTeX doc folder in Linux from the distribution folder to the local texmf/ folder?
Latex's documentation is quite big and I am now running out of space on / .
I have the main Latex installation under / , where I have a folder ../texmf-dist/doc/ which is quite big. I have space ...
- 2,228
2
votes
0
answers
250
views
manual - How to understand ConTeXt commands?
The reference manual ConTeXt commands gives all supported options by command. Unfortunately, there is no description about the conventions used.
¹ ²
\setuphead [...,...] [..,....
user166576
2
votes
0
answers
127
views
How should doctools be used with a standard class?
I am exploring the possibility of using doctools to document a package. According to the documentation, it can be used either in a .dtx file, when doc.sty is loaded, or in an ordinary document, when ...
- 186k
1
vote
0
answers
64
views
What English phrase corresponds to the latex command `\rlap`
Using an alignat environment, it is possible to write down some notation for a linear program (optimization problem with linear objective function and linear constraints).
What English phrase is a ...
- 291
1
vote
0
answers
52
views
TeX compiler with written privacy policy
I have a weird question: I am working at a public high school in New Hampshire, and I can't have any software installed on my school laptop unless the tech office determines that it does not violate ...
1
vote
0
answers
59
views
Exact meaning of <balanced text> in LaTeX3 documentation
This is both a question as well as a (potential) suggestion for the LaTeX3 documentation:
When specifying the syntax of documented macros, <description> is used to denote an argument to be ...
1
vote
0
answers
221
views
titlesec VS amsart
I am just wondering why the titlesec package doesn't work well with the amsart document class. For example, in the code below the first \section seems to work fine whereas the second doesn't even ...
- 505
1
vote
0
answers
30
views
Where can I find a description of the tldrm format?
I have not found anything but some old references from texlive mailing lists. Just want to figure out the format, especially functions like RELOC.
- 515
1
vote
0
answers
53
views
How to install the documentation for a package
I installed the hanging package with tkmgr gui but it came without documentation. How can install the documentation?
- 11
1
vote
0
answers
130
views
Creating custom tabular-like environment
I want to make a custom latex environment that works like a modified tabular, that allows me to append numbers above the cell. All things made with this environment would be single-row tables.
The ...
- 11
1
vote
0
answers
234
views
tex4ht manual for header, footer, toc
I'm converting a book (6 parts, 30 sections,...) with dynamic graphs into a series of HTML pages using tex4ht. However, I'd like to have a nicer way to navigate. The standard is "next, prev, up, .." ...
- 51
1
vote
0
answers
98
views
A template for documentation for ctan
I got my Fill-Pages-Package (hopefully bug free) ready, which is my first package. Now I want to upload it on ctan. But first there must be a documentation. I've been searching for a template for the ...
- 2,288
1
vote
0
answers
128
views
Is there a good way to automatically generate a list of commands/environments defined in the preamble?
Background
I have seen beautiful manuals with commands and descriptions of what they do. I have a shared preamble (edited by multiple people and used for multiple documents) that has a multitude of ...
- 13.1k
0
votes
0
answers
22
views
Language Reference for PGFPlots
I'm trying to write a C# PGFPlots SDK, so that I can take data crunched in C# and output PGFPlots LaTex.
This means that I need to understand all of the possible components that make up a PGFPlot ...
- 1,019
0
votes
0
answers
46
views
Accessing all TeX Live documentation files in Kile
I have set the location of TeX documentation as /usr/local/texlive/2022/texmf-dist/doc in Kile and selected the option of 'Use your system's TeXLive documentation'. Still, when I go to Help -> TeX ...
- 627
0
votes
0
answers
39
views
Generating display mockups (ex. for datasheets or documentation)
I understand this is a very generic question but I have been trying to find something ready made to generate mock-ups of basic character displays (such as OLED screens) in LaTeX.
I have considered ...
- 589
0
votes
0
answers
136
views
Where are the docs? (Or: We may need an online documentation portal)
This is basically Where is the documentation?, but let me repeat it for a bit and then suggest an idea... skip past the line to get there immediately
After thinking about this for a while, I reached ...
- 195
0
votes
0
answers
146
views
Macro manual for WinEdt 10.3 in pdf - where do I find it?
I need the Macro manual for WinEdt 10.3 in pdf - where do I find it ?
- 1,886
0
votes
0
answers
86
views
WinEdt 10.3 - a manual request
Where can I find the WinEdt 10.3 newest manual (from year 2020), any links/references ?
Does this manual also come as a book on Amazon.co.uk ?
- 1,886
0
votes
0
answers
225
views
How can I see a list of commands for each MiKTeX package?
For example, take the 'textcomp' package. I can only find commands like \textdegree, etc. from here and there. Is there a way to see all the available commands for this as well as other packages?
(...
- 101
0
votes
0
answers
655
views
Where can I find documentation for the dsp-tikz library?
I would like to track down the best source of documentation for the (digital signal processing) dsp-tikz library.
An example using the library is shown here.
- 99
0
votes
0
answers
90
views
References to the macro environment
Suppose I have the following in my dtx file (using ltxdoc):
%\begin{macro}{\mymacro}
% \label{macro:mymacro}
% Example text
% \begin{macrocode}
\newcommand{\mymacro}[0]{An example macro}
% ...
- 5,149