{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
0answers
141 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?
5
votes
0answers
73 views

Good resources to understand how LaTeX is constructed layer after layer? [duplicate]

I have been a user of LaTeX for a couple of years now, and I would like to start to be involved in the writing packages. The problem is that currently, a lot of things appear to me as "black magic". ...
10
votes
1answer
129 views

How do I set the documentation PDF for my package?

I wanted to check the syntax of something in one of my packages, and rather than hunt for the file on my system I just did texdoc hobby on the command line. To my dismay, this brought up the PDF ...
6
votes
2answers
2k 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 ...
0
votes
1answer
53 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
169 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
322 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
335 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) ...
1
vote
0answers
29 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 ...
1
vote
0answers
190 views

Reference of Latex/Plain Tex control sequences [closed]

I'm looking for a reference of the control sequences defined in Latex and plain Tex similar to this one for the build-in primitives. The Texbook states that there are about 600 macros in plain Tex. ...
9
votes
1answer
100 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
187 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 ...
11
votes
1answer
286 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>} ...
2
votes
0answers
73 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
272 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. ...
5
votes
1answer
145 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?
6
votes
1answer
126 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 ...
4
votes
2answers
546 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 ...
14
votes
2answers
943 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 ...
10
votes
1answer
140 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?
5
votes
1answer
150 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 ...
1
vote
0answers
176 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 ...
7
votes
1answer
446 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 ...
14
votes
2answers
2k 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) ?!
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 ...
19
votes
1answer
355 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 ...
3
votes
0answers
103 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 ...
3
votes
2answers
132 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
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 ...
9
votes
1answer
148 views

Where are the sources for LaTeX3 development in TeX Live?

I'd like to take a look at the sources for some of the LaTeX3 development to model after, but I'm having trouble finding them. Where might I find the sources for texdoc interface3, texdoc xparse, and ...
3
votes
1answer
173 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 ...
2
votes
1answer
646 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 ...
10
votes
2answers
238 views

Where can I find a manual for learning the fundamental background of LaTeX source?

I would like to know if there is some manual from which I can learn the bases of LaTeX programming language. I need something universal, not related to some specific package or class, that at the end ...
3
votes
1answer
123 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
347 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
167 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 ...
8
votes
1answer
121 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
76 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
176 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} ...
5
votes
0answers
926 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
149 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
939 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
181 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
597 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
837 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
719 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
278 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, ...
7
votes
1answer
175 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), ...