{documentation} is about the writing of TeX package documentation and packages designed for documenting TeX code, e.g. ltxdoc.
Questions tagged [documentation]
336 questions
80
votes
16 answers
What needs to be introduced in a short introduction to LaTeX?
One of the things listed at the How you can help in the TeX community page of the TUG website is:
We'd like to have an ‘introduction to LaTeX’ document that falls somewhere between the brevity of sample2e.tex and the completeness of A Not So Short…
Seamus
- 73,242
51
votes
1 answer
Glossary of TeX and LaTeX terms
This is not about glossary package. :-)
I was wondering whether there is a list of common terms you come across as a not-so-advanced user, defined already. Currently what we have are many books containing commands. But is there any compilation of…
Abhimanyu Arora
- 3,733
17
votes
1 answer
Should a \CharacterTable still be used in dtx files?
My understanding of the use of a \CharacterTable in .dtx files is that it provides a visual check that the file was transmitted properly and there were no issues with character encodings.
Is it still necessary? I notice quite a few class and package…
yannisl
- 117,160
17
votes
2 answers
Dummies Guide to TeX as a programming language
There are a lot of answers that are using a somehow cryptic syntax that I am not familiar with. Is there any Not So Short Introduction to TeX (like Not So Short Introduction to LaTeX) ?!
Real Dreams
- 8,298
- 12
- 56
- 78
15
votes
3 answers
Where can I find the standard LaTeX reference manual?
Like a semi-detailed user manual for LaTeX commands (\newtheorem, etc).
Dan Donnelly
- 153
14
votes
1 answer
Which LaTeX package has the longest documentation?
I began learning LaTeX in the last week and I'm really feeling the learning curve. Something I appreciate is the thoroughness of the documentation for the packages. At first I came across the caption and fancyhdr package documentations which were…
arara
- 776
13
votes
3 answers
Free intermediate level documentation
Are there any free manuals that are roughly on the level of Lamport, Mittelbach & Goossens, Kopka & Daly, etc.; more in-depth than the Not So Short Introduction to LaTeX, but not as daunting as source2e.pdf?
Ian Thompson
- 43,767
13
votes
6 answers
Writing manpage / reference manual for software in LaTeX
Is it a good idea to write your software manual pages (manpages) / reference manuals using TeX? I'm new to TeX and exploring my options around this.
I'd be able to deliver a manpage.pdf along with the sources, but I'd also like to put them online.…
Taco de Wolff
- 295
10
votes
3 answers
Extracting the structure of a LaTex document, including comments
I like to write a "special" comment with a title at the beginning of each paragraph in my documents, something like this:
\section{Introduction}
% 1.0 Visually tracking balls is an interesting problem.
Text related to why tracking balls is…
user623515
- 135
9
votes
1 answer
How do you use texdoc to search for example pdfs?
I usually use texdoc to quickly access doc files. However, sometimes the doc file is not useful and you want to look to example pdf files. As an example, try texdoc moderncv.
Is there a way to quickly access example docs (something like…
marcinkus
- 175
8
votes
3 answers
Where is the documentation?
Where or how do I find the documentation for a given Latex command?
For example, in R I get the documentation for mean() with ?mean or at the manual pages http://stat.ethz.ch/R-manual/R-patched/library/base/html/mean.html. In Java there are the…
dariober
- 285
8
votes
2 answers
An MS command line equivalent to Linux's "man" for help on Latex files?
Is there an MS DOS command line equivalent to Linux's "man" for finding help on Latex files?
e.g., if I were running Latex on Linux I could do:
man texify
to discover a file like this, from which I could learn, say, that --clean as a parameter…
lowndrul
- 5,323
7
votes
2 answers
Which latex editor is able to access all documentation of all packages?
I am looking for an editor or documentation browser that can look up all commands from all packages, for eg I want to for 'whiledo' then I want a window or pane to pop up with the required reference information. Also one forgets the command so it…
Robert Key
- 71
7
votes
4 answers
LaTeX equivalent to R's `help foo`?
From the R command line I can do help foo -- where foo is some R command-- and return a .html help file on foo. This holds even if foo is from some non-standard library I just loaded.
Q: What's the closest process to this in LaTeX?
Here I was…
lowndrul
- 5,323
7
votes
1 answer
Difference between documentation of the code and user documentation
From How to Package Your LaTeX Package tutorial:
"The important parts of a package are the code, the documentation of the code, and the user documentation."
What is the difference between documentation of the code and user documentation?
Mika H.
- 3,451