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

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. ...
3
votes
0answers
61 views

More generic tool than TeXdoc?

I'm wondering if there is a more generic tool than TeXdoc to browse (and generate) documentation. With TeXdoc, one retrieves (as far as I know) the documentation .pdf of the package. This requires ...
2
votes
3answers
174 views

Where is the documentation?

Where or how do I find the documentation for a given Latex command? For example, in R I get the documentation for mean() with ?mean or at the manual pages ...
11
votes
1answer
172 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 ...
1
vote
1answer
90 views

How to obtain the source latex code of package documentation?

Is it possible to obtain the source latex code from package documentation? For example, I don't see the documentation latex file among siunitx source files.
2
votes
0answers
139 views

New to ConTeXt, looking for better manual than PRAGMA

I am an experienced user of LaTeX learning ConTeXt. However, I find the manuals on the PRAGMA website to be less than ideal. Does anyone have a suggestion for a manual or text?
87
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 ...
6
votes
2answers
1k views

Documentation of lmodern package?

Recently I have faced some problems with lmodern package. I wanted to read the documentation to educate myself of possible parameters that can be specified when using the package, and what I can do ...
20
votes
1answer
3k 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 ...
0
votes
1answer
49 views

Bibtex Internals

I would like to make modifications to my bibtex title, and this can be done by modifying \bibname. But when it comes to reducing the amount of space between the title "Bibliography" and the entries ...
4
votes
2answers
165 views

Unable to find the documentation of TikZ/PGF 3.0

After upgrading to the latest version of TikZ/PGF I cannot access, using texdoc, the newer version of the documentation. When I invoke texdoc tikz it tries to open the version that used to reside in: ...
2
votes
1answer
253 views

linewidth and middlelinewidth options in mdframed: wrong information in the documentation?

In the documentation of the package mdframed 1.9b, the author says (p. 7) If you are working width framemethod=tikz or framemethod=pstricks the option linewidth is an alias for the option ...
6
votes
0answers
244 views

Origami package [closed]

Does exist a specific package to draw origami? Some example: http://goclom.net/origami-papier/origami-grue.aspx
6
votes
0answers
122 views

Rebuilding TikZ's pgfmanual.pdf [duplicate]

The following steps to rebuild TikZ's pgfmanual.pdf fail on Windows 7 64 bit using MikTex and bash shell: 1) cp -iar /c/opt/miktex_2.9/doc/generic/pgf . 2) cd pgf/version-for-luatex/en 3) ...
3
votes
1answer
1k 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.
36
votes
4answers
15k 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 ...
1
vote
0answers
28 views

Keyword-Based Documentation Help

When refering to shell commands and system calls, man provides a consistent, systematic, offline reference. The python interpreter's help command does the same for python. Does *tex have an ...
4
votes
1answer
722 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 ...
9
votes
1answer
98 views

Documenting new commands

Texstudio displays a popup code-completion window for new commands that can give cues about what parameter does what and provides an explanation of the methods: I'd like to do the same with my own ...
10
votes
1answer
179 views

How do I use l3docstrip?

I've got a bundle I'd like to properly document (and begin to release) that uses expl3 intimately, and it should be documented similarly to expl3 itself (as seen in texdoc interface3. I did a little ...
3
votes
3answers
154 views

Why do some TeX documents not use links in TOC?

I really love LaTeX (or TeX - I don't really know the difference. I only know that LaTeX is a superset of TeX). One reason why I like it is the automatic creation of links within a PDF document. I ...
31
votes
2answers
3k 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 ...
11
votes
1answer
273 views

Parsing commands with multiple optional arguments

Some LaTeX commands accept multiple optional arguments. Here are some examples: \makebox[<width>][<pos>]{<text>} \framebox[<width>][<pos>]{<text>} ...
5
votes
1answer
139 views

How can I create active hyperlinks for cross references in Texinfo DVI/PDF?

The Texinfo PDF manual has cross references as hyperlinks through the document. The cross references are presented in an attractive dark red colour. When I create a PDF from my own Texinfo source ...
5
votes
1answer
494 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 ...
2
votes
0answers
70 views

Incomplete package documentation in TeXLive 2012 on Ubuntu

I use MacTex 2012 on my laptop. On the desktop in our lab, I use TeXLive 2012 on Ubuntu 12.04. I noticed that some package documentations in Ubuntu are not as comprehensive as they are in Mac. To ...
8
votes
1answer
235 views

Make ltxdoc class use report as underlying class

The ltxdoc class, designed for documenting LaTeX source files, is based on the article class. Beyond a certain threshold, the documentation may need to be divided in chapters and another class, e.g. ...
6
votes
1answer
125 views

LaTeX Referenz in English

Not too long ago, I think it was at the beginning of November, the LaTeX Referenz by Herbert Voß was released for free, but its in German (am not saying its a bad thing). Are there any plans on ...
14
votes
2answers
843 views

PSTricks: What are the Learning Tutorials/Guides available for new users with hierarchical steps?

I am looking for materials for PSTricks learning in similar vein to Materials for learning TikZ I am always interested to learn PSTricks through our famous Just for fun PSTricks User animated ...
5
votes
1answer
136 views

LaTeX Documentation containing the classes and functions and definition for each

Is there a LaTeX Documentation similar to Java Documentation, showing the packages, the classes to use and a sample example?
4
votes
2answers
473 views

Emergency crash course on LaTeX

So, I wrote a document in LaTeX. Someone who doesn't know LaTeX and is a very busy person now has to edit it. Is there a crash course in LaTeX document? Aside from saying 'Ignore everything that ...
10
votes
1answer
131 views

Adding a manually installed package/program manual into `texdoc`

I have manually installed a package/program related to LaTeX (it's writer2latex aka w2l in this case). Is there a way how to make texdoc w2l open the PDF documentation of this package?
19
votes
1answer
332 views

Plain TeX online documentation/references?

I am a non-beginner plain TeX user, mostly typesetting cheat sheets for computer science. I own The TeXbook and have seen some TeX manuals for the compilers, such as pdfTeX manuals and so forth. My ...
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 ...
7
votes
2answers
671 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 ...
31
votes
5answers
696 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 ...
13
votes
2answers
1k views

Dummies Guide to TeX as a programming language

There are a lot of answers that are using a somehow cryptic syntax that I am not familiar with. Is there any Not So Short Introduction to TeX (like Not So Short Introduction to LaTeX) ?!
7
votes
1answer
389 views

Where to find LaTeX commands source code?

I would like to know where can I find the definition of an original command. That is, let's say I want to redefine the command \ref so when I type it, instead of showing just the number of the label ...
1
vote
0answers
163 views

Where do i get good quality (possibly free) templates in TEX for software development. [closed]

My documents include: Functionality Specification Software Requirement Specification Software manual High Level Design Document Configuration Management.... and so on Any TEX template for the ...
2
votes
0answers
72 views

Is there a `sty2dtx` for LaTeX3 syntax?

sty2dtx is a CLI tool to convert a commented style file into a Documented TeX file (dtx). It was written and works wonderfully for LaTeX2e packages, but expl3 offers a lot of happy times for package ...
3
votes
2answers
128 views

Latex info help on Ubuntu?

If this is better as an Ubuntu question, I'll direct it there. Anyway, as a diehard emacs/AucTeX user I'm used to opening up latex-info (which uses GNU texinfo) for quick confirmation or reminder on ...
3
votes
0answers
99 views

Is there an implementation of WEB/NOWEB for LaTeX?

The WEB system is great, but it's a little cumbersome sometimes and very much rigid in its design. Is there a LaTeX document class for WEB-style documents? I'd like to program in other languages than ...
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. ...
3
votes
0answers
108 views

Highlight LaTeX code and presenting results as in a manual [duplicate]

I would like to write a short guidelines of LaTeX for my students. In the spirit of some LaTeX manuals, I'd like to present the code and the result as follows, This example illustrate more or less ...
3
votes
1answer
158 views

Errata in the Manuals

After discovering quite a few errata in a to-be-anonymous manual, I really want to be helpful and point them out... Is it appropriate to email the maintainer with a list of errata and inherently ...
14
votes
3answers
718 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 ...
2
votes
1answer
573 views

Technical documentation class

I just made a component that is going to be added to our platform in the next month. As such I need tu draw out some documentation for the guys that will do the integration. Is there any class that ...
3
votes
1answer
111 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 ...
4
votes
1answer
332 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 ...
9
votes
2answers
165 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 ...