{documentation} is for questions addressing issues related to the writing of documenting TeX packages, or to packages designed for documenting TeX code, e.g., ltxdoc.

learn more… | top users | synonyms (1)

6
votes
1answer
290 views

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 ...
4
votes
1answer
327 views

Documentation for the animate package with TikZ

I'm trying to locate some detailed documentation on the animate package. When I look at examples here and in other places, there is really way too much unknown syntax to figure out. I was hoping ...
31
votes
5answers
588 views

How to build two different .tex files from same .tex file

When I prepare an exercise list for my students I use to also include there my own solutions. I prepare these documents with some macros based on mdframed and with comment help I easily obtain two ...
2
votes
1answer
245 views

Is there any textbook for XeLaTeX?

I usually use PdfTeX. Currently I have to learn XeLaTeX which I am not familiar with. So Is there any textbook for XeLaTeX? How to use numerous math fonts in one article? E.g. use mathrsfs, ...
6
votes
1answer
116 views

Is there any documentation of \Umathcode, \Umathcodenum, etc.?

Trying to use the package unicode-math I have been looking for some documentation of \Umathcode, \Umathcodenum, etc. The usually place, the package documentation (http://ctan.org/pkg/unicode-math), ...
9
votes
2answers
338 views

Where to find official (!) and extended documentation for tex/latex's commandline options (especially -interaction modes)?

Today I tried to learn more about the several interaction modes for tex/latex/pdflatex etc. The manpages turned out to be not very helpful: $ man tex ... -interaction mode Sets the ...
7
votes
1answer
298 views

Does the pgfplots manual crash your Preview and/or Skim app on OSX?

The pgfplots manual consistently crashes both my Preview.app and my Skim.app. A quick google search yields a closed bug report on the pgfplots Sourceforge page and a related question on ...
6
votes
3answers
219 views

Print macro signature

I am looking for a way to have a readable documentation of a macro signature (probably not the correct wording, but I mean the same thing as a function signature) in the source code and in the output ...
5
votes
2answers
134 views

does the doc folder contain only documentation?

I'm trying to get rid of some junk on my hard drive and want to make sure I don't delete anything vital, so it's probably a dumb question. In my latex tree there is the texmf-dist/doc folder which is ...
5
votes
1answer
96 views

portable packages

and sorry again for my bad grammar, English is not my native idiom. I start explaining about what I have and then what I want: I built a format for my school so students can build up their thesis ...
9
votes
1answer
166 views

Defining synonyms for indexing

Is it possible to set things up so that indexing synonyms does not generate multiple entries? For example, if the text includes \index{cur}, \index{hound}, and \index{mutt}, can these be coalesced ...
9
votes
2answers
191 views

Where can I find documentation on biblatex 1.7 (or other older versions of packages)?

I have just updated my MikTeX 2.9 (I'm using Windows 7)... and surprise! My citations don't work any more and I get cryptic error messages. Panic! After a few minutes of frantic and more or less ...
0
votes
1answer
374 views

Defining a listings style and available options

When defining a style for a listings environment, I can set the background color by doing: \lstdefinestyle{highlight}{ backgroundcolor=\color{orange} } Apart from backgroundcolor, which other ...
8
votes
1answer
754 views

How can I get documentation for the LaTeX letter class?

I am trying out TeX and writing some correspondence in it just to learn the basic commands. For the "letter" document class, I have found this reference site: ...
14
votes
4answers
417 views

LaTeX, package documentation look-up

I am on OS X (10.6 Snow Leopard) using TeXLive-2011 to typeset a simple .tex file I am editing in Vim and trying to learn. My problem is: how do I... gradually learn about what TeX can do for me get ...
3
votes
2answers
2k views

How to write content next to tikz figures?

This is my code : \begin{document} Formally, a streaming string transducer is a 8-tuple $(Q,\Sigma_1,\Sigma_2,X,F,\delta,\gamma,q_0)$ machine, where $Q$ is a finite set of states, $\Sigma_1$ is ...
38
votes
1answer
1k views

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 ...
2
votes
1answer
128 views

dtx: add code to sty file without printing it to pdf

I want to add comments to the sty file that should not be printed to the pdf, because the description is almost identical. Is it possible to configure the dtx file, such that not every code added to ...
15
votes
1answer
744 views

Who wrote “What are TeX, LaTeX, and friends?”

Who wrote What are TeX, LaTeX, and friends? I want to reference it in my article.
72
votes
16answers
2k views

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 ...
5
votes
1answer
98 views

Where can I find spanish documentation for creating LaTeX classes?

Searching the web for spanish documentation about creating classes for LaTeX, I found this website belongs to the class of "Scientific text processing in high quality" (Procesamiento de textos ...
10
votes
2answers
332 views

Starting point for getting more familiar with TeX/LaTex etc

Background: I've been using what I would call LaTex for ~4 yrs to typeset assignments, reports, essays and tutorial notes. I have been using "TexShop" (for Macs) - mostly because it was simple when I ...
13
votes
3answers
289 views

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 ...
12
votes
3answers
379 views

Updated documentation of ConTeXt

I'm trying to decide which set of macros/typesetting system to learn. I tried Latex2e for a while, but I was very disappointed that it didn't work nicely with Unicode and that in my tryout I had many ...
6
votes
2answers
145 views

What documentation visually explains the various available commands to control the vertical distance between two lines of text?

I have a title page containing several lines of text, e.g.: Series Title Author Institution I would like to fine-tune the distances between the lines, however, I do not understand which tools ...
7
votes
2answers
440 views

Where can I find documentation about TikZ/TikZPicture?

When looking for different packages of creating timelines, I came across the following one: \documentclass[12pt]{article} \usepackage[a4paper]{geometry} \usepackage{tikz} \usetikzlibrary{snakes} ...
30
votes
4answers
10k views

TikZ manual newest version online?

Is there a definite place where TikZ manual can be found online? I am only finding version 2.00, while I keep loosing the link to 2.10. Does the official site host the manual somewhere, or is it ...
9
votes
1answer
247 views

How to illustrate and execute a MWE within another document

In Show output of a full LaTeX document I provided a partial solution to a similar question. The following code is an attempt to simulate the running of a full MWE within another document as for ...
3
votes
1answer
275 views

Having docstrip place files in different folders

I've written my own biblatex citation style and decided to put both the bbx and the cbx file in a dtx file to process that with docstrip. Now I would like to have docstrip place the files in my local ...
5
votes
3answers
300 views

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 ...
5
votes
1answer
201 views

Is there a similar manpage for LaTeX packages/template?

In Unix like systems, there are always manpages for the packages installed.When I'm using latex, I have to use some templates or packages. But I'm not familiar with the usage of some package.For ...
4
votes
3answers
196 views

Where can I find the standard LaTeX reference manual?

Like a semi-detailed user manual for LaTeX commands (\newtheorem, etc).
35
votes
3answers
2k views

Different approach to literate programming for LaTeX

I have spent a couple of hours rethinking the literate style tools we have for LaTeX, which are essentially doc, docstrip and ltxdoc. Although the traditional workflow with a good editor can be less ...
17
votes
3answers
297 views

Where can I find a documentation for low-level tex conditionals like \if?

I want to understand low-level stuff like \if better. I'm not looking for some random examples off Google showing me some statements but a specification of some sort - something mean and unforgiving. ...
22
votes
3answers
1k views

Classes for LaTeX documentation

I wonder which classes are available to typeset LaTeX manuals. Until now I have used ltxdoc. I’m satisfied with its functions but not with its layout/design and it’s not really flexible when writing ...
15
votes
3answers
731 views

Tutorial on positioning

As a beginner, I keep running into difficulties when in the need of positioning elements. Pushing them down, up, left or right should be easy concepts, but I find it hard to visualize as a beginner ...
6
votes
1answer
508 views

Documentation on beamer element category to theme element mappings?

I keep looking for documentation that explains the usual mappings between beamer element categories (e.g. "structure") and elements in common themes. I haven't found what I'm looking for in any ...
16
votes
1answer
143 views

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 ...
1
vote
1answer
751 views

Sphinx error in converting latex to pdf

I'm trying to convert latex to pdf of CherryPy docs for offline usage. After I generated the latex I changed into build/latex directory and run "make all-pdf" and error happened. Sorry I don't know to ...
4
votes
1answer
79 views

How can I have doc/docstrip output more than one file?

I am trying to use doc\docstrip to write a small package. I have one main class .dtx, which is processed via an .ins file. Is it possible to include two small test files in the .dtx file and generate ...
15
votes
2answers
807 views

What font configuration is used by microtype documentation

I really like the font configuration (appearance) of the documentation for microtype package (see here). How do I find out the combination they're using? (I will fix the protrusion etc later but first ...
13
votes
1answer
393 views

How to write a user manual for a class in two languages?

Most classes and packages on ctan, offer a .dtx file, which when processed will automatically produce a user manual. In most cases such classes use the author's mother language. As for example yfonts ...
2
votes
2answers
394 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
254 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
385 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
288 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 ...
14
votes
1answer
491 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
311 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
258 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
268 views

Online references for creating advanced macros?

I am looking for online references for creating advanced macros for LaTeX.