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

6
votes
1answer
1k 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
3answers
155 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 ...
6
votes
1answer
108 views

Is there a TikZ and PGFplot HTML manual online?

This builds up on the question TikZ manual newest version online?: I know where to find the latest version of the TikZ (or PGFplots, or ...) manual online, in PDF form. But sometime, answering to a ...
6
votes
1answer
691 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 ...
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 ...
6
votes
0answers
81 views

ConTeXt: Font weights

Is there a canonical way to access font weights other than regular and bold in ConTeXt? This does not work: \definefontfamily [myfamily] [serif][Calluna] \definefontfamily [myfamily] [sans] [Calluna ...
6
votes
0answers
332 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) ...
5
votes
3answers
348 views

Online references for creating advanced macros?

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

\inputencoding{latin1} cannot be used in the user documentation of a .dtx file if it is \DocInput

Third edit: (As pointed out by Ulrike, my problem in fact doesn't concern listingsutf8 but only inputenc, so I reflect this by giving to the question another title and another MWE.) The following MWE ...
5
votes
1answer
143 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?
5
votes
1answer
254 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 ...
5
votes
1answer
124 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 ...
5
votes
1answer
502 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 ...
5
votes
1answer
105 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 ...
5
votes
1answer
393 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.?
5
votes
1answer
148 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
0answers
72 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". ...
5
votes
0answers
906 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 ...
4
votes
3answers
316 views

Where can I find the standard LaTeX reference manual?

Like a semi-detailed user manual for LaTeX commands (\newtheorem, etc).
4
votes
2answers
4k 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 ...
4
votes
4answers
238 views

How can I typeset an environment and its literal equivalent in an environment?

This is a follow-up to the question: How can I typeset a command and its literal equivalent in an environment? It would obviously be useful to handle environments too. I imagine something like the ...
4
votes
5answers
468 views

\thanks{} footnote indented when using amsart and doc

When using the amsart document class in combination with the doc package, I get an extra indent in the thanks footnote of the first author: \documentclass{amsart} \usepackage{doc} \begin{document} ...
4
votes
2answers
621 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 ...
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: ...
4
votes
1answer
308 views

Where is CWEB tutorial?

I'm looking into webruby or cweb to write the documentation of my project. Is there a plugin to eclipse or other gui system?
4
votes
2answers
525 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 ...
4
votes
1answer
2k 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.
4
votes
2answers
216 views

Where can I find the manual for the standard class article of LaTex?

I have been looking for THE manual for using class 'article' in LaTex. The official CTAN package site points to some documentation which actually is 'an introduction to writing classes and packages ...
4
votes
1answer
340 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 ...
4
votes
1answer
379 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 ...
4
votes
2answers
181 views

What is with the unsightly overlap at the top of the index pages in source2e.pdf?

I notice that in source2e.pdf, the Index section has a running header that intersects with the top of the main text on each page, like so: (Actually, this seems to happen with some other sections, ...
4
votes
1answer
70 views

Is there a quick (command line) way to find out which style file needs to be used for a command (without using an Internet connection)?

So far, whenever I needed to know where exactly a command (or my fuzzy concept about some specific task) has been defined, I have used a search engine to find it out. But if I know about the ...
4
votes
1answer
118 views

How to modify latex package documentation

Let's say I want to modify the documentation of certain package. I download the .dtx and .ins files and I see that the documentation is in the .dtx file but it's commented. If I compile the .ins file ...
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.
4
votes
1answer
811 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 ...
4
votes
1answer
84 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 ...
4
votes
1answer
696 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 ...
4
votes
1answer
133 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 ...
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 ...
3
votes
2answers
3k 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 ...
3
votes
1answer
172 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 ...
3
votes
1answer
238 views

The cross-reference boxes in TeX: the program

You know those boxes at the bottom of the right-hand pages in Volume B? Well, I managed to weave mf.web by stealing the weave binary from a distribution where it actually works (it doesn't in ...
3
votes
2answers
140 views

Hyperref breaks the index generated by the ltxdoc document class

Suppose the following minimal document: \documentclass{ltxdoc} \CodelineIndex \EnableCrossrefs \begin{document} \DescribeMacro{\macro} A description of \cs{macro} \begin{macrocode} ...
3
votes
1answer
244 views

Brown paper strip on page 125 of The METAFONTbook

I've borrowed a copy of The METAFONTbook from my school's library, and I'm wondering why there is a brown paper strip glued to page 125 between the text and the rings. I couldn't help but wonder if ...
3
votes
1answer
122 views

How do I read the texdoc for the letter document class?

I am reading the texdoc for the letter document class. But it doesn't say anything about getting started. I think this is a commented source code document. Yes, it lists all the features of the letter ...
3
votes
2answers
131 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
2answers
679 views

Where do I find the pgf manual v2.00?

This might be a very stupid question, but I don't manage to find the pgf manual v2.00. On CTAN I only found v2.10. (I'd like to find it because I want to follow Andrew's comment to this great answer.) ...
3
votes
1answer
121 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
87 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 ...