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

10
votes
1answer
105 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?
53
votes
6answers
4k views

Materials for learning TikZ

I feel intimidated in learning TikZ. I was wondering if there are some nice materials (or just your replies) at different level: for providing big picture, which is important to beginners to not ...
18
votes
1answer
271 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 ...
6
votes
2answers
594 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
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 ...
11
votes
2answers
430 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) ?!
6
votes
1answer
213 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 ...
0
votes
0answers
97 views

Creating API document

Is there a Latex reference on how one should go about creating an API document? I've done some searching and mostly what I've found is using an existing API document (like a Java doc) and creating a ...
1
vote
0answers
114 views

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

My documents include: Functionality Specification Software Requirement Specification Software manual High Level Design Document Configuration Management.... and so on Any TEX template for the ...
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 ...
2
votes
0answers
57 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
106 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
77 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 ...
68
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 ...
8
votes
1answer
118 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
127 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
620 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
287 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
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 ...
8
votes
1answer
168 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
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.
13
votes
6answers
2k 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 ...
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 ...
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 ...
5
votes
3answers
282 views

Online references for creating advanced macros?

I am looking for online references for creating advanced macros for LaTeX.
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 ...
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
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 ...
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 ...
28
votes
2answers
2k 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
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), ...
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, ...
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 ...
8
votes
1answer
877 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 ...
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 ...
7
votes
1answer
353 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
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 ...
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 ...