{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)

2
votes
2answers
414 views

What documentation on octavo is available?

Compared with other document classes, the documentation supplied with octavo on CTAN is very short. Does this documentation really provide the list of custom options and special commands used with ...
7
votes
1answer
261 views

How to output math environment code alongside typeset math?

I have a preamble which defines lots of symbols and a LaTeX document for testing them. In particular, I have source like this: \[\wlength{abc} = 3\] \[\lang{A} = \lang{\varphi}\] \[\kplus{L} \defeq ...
6
votes
1answer
408 views

LaTeX documentation with verbatim environment

I am trying to document some LaTeX macros concerning marginals. I think a good way for the documentation would be the LaTeX code on the verso page and the output on the recto page. So I came up with ...
13
votes
3answers
297 views

Comprehensive online manual for LaTeX2e user macros and environments

I find myself sometimes in the position that I need to know the "official" syntax and behavior of LaTeX2e user macros or environments. I'm talking about common things like minipage. Usually I find ...
15
votes
1answer
515 views

Automatic linking (aka code highlight) in Till Tantau's `codeexample`

I am writing docs for a tikz-based package, and I am trying to reuse Till Tantau's codeexample environment to output source code along with its output. However, I cannot manage to get syntax ...
5
votes
1answer
325 views

Creating a software manual. Any supporting packages?

So I am about to start writing a manual for a piece of software. Are there any packages available to depict radio buttons, check boxes, tabs, menus etc.?
6
votes
3answers
269 views

How to search a documentation about an tex-function in command-line way on linux?

How can I search things about some functions in LaTeX on Linux in the command-line? Tried texdoc, but texdoc cite, for example, don't works. I would like a tool to search about LaTeX functions in ...
5
votes
3answers
280 views

Online references for creating advanced macros?

I am looking for online references for creating advanced macros for LaTeX.
5
votes
1answer
597 views

Packages for documenting self written packages (sty-files)

I am looking for packages useful for creating a documentation for a self written package. I have found doc, but the documentation ltxdoc.pdf did not give me any useful example. Also I know of ...
6
votes
2answers
581 views

Use texdoc within a shell script (in Alfred.app) doesn’t work

I’m trying to call textoc from OS X Application Alfred as a shell script. And with Alfred everything seems fine—I already asked the developers but they say that the script should work. When ...
3
votes
1answer
84 views

doc.sty: Print codelinenumbers in index in tt font?

Is it possible to print the index numbers which are referring to a code line number instead of a page in typewirter font. I know that I can change \main, but on this way I can’t change the format of ...
6
votes
3answers
139 views

Class/package for German documentation

I’m writing the musuos class and I’m writing the documentation with ltxdoc.cls and doc.sty which seems to work. But the documentation is in German so it’s not very nice to get (environment) in the ...
11
votes
2answers
257 views

hyperref causes problem with doc.sty

Try the following code. Without hyperref everything is fine and there’s the right entry in the index. With hyperref this entry disappears. (The codeline entries which are not shown here ar not touched ...
3
votes
2answers
2k views

Template for cheat sheet

I have been working with LaTeX for a couple of years but I don't know anything about pure TeX. I find this LaTeX cheat sheet useful to remember some commands. So I'd like to have a LaTeX template for ...
42
votes
5answers
714 views

Which books can I read via texdoc?

For years, I was faithfully downloading a copy of TeX by Topic whenever I reinstalled my computer. Then I learnt about texdoc texbytopic and my life got just that smidgen easier. I've just returned ...
1
vote
1answer
218 views

Is Tex/LaTex appropriate for my situation

Is TeX a good idea for my current situation? I'm currently maintaining documentation for a piece of software, so I came up with my own .doc template with the official company header/footer. Since ...
28
votes
2answers
770 views

Moving to LaTeX3 for package authors

I would like to write a package using as much of LaTeX3 stuff as possible (in particular expl3, xparse and xtemplate). What should I read to learn these? In particular: I know that there are good ...
30
votes
2answers
2k views

What are good advanced LaTeX books?

I've been using LaTeX for about 3 months, and I'm hooked. My background is programming, so for the basic, google is sufficient. I did some research on amazon.com and found these two books with many ...
16
votes
2answers
742 views

Where can I find the LaTeX3 manual?

Few month ago I saw a big pdf-manual of all LaTeX3-packages and the new syntax. I think it was bigger than 300 pages. I can't find it on the web. Does anyone have a link?
20
votes
1answer
2k views

Berry naming scheme list of LaTeX font families

Could you provide me with a list of Berry names for LaTeX font families? I am currently working on a paper comparing various LaTeX fonts, particularly their support of extended Latin and it took some ...
4
votes
1answer
541 views

LaTeX resources for non-technical writing

I have read dozens of tutorials on creating LaTeX documents. All of them have one thing in common: they all focus on writing a technical thesis or a math paper of some sort. I'm a programmer and I ...
7
votes
2answers
558 views

Where can I find an online manual for low-level LaTeX commands?

Is there an online manual for low-level LaTeX commands I can download? I am looking for something which would have, for example: \newif\ifportrait \newif\ifcustomsize \newif\ifdebug \makeatletter ...
5
votes
2answers
2k views

Maintained version of tikz documentation

Is there maintained version of tikz and pgf documentation? The webpage doesn't state any but this file (pdf} is very useful.
2
votes
1answer
321 views

Running the animate package documentation

I downloaded the tex file for the documentation of animate package by Alexander Grahn and tried to run it on MikTeX instead of giving me the PDF output it generate the following error: ! LaTeX Error: ...
4
votes
1answer
117 views

What is `/utils/exec` and where do I find it's documentation

In response to this question on using a conditional to define a TikZ style it was suggested to use /utils/exec. It is easy to find uses of this, but I have not been able to locate documentation on ...
6
votes
1answer
201 views

Where can I find the documentation for `lstdoc`?

It appears that the listings package provides another package, called lstdoc, which in some unknown fashion provides facilities for printing TeX code samples while simultaneously TeXing them into the ...
4
votes
1answer
446 views

LaTeX3: Defining key to set boolean variable

I want to define a key, which, if set, sets a boolean variable to false. The documentation is not clear on that point. It states (source3.pdf, sect. 87, p. 134): Defines <key> to set ...
52
votes
6answers
4k views

Materials for learning TikZ

I feel intimidated in learning TikZ. I was wondering if there are some nice materials (or just your replies) at different level: for providing big picture, which is important to beginners to not ...
3
votes
1answer
930 views

Documentation for pgfplots expressions?

Is there documentation for which functions work as pgfplots expressions (like sin, cos, exp, etc.) The pgfplots documentation doesn't seem to say anything on what you can/can't use.
12
votes
2answers
521 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 ...
21
votes
1answer
823 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
547 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 ...
13
votes
3answers
898 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
518 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
370 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 ...
11
votes
2answers
3k 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
890 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, ...
2
votes
1answer
207 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
229 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 ...
77
votes
6answers
4k 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
170 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
645 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: ...
38
votes
1answer
1k 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
2k 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. ...
28
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
649 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
824 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
258 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> ...