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

1
vote
1answer
9 views

README file creation from a dtx file

When I run my dtx file, I get a README file with all the information, but there are no (apparent) line feeds in it. If I look at it with Notepad, everything is strung along with no line breaks at ...
2
votes
1answer
18 views

Why does cnltx-doc throw unknown options away?

I'm looking at packages to document packages. cnltx-doc looked nice, so I thought I'd try it. However, it does this: \ProcessPgfOptions{/cnltx-doc} \let\@classoptionslist\relax \LoadClass{scrartcl} ...
3
votes
0answers
20 views

How should doctools be used with a standard class?

I am exploring the possibility of using doctools to document a package. According to the documentation, it can be used either in a .dtx file, when doc.sty is loaded, or in an ordinary document, when ...
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 ...
45
votes
1answer
2k views

Glossary of TeX and LaTeX terms

This is not about glossary package. :-) I was wondering whether there is a list of common terms you come across as a not-so-advanced user, defined already. Currently what we have are many books ...
1
vote
1answer
92 views

“Show Help for Package” in TeXShop not working

I have BasicTeX installed on my Mac, which I'm running through TeXShop (TeXShop 3.51 and TeX 3.14159265 (TeX Live 2014)). If I go to the Help Menu, select "Show Help for Package", enter the name of ...
4
votes
2answers
148 views

Plot file could not be opened

The following code is from the "gallery of examples in the manual - PGFPlots". \documentclass{article} \usepackage{pgfplots} \pgfplotsset{compat=newest} \pagestyle{empty} \begin{document} ...
10
votes
2answers
212 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 ...
23
votes
2answers
1k views

Where is the LaTeX manual?

Helpful members of the community just solved my problem with \newcommand: What's wrong with my newcommand? But in trying to solve it, I got an error message referring to p. 192 of "the manual". ...
8
votes
1answer
103 views

What is the most effective and efficient way to document a package?

I'm sure this must be a duplicate but the questions I've found don't quite address the question I have. Related questions include: How to modify package documentation How to document style files ...
4
votes
4answers
209 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 ...
1
vote
1answer
58 views

Describe Icons similar to \DeclareMacro

I would like to describe icons in a column- or table-wise layout. In my opinion a table is not the best tool for this task: \documentclass{scrreprt} \usepackage{blindtext, longtable, tabu} ...
10
votes
3answers
287 views

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

UPDATE: I've opened a follow-up question: How can I typeset an environment and its literal equivalent in an environment? I would like to pass a command and arguments to an environment. The output ...
0
votes
0answers
68 views

What is the most efficient way to make a LaTeX manual similar to the PGF/TikZ Manual?

I would like to create a manual for my Preamble describing various packages and relevant functions for my work. I like the layout of the PGF/TikZ manual. I think it would be a good start to mimic its ...
0
votes
0answers
70 views

Is there a good way to automatically generate a list of commands/environments defined in the preamble?

Background I have seen beautiful manuals with commands and descriptions of what they do. I have a shared preamble (edited by multiple people and used for multiple documents) that has a multitude of ...
3
votes
2answers
108 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} ...
58
votes
6answers
5k 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
118 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
53 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, ...
2
votes
1answer
98 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
101 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 ...
47
votes
6answers
830 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 ...
12
votes
6answers
9k 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
240 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
90 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
54 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 ...
6
votes
1answer
101 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
138 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 ...
5
votes
1answer
151 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 ...
4
votes
1answer
192 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
42 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
229 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 ...
2
votes
1answer
116 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 ...
0
votes
1answer
40 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
357 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
366 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
217 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
144 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
230 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
86 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
58 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
169 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 ...
16
votes
1answer
813 views

Who wrote “What are TeX, LaTeX, and friends?”

Who wrote What are TeX, LaTeX, and friends? I want to reference it in my article.
11
votes
1answer
167 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
73 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
131 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
60 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". ...
83
votes
6answers
5k views

What is the minimum one needs to know to use TikZ?

I am fed up with the poor quality of the pictures in the papers written by my graduate students and am trying to convince them to use TikZ. I know of three ways to begin learning TikZ: The TikZ ...
5
votes
2answers
897 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 ...