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

32
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 ...
11
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. ...
4
votes
1answer
59 views

Tabular in dtx documentation

How to make table in .dtx documentation with vertical bars? % \begin{tabular}{c|c} % |sf| & \emph{mathsf}\\ % \end{tabular} fails, because |foo| is magic for verbatim.
12
votes
6answers
1k 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
2answers
132 views

How to document a expl3 macro using dtx

I am writing the documentation to a package implemented in expl3 using ltxdoc, and the relevant part would look like % \begin{macro}{\conteq_args_once} % Some explanation % % \begin{macrocode} ...
2
votes
0answers
247 views

english documentation of tkz-euclid [closed]

I just can't find the english documentation of tkz-euclid. ftp://ftp.fu-berlin.de/tex/CTAN/macros/latex/contrib/tkz/tkz-euclide/README says http://altermundus.fr (en français) or ...
8
votes
1answer
111 views

Add documentation to TL install

I installed the Tex Live 20130407 on my system. To save disk space, I did not install the documentation, because I thought that texdoc can download those files I ask it. However, issuing texdoc ...
10
votes
2answers
326 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 ...
5
votes
3answers
246 views

Online references for creating advanced macros?

I am looking for online references for creating advanced macros for LaTeX.
10
votes
2answers
421 views

Any way to show LaTeX example code *and* execute it? [duplicate]

In (La)TeX documentation and tutorials, it is common to show a snippet of code next to the output it generates. It might be two minipages side by side, or a code listing followed by boxed output, or ...
8
votes
0answers
121 views

Index problem when using l3doc for LaTeX document writing

I use l3doc to write document for my package. In the document I need describe macros, environments and options of the package. I started using the environment function only. After the tip came from ...
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 ...
6
votes
1answer
238 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 ...
35
votes
5answers
596 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 ...
71
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 ...
26
votes
2answers
1k 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 ...
6
votes
1answer
109 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), ...
2
votes
1answer
240 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, ...
9
votes
2answers
288 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 ...
8
votes
1answer
696 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
370 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 ...
9
votes
1answer
158 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 ...
7
votes
1answer
257 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
211 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
124 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 ...
4
votes
1answer
93 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 ...
11
votes
1answer
638 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.
9
votes
2answers
185 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
361 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 ...
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 ...
2
votes
1answer
125 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 ...
27
votes
2answers
728 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 ...
66
votes
6answers
3k 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 ...
5
votes
1answer
97 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 ...
8
votes
1answer
220 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 ...
13
votes
3answers
286 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 ...
5
votes
3answers
297 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 ...
11
votes
3answers
366 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 ...
36
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 ...
6
votes
2answers
142 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
425 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} ...
9
votes
1answer
242 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
261 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
1answer
188 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
194 views

Where can I find the standard LaTeX reference manual?

Like a semi-detailed user manual for LaTeX commands (\newtheorem, etc).
6
votes
1answer
481 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 ...
6
votes
3answers
130 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 ...
16
votes
2answers
679 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?
17
votes
3answers
292 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. ...
15
votes
3answers
682 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 ...