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

learn more… | top users | synonyms (1)

13
votes
2answers
583 views

Is there a list of general use LaTeX kernel macros?

Here are a few cases in which one could use such a list: Is there a "prepend" version of \g@addto@macro? A "local" version? What's the most efficient way of gobbling n characters? Can I use LaTeX's ...
22
votes
1answer
1k views

How do I document my style files?

I have many style files (and one or two class files) that I've written in my local texmf tree. Most were simple things that got me out of some trouble and which I put in to a style file in case I ...
2
votes
1answer
561 views

TikZ option for command or environment

I am learning TikZ. I am wondering where I can find information about options of command or environment. For example, for \draw, you can use \draw[step=0.5], but it also has ...
14
votes
3answers
1k views

Google searching LaTeX commands?

Q: How can I best search the web for exact LaTeX commands (e.g., \show as opposed to show)? It appears that Google will not allow us to escape the \ character. So, searches for \show are interpreted ...
7
votes
4answers
570 views

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 ...
8
votes
2answers
398 views

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 ...
14
votes
2answers
4k views

Does anyone know a good XeTeX tutorial?

I want to use XeTeX so that I can use a particular font, but I'm not quite sure about the documentation/commands in specifying this font in XeTeX. Can anyone point me to a good how-to tutorial on ...
13
votes
6answers
2k views

Is there some typesetting system that uses XML notation?

Is there some typesetting system that uses XML for notation? This is no offense, but I don't like to type \emph{This \emph{text} is important} despite the fact that there are editors that can do it ...
6
votes
1answer
942 views

Online searchable manual for TikZ?

Having used psTricks for years, I'd though I'd drag myself into the modern era and start using TikZ. So far, I like it very much. However, the only manual I can find is the 500+ page PDF manual, ...
3
votes
1answer
229 views

The cross-reference boxes in TeX: the program

You know those boxes at the bottom of the right-hand pages in Volume B? Well, I managed to weave mf.web by stealing the weave binary from a distribution where it actually works (it doesn't in ...
3
votes
1answer
241 views

Brown paper strip on page 125 of The METAFONTbook

I've borrowed a copy of The METAFONTbook from my school's library, and I'm wondering why there is a brown paper strip glued to page 125 between the text and the rings. I couldn't help but wonder if ...
83
votes
6answers
5k views

What is the minimum one needs to know to use TikZ?

I am fed up with the poor quality of the pictures in the papers written by my graduate students and am trying to convince them to use TikZ. I know of three ways to begin learning TikZ: The TikZ ...
4
votes
2answers
178 views

What is with the unsightly overlap at the top of the index pages in source2e.pdf?

I notice that in source2e.pdf, the Index section has a running header that intersects with the top of the main text on each page, like so: (Actually, this seems to happen with some other sections, ...
1
vote
1answer
712 views

Where can I find documentation on the tikzlibrary calc?

Where can I find documentation on the tikzlibrary calc?
11
votes
1answer
2k views

Old style numbers without fontspec

How do I use old style numbers everywhere without using fontspec? Or is it even possible? Where do I find the documentation for the fonts in the LaTeX Font Catalogue? Minimum (Non)Working Example: ...
41
votes
1answer
2k views

An explanation of LaTeX's output routine

Is there a good reference for LaTeX's output routine? The documented source is confused and confusing. The authors seem confused as to why parts are the way they are and wonder if maybe things should ...
15
votes
3answers
3k views

Is there a good plain TeX tutorial that explains about doing automation and making layout?

I am interested in learning plain TeX especially in automation: looping, conditional branching, jumping, iterating, etc. layout: creating custom smart tables and boxes that can span cross pages. ...
31
votes
2answers
2k views

Help in choosing LaTeX2e books in light of LaTeX3 development

I'm quite new to LaTeX (~3 months) and I'm excited about buying the books. I just bought The TeXbook on eBay and hopefully it should arrive next week. I might even want to get a printed copy of TeX by ...
3
votes
2answers
663 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.) ...
11
votes
3answers
963 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 ...
11
votes
2answers
264 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> ...
53
votes
2answers
3k 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 ...
6
votes
5answers
731 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 ...
12
votes
6answers
9k 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 ...
14
votes
3answers
679 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 ...
11
votes
5answers
408 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 ...
10
votes
3answers
451 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 ...
8
votes
1answer
231 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 ...
3
votes
1answer
119 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 ...
8
votes
1answer
230 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
15
votes
1answer
456 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 ...
65
votes
12answers
3k 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 ...
70
votes
16answers
3k 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. ...
27
votes
6answers
3k 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 ...