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

61
votes
6answers
6k 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 ...
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 ...
0
votes
1answer
65 views

wrong placement of figure in document

I want to insert the logo of my company at the beginning of the page(document). Here is the code for the same. Unfortunately, it spills over to the next page. \documentclass[paper=a4, fontsize=...
2
votes
1answer
158 views

texdoc finds no results for any package

Whatever package name I use when invoking texdoc, I get no results. Which seems to indicate that something is missing from the setup. I made sure that several documentation packages are installed. ...
5
votes
1answer
170 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 ...
48
votes
6answers
942 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 ...
13
votes
6answers
12k views

Writing manpage / reference manual for software in LaTeX

Is it a good idea to write your software manual pages (manpages) / reference manuals using TeX? I'm new to TeX and exploring my options around this. I'd be able to deliver a manpage.pdf along with ...
4
votes
5answers
581 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
1answer
131 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 ...
0
votes
1answer
67 views

Compiling documentation of a package

I have extracted the documentation of the longtable package and I want to compile it alone. By extracting the documentation I mean that I have copied the .dtx file from the \maketitle to the end and I'...
6
votes
1answer
131 views

ifpdf prematurely terminates iffalse

I have the following minimum code stored inside the file.dtx file: % \iffalse % \begin{macrocode} %<*driver> \documentclass{ltxdoc} \usepackage[utf8]{inputenc} \usepackage[english]{babel} \...
1
vote
1answer
215 views

Where can I find WinEdt 9.0 documentation?

I'am making a little tutorial about LaTeX and one of tutorial is about WinEdt. Where can I find WinEdt 9.0 documentation or manual about WinEdt 9.0 complete. And only found old documentation like ...
6
votes
1answer
668 views

Where is the documentation for the current textcomp package?

If I Google for "latex textcomp documentation", the most relevant hit is the CTAN textcomp page, which says: Note that the pack­age has been adopted as part of the LATEX dis­tri­bu­tion; the ref­...
4
votes
1answer
342 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?
0
votes
1answer
46 views

Where can I find the resources to create a preview progam like qtikz?

Writing tikz code can take a lot of time especially if there are a lot of figures that I want to code in LaTeX. As such, I think it would be a good side project to write a photoshop-like program to ...
3
votes
1answer
244 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 MiKTeX),...
2
votes
1answer
255 views

Is there a programming language/API like documentation for common LaTeX packages (like amsmath)?

I just tried to figure out limitations (in a very abstract manner of the \sqrt makro in math package of LaTeX. Even after reading http://bay.uchicago.edu/tex-archive/macros/latex/required/amslatex/...
0
votes
1answer
47 views

Can \GetFileInfo read \ProvidesLanguage?

I am not sure but it seems to me that \GetFileInfo used for documentation of .dtx files ignores \ProvidesLanguage from the babel system. Why?
10
votes
3answers
462 views

Extracting the structure of a LaTex document, including comments

I like to write a "special" comment with a title at the beginning of each paragraph in my documents, something like this: \section{Introduction} % 1.0 Visually tracking balls is an interesting ...
1
vote
3answers
564 views

Tex Live 2014 full installation does not have documentation files

I installed the Full scheme of Tex Live 2014 with install-tl on RHEL 5. I find that it no longer has the texdoc-accessible PDF documentation. Am I missing something? Or is excluding the ...
7
votes
1answer
374 views

Documentation Generator for LaTeX

Is there Documentation Generator for LaTeX like Javadoc for Java or Doxygen for C++? Especially when defining macros or environments for LaTeX-files throughout a big project it would be useful for ...
4
votes
2answers
253 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 ...
2
votes
1answer
274 views

Export LaTeX to HTML for simple documentaiton

how is the best option or program to export LaTeX to HTML and upload to the web? I tried LaTeXtoHTML but I am not convinced. Now I am using TeXmaker for my documentation.
2
votes
1answer
93 views

Documenting a latex package from comments

I have just completed writing my very own LaTex package, how can i make the package to be self documented like maybe from comments in the package code?
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
67 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
182 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 http://stat.ethz.ch/R-manual/R-patched/...
11
votes
1answer
182 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
119 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
144 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?
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 ...
21
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
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
171 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
360 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
350 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) ...
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.
38
votes
4answers
17k 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
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 equivalent?...
4
votes
1answer
914 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
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
193 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 ...
32
votes
2answers
4k 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
291 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>} \parbox[<pos&...
5
votes
1answer
160 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
508 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
76 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
296 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. ...