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

4
votes
1answer
312 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
309 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
228 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
215 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 ...
19
votes
3answers
323 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
810 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
584 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
152 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
1k 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 ...
15
votes
2answers
886 views

What font configuration is used by microtype documentation

I really like the font configuration (appearance) of the documentation for microtype package (see here). How do I find out the combination they're using? (I will fix the protrusion etc later but first ...
13
votes
1answer
412 views

How to write a user manual for a class in two languages?

Most classes and packages on ctan, offer a .dtx file, which when processed will automatically produce a user manual. In most cases such classes use the author's mother language. As for example yfonts ...
3
votes
2answers
464 views

What documentation on octavo is available?

Compared with other document classes, the documentation supplied with octavo on CTAN is very short. Does this documentation really provide the list of custom options and special commands used with ...
7
votes
1answer
280 views

How to output math environment code alongside typeset math?

I have a preamble which defines lots of symbols and a LaTeX document for testing them. In particular, I have source like this: \[\wlength{abc} = 3\] \[\lang{A} = \lang{\varphi}\] \[\kplus{L} \defeq ...
6
votes
1answer
435 views

LaTeX documentation with verbatim environment

I am trying to document some LaTeX macros concerning marginals. I think a good way for the documentation would be the LaTeX code on the verso page and the output on the recto page. So I came up with ...
13
votes
3answers
308 views

Comprehensive online manual for LaTeX2e user macros and environments

I find myself sometimes in the position that I need to know the "official" syntax and behavior of LaTeX2e user macros or environments. I'm talking about common things like minipage. Usually I find ...
15
votes
1answer
551 views

Automatic linking (aka code highlight) in Till Tantau's `codeexample`

I am writing docs for a tikz-based package, and I am trying to reuse Till Tantau's codeexample environment to output source code along with its output. However, I cannot manage to get syntax ...
5
votes
1answer
344 views

Creating a software manual. Any supporting packages?

So I am about to start writing a manual for a piece of software. Are there any packages available to depict radio buttons, check boxes, tabs, menus etc.?
6
votes
3answers
283 views

How to search a documentation about an tex-function in command-line way on linux?

How can I search things about some functions in LaTeX on Linux in the command-line? Tried texdoc, but texdoc cite, for example, don't works. I would like a tool to search about LaTeX functions in ...
5
votes
3answers
304 views

Online references for creating advanced macros?

I am looking for online references for creating advanced macros for LaTeX.
5
votes
1answer
712 views

Packages for documenting self written packages (sty-files)

I am looking for packages useful for creating a documentation for a self written package. I have found doc, but the documentation ltxdoc.pdf did not give me any useful example. Also I know of ...
6
votes
2answers
624 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 ...
3
votes
1answer
84 views

doc.sty: Print codelinenumbers in index in tt font?

Is it possible to print the index numbers which are referring to a code line number instead of a page in typewirter font. I know that I can change \main, but on this way I can’t change the format of ...
6
votes
3answers
144 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 ...
11
votes
2answers
269 views

hyperref causes problem with doc.sty

Try the following code. Without hyperref everything is fine and there’s the right entry in the index. With hyperref this entry disappears. (The codeline entries which are not shown here ar not touched ...
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 ...
47
votes
6answers
793 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 ...
1
vote
1answer
225 views

Is Tex/LaTex appropriate for my situation

Is TeX a good idea for my current situation? I'm currently maintaining documentation for a piece of software, so I came up with my own .doc template with the official company header/footer. Since ...
29
votes
2answers
843 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 ...
30
votes
2answers
2k 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 ...
16
votes
2answers
810 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?
20
votes
1answer
2k 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 ...
4
votes
1answer
585 views

LaTeX resources for non-technical writing

I have read dozens of tutorials on creating LaTeX documents. All of them have one thing in common: they all focus on writing a technical thesis or a math paper of some sort. I'm a programmer and I ...
7
votes
2answers
624 views

Where can I find an online manual for low-level LaTeX commands?

Is there an online manual for low-level LaTeX commands I can download? I am looking for something which would have, for example: \newif\ifportrait \newif\ifcustomsize \newif\ifdebug \makeatletter ...
6
votes
2answers
2k views

Maintained version of tikz documentation

Is there maintained version of tikz and pgf documentation? The webpage doesn't state any but this file (pdf} is very useful.
2
votes
1answer
329 views

Running the animate package documentation

I downloaded the tex file for the documentation of animate package by Alexander Grahn and tried to run it on MikTeX instead of giving me the PDF output it generate the following error: ! LaTeX Error: ...
4
votes
1answer
120 views

What is `/utils/exec` and where do I find it's documentation

In response to this question on using a conditional to define a TikZ style it was suggested to use /utils/exec. It is easy to find uses of this, but I have not been able to locate documentation on ...
6
votes
1answer
227 views

Where can I find the documentation for `lstdoc`?

It appears that the listings package provides another package, called lstdoc, which in some unknown fashion provides facilities for printing TeX code samples while simultaneously TeXing them into the ...
4
votes
1answer
463 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 ...
57
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 ...
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.
13
votes
2answers
561 views

Is there a list of general use LaTeX kernel macros?

Here are a few cases in which one could use such a list: Is there a "prepend" version of \g@addto@macro? A "local" version? What's the most efficient way of gobbling n characters? Can I use LaTeX's ...
21
votes
1answer
916 views

How do I document my style files?

I have many style files (and one or two class files) that I've written in my local texmf tree. Most were simple things that got me out of some trouble and which I put in to a style file in case I ...
2
votes
1answer
558 views

TikZ option for command or environment

I am learning TikZ. I am wondering where I can find information about options of command or environment. For example, for \draw, you can use \draw[step=0.5], but it also has ...
14
votes
3answers
1k views

Google searching LaTeX commands?

Q: How can I best search the web for exact LaTeX commands (e.g., \show as opposed to show)? It appears that Google will not allow us to escape the \ character. So, searches for \show are interpreted ...
7
votes
4answers
551 views

LaTeX equivalent to R's `help foo`?

From the R command line I can do help foo -- where foo is some R command-- and return a .html help file on foo. This holds even if foo is from some non-standard library I just loaded. Q: What's the ...
8
votes
2answers
384 views

An MS command line equivalent to Linux's “man” for help on Latex files?

Is there an MS DOS command line equivalent to Linux's "man" for finding help on Latex files? e.g., if I were running Latex on Linux I could do: man texify to discover a file like this, from which ...
13
votes
2answers
4k views

Does anyone know a good XeTeX tutorial?

I want to use XeTeX so that I can use a particular font, but I'm not quite sure about the documentation/commands in specifying this font in XeTeX. Can anyone point me to a good how-to tutorial on ...