Questions tagged [documentation]

{documentation} is about the writing of *TeX package documentation and packages designed for documenting *TeX code, e.g. ltxdoc.

Filter by
Sorted by
Tagged with
3 votes
2 answers
810 views

Where do I find the pgf manual v2.00?

This might be a very stupid question, but I don't manage to find the pgf manual v2.00. On CTAN I only found v2.10. (I'd like to find it because I want to follow Andrew's comment to this great answer.)
Hendrik Vogt's user avatar
  • 37.3k
11 votes
3 answers
2k views

Can I enter code directly from a source file?

In a project I'm working, all the files are in the same folder (source codes, papers, images, etc). In the documentation, I'm including some code with minted which is really great, but I want to do ...
Tomas's user avatar
  • 5,341
11 votes
2 answers
1k views

What is "dimen" in the documentation for the ifthen package?

In the documentation for the ifthen package, there is a test called \lengthtest which compares two <dimen> parameters with the operators <, > or =. (For other test commands, <dimen> ...
Tomas Aschan's user avatar
  • 15.2k
66 votes
2 answers
7k views

Documentation reference for LaTeX internal commands?

This question led to a new package: macros2e Is there a place where I can find a reference of LaTeX internal commands? For example, just a few months ago I saw an answer using \@for and today I ...
Juan A. Navarro's user avatar
6 votes
5 answers
978 views

How do I search the hidden TeX Live folders in Mac OS X?

I considered asking this on Super User, and I also thought that TeX users on the Mac would be better able to help and be helped. I'll let the mods decide. I opened texdoc color and came to grfguide....
Kit's user avatar
  • 16k
13 votes
6 answers
18k views

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 ...
Taco de Wolff's user avatar
20 votes
3 answers
2k views

Is there a printable version of a reference manual for all TeX primitives?

Everywhere in the TeX community, I see suggestions like \parskip, \obeylines, \parindent, etc. I'd be surprised not to find them even in the most basic LaTeX packages. So I figured they must be deeper ...
Kit's user avatar
  • 16k
12 votes
5 answers
880 views

Where do I get a list of all possible texdoc's?

An easy way out would be to just texdoc the package name, but almost everyone knows that this does not apply to all packages. Some examples: I didn't know there was a usrguide There is an lshort....
Kit's user avatar
  • 16k
10 votes
3 answers
2k views

Where do I find the documentation for writing \newcommand's ?

At what level of the TeX system heirarchy is \newcommand? Where do I find documentation for these kinds of macros (e.g. \renewcommand, \def, \parskip, etc.)? My objective is that I will be able to ...
Kit's user avatar
  • 16k
8 votes
1 answer
359 views

How do I make the command texdoc latex2e to open the PDF version by default?

I found a latex2e.pdf in my MiKTeX installation tree. How do I make texdoc latex2e open the PDF version by default? UPDATE: I tried renaming latex2e.html to something else, and now the PDF version is ...
Kit's user avatar
  • 16k
3 votes
1 answer
201 views

How do I read the texdoc for the letter document class?

I am reading the texdoc for the letter document class. But it doesn't say anything about getting started. I think this is a commented source code document. Yes, it lists all the features of the letter ...
Kit's user avatar
  • 16k
8 votes
1 answer
351 views

Where are the texdocs for the built-in LaTeX document classes?

I can texdoc for the following classes: letter slides proc But, where are the texdocs for the following built-in document classes? article report book
Kit's user avatar
  • 16k
18 votes
1 answer
848 views

Are there guidelines on how to read commented sources of LaTeX packages?

I'm trying to read source2e.pdf (texdoc source2e on the command line), but I'm stumped. It seems a rather mysterious tome to me. As I understand from this answer about what arguments a command expects,...
Kit's user avatar
  • 16k
83 votes
12 answers
11k views

Best practices references

What resources (online or otherwise) exist that give good advice on best practices for TeX, etc.? I'm looking particularly for things that assume you already know TeX or LaTeX, and aim to help you ...
89 votes
17 answers
6k views

Which manuals are on your "TeX Reference" shelf?

This is a community wiki since there is no "one true answer"- if you find an answer that contains a lot of your choices, but is missing something you feel is incredibly useful. Feel free to add it. ...
48 votes
6 answers
13k views

Where can I find help files or documentation for commands like \@startsection for LaTeX?

I can't find official documentation for the \@startsection command. I already looked in: LaTeX Wikibook LaTeX: Structured document for TEX, 2008 beginLatex — a book that comes with ProTeX in the ...
mjsr's user avatar
  • 3,345

1
3 4 5 6
7