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

2
votes
2answers
39 views

How to write R formulas

The R language has formulas of the form (y ~ x) and (y ~ x + z). I have come to know that \tilde doesnt do the trick. How can I write these formulas in latex?
0
votes
0answers
33 views

A template for documentation for ctan

I got my Fill-Pages-Package (hopefully bug free) ready, which is my first package. Now I want to upload it on ctan. But first there must be a documentation. I've been searching for a template for the ...
8
votes
2answers
169 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 ...
7
votes
2answers
44 views

Where is the local.tex file described in lshort.pdf present on a Debian system?

In the lshort.pdf book, Preface section, page vi, the following lines are present. LaTeX is available for most computers, from the PC and Mac to large UNIX and VMS systems. On many university ...
0
votes
1answer
25 views

\envitem in ltxdockit package prints curly braces in a different font

I've written a small LaTeX package and am preparing its documentation using ltxdockit package. I found a strange behavior about font. Consider the following MWE. \documentclass{article} \usepackage[...
4
votes
1answer
27 views

How to set macrocode using the listings package

When writing a dtx file, is it possible to typeset the code samples (i.e., everything enclosed in a macrocode environment) using the listings package? For completeness, here's Joseph Wright's model ...
1
vote
2answers
59 views

tlmgr open documentation for <package>. BasicTeX

I know it's convenient to install packages with tlmgr install <package>, but I couldn't find a way to open the documentation of the respective package; I know it installs them, I can manually go ...
4
votes
1answer
79 views

How does CONTEXT's auto-generation of code documentation work?

Unlike LaTeX's core, CONTEXT core macros have quite readable code and, specially in the lack of up-to-date documentation for certain commands, one can learn a lot by just reading the code itself and ...
45
votes
1answer
3k 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 ...
6
votes
1answer
121 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 ...
2
votes
1answer
30 views

what is wrong with the code of the figure?

\documentclass[11pt]{article} \begin{document} \begin{figure}[H] \centering \includegraphics[width=10mm]{penduloPlano.png} \caption{Rota\c{c}\~{a}o do suporte ocorrendo a manuten\c{c}\~{a}o do plano ...
6
votes
0answers
104 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 ...
1
vote
1answer
51 views

Documentation search does not work through right-click in TeXstudio

I'm relatively new with LaTeX and I can't find the solution to a problem I came through only recently. I'm using TeXLive 2015 with the editor TeXstudio, which I updated to the most recent version (2....
1
vote
0answers
40 views

problem with page numbering

I'm using book documentation and the page number shown in top right, and that is exactly what I need. my problem is the first page, the number shows in bottom center. why did this happen?
0
votes
0answers
23 views

What does the function \foo do? [duplicate]

When I encounter a command in a LaTeX file, how can I see what that command does? Naturally, I can sometimes modify it and recompile. But this might result in an error, or the differences might be ...
91
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 &...
2
votes
0answers
78 views

Manual of the angles tikzlibrary [closed]

I would like to learn some commands of the angles tikzlibrary. I have been looking on the internet for its manual but so far I couldn't find any documentation. Can anybody help me please? Thank you so ...
2
votes
1answer
58 views

What's the command to pull up a package's manual? [duplicate]

I am running MacTex (on my Mac, obviously) and I remember I used to use a command a lot in the Terminal to simply open up the manual for a specified package. Something like this, for example: manual ...
6
votes
1answer
48 views

l3doc adds unwanted backslash in margin box of {function}

I'm using l3doc for documenting some packages (I know it is not officially stable, but I like it …). I came to the problem that {function}{<list>} adds a backslash for every item in <list> ...
9
votes
1answer
150 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 ...
2
votes
0answers
47 views

Where do I find an authoritative reference material containing \string and others?

The best documentation on \string that I found was https://en.wikibooks.org/wiki/LaTeX/Plain_TeX#Special_control_sequence_name I searched the following materials, but they didn't explain \string. ...
17
votes
4answers
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 ...
68
votes
12answers
4k views

Best practices references

What resources (online or otherwise) exist that give good advice on best practices for TeX, etc.? I'm looking particularly for things that assume you already know TeX or LaTeX, and aim to help you ...
1
vote
0answers
202 views

Reference of Latex/Plain Tex control sequences [closed]

I'm looking for a reference of the control sequences defined in Latex and plain Tex similar to this one for the build-in primitives. The Texbook states that there are about 600 macros in plain Tex. ...
23
votes
3answers
2k 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
2answers
416 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 ...
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, ...
5
votes
0answers
73 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". ...
4
votes
1answer
134 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 it....
4
votes
1answer
71 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 ...
6
votes
3answers
164 views

What is the quickest way to open the pdf-manual for a given tex function or program?

Say I want to open the PdfTeX manual in PDF-format for reading on my screen. Or maybe get information about nicefrac. I don't want to locate xxx in the terminal ... What is the quickest way to open ...
1
vote
1answer
22 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 all....
2
votes
1answer
23 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
38 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
3k 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 ...
1
vote
1answer
159 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 ...
6
votes
2answers
590 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} \begin{...
10
votes
2answers
238 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 ...
8
votes
1answer
132 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
249 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
67 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} \begin{...
12
votes
3answers
379 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
81 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
144 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} ...
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
157 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
167 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
933 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 ...