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

0
votes
1answer
18 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} ...
4
votes
1answer
23 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 ...
4
votes
1answer
71 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 ...
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
95 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
0answers
39 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 ...
1
vote
2answers
52 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 ...
1
vote
1answer
47 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
votes
0answers
72 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
56 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
112 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
47 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> ...
2
votes
0answers
44 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. ...
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
163 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
21 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
22 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
37 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 ...
1
vote
1answer
152 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 ...
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
1answer
127 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 ...
6
votes
2answers
511 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} ...
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} ...
4
votes
4answers
242 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 ...
11
votes
3answers
362 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
80 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
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} ...
0
votes
1answer
63 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, ...
5
votes
1answer
159 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 ...
4
votes
5answers
503 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} ...
0
votes
1answer
60 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 ...
4
votes
1answer
122 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 ...
6
votes
1answer
123 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
201 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
590 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
315 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
45 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 ...
2
votes
1answer
240 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 ...
2
votes
1answer
151 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. ...
0
votes
1answer
44 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
443 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 ...
7
votes
1answer
345 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
229 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
262 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.
1
vote
3answers
532 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 ...
3
votes
0answers
65 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
180 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 ...
2
votes
1answer
91 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?
1
vote
1answer
105 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.