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

3
votes
1answer
88 views

l3doc in combination with minted

The following question is related: How to add listings environment to DTX files I want to use the document class l3doc in combination with minted. However I am not able to get a nice result. If I ...
3
votes
1answer
197 views

Documentation of LaTeX2e source

Where are the best places to look if one would like to understand the LaTeX2e source code? Related: Comprehensive online manual for LaTeX2e user macros and environments Are there guidelines on how ...
7
votes
2answers
149 views

What is the ^^A in DTX sources?

After fleshing out (with my own project) Joseph Wright's lovely model, I've noticed that the explicit control character ^^A is used at the end of some lines. Its use appears similar to that of % to ...
7
votes
1answer
81 views

How do you use texdoc to search for example pdfs?

I usually use texdoc <package> to quickly access doc files. However, sometimes the doc file is not useful and you want to look to example pdf files. As an example, try texdoc moderncv. Is there ...
4
votes
1answer
66 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.
7
votes
2answers
148 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} ...
3
votes
0answers
417 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
118 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 ...
12
votes
2answers
528 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 ...
11
votes
1answer
158 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 ...
6
votes
1answer
390 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
431 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
620 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
252 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
128 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
481 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
352 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
232 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
151 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
180 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
199 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
398 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
876 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
479 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 ...
4
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 ...
40
votes
1answer
2k 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
130 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
769 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
100 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
339 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
290 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
395 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
155 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
460 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} ...
32
votes
4answers
11k 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
250 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 ...
4
votes
1answer
300 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 ...
6
votes
3answers
307 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
214 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
207 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 ...
18
votes
3answers
310 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
778 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
554 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
148 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
885 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
80 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 ...