Questions tagged [documentation]

{documentation} is about the writing of *TeX package documentation and packages designed for documenting *TeX code, e.g. ltxdoc.

Filter by
Sorted by
Tagged with
1
vote
0answers
23 views

Where can I find a description of the tldrm format?

I have not found anything but some old references from texlive mailing lists. Just want to figure out the format, especially functions like RELOC.
1
vote
0answers
74 views

Big list of beautifully typeset package documentations

Being just a LaTeX user, I have to look up documentation very often. What could be easier than texdoc packagename and here it is. The other day I opened for curiosity the scontents package and was ...
2
votes
1answer
42 views

What is the default 3D viewing angle in pgfplots?

I am trying to create a sphere in pgfplots 3D but creating a smooth sphere is computationally expensive and Overleaf does not have sufficient rendering time in order for such a large sampling ...
31
votes
1answer
1k views

The definitive guide to ConTeXt MkIV documentation

On the mailing list (sign up, do it!) and on TeX - LaTeX Stack Exchange (abbr.: TeX.SX) I often read the complaint that the ConTeXt documentation is bad/old/incomplete. I wholeheartedly disagree. ...
6
votes
1answer
362 views

Is there an implementation of WEB/NOWEB for LaTeX?

The WEB system is great, but it's a little cumbersome sometimes and very much rigid in its design. Is there a LaTeX document class for WEB-style documents? I'd like to program in other languages than ...
43
votes
6answers
27k 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 ...
9
votes
1answer
189 views

Where to find an interactive PDF or HTML version of the tex.web documentation?

I have problems with the memory management of an eTeX created with Jim Fowler's TeX's pascal to javascript compiler web2js as soon as I want to dump the eTeX format etex.src with more than only "...
6
votes
3answers
169 views

Resources for learning Lua programming

I saw power of LuaLaTeX through several examples on the TeX Stack Exchange site. Could you suggest some books or other resources to learn Lua programming? I want to learn about variables, loops, ...
5
votes
1answer
122 views

\string-primitive works in unexpected ways in LuaTeX — Where can I find exact documentation of the \string-primitive in LuaTeX?

Where can I find exact documentation of the \string-primitive in LuaTeX? I ask this question because I encounter some unexpected (at least by me) behavior when compiling the example below with LuaTeX....
1
vote
1answer
33 views

Question on Reference Style with apacite (APA style) for User's Guide

I am trying to make reference using APA style (apacite) with bibtex. The User guide that I want to add on is not computational software manual. It is manual for flow sensor. So I wanna take out [...
1
vote
1answer
89 views

How to write the documentation for my own class [closed]

Some time ago I started to create my own class and these moments my purpose is to create the documentation. I would like to know if to create the documentation of my class I should be guided by this ...
1
vote
0answers
52 views

Best tutorial learn bottom-up how to format biblatex-citations [duplicate]

After years with LaTeX, I need to take control over the output formatting of my citations in various projects. I've referred to the manual as well as the otherwise excellent tame the BeaST but I'm ...
2
votes
1answer
46 views

Package for creating installation manual?

I want to create a installation manual for users. My general structure is, that i want separated steps and at each step I want on the left an image/screenshot and and on the right column a description....
5
votes
1answer
227 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. When I create a PDF from my own Texinfo source files, the DVI file does not contain active links, though the cross ...
3
votes
2answers
553 views

Template for Technical Manual / User's Guide using Memoir

I am making a Technical Manual using the memoir Class, since I heard it is very customizable. Far now I've got this: \documentclass[8pt,a5paper]{memoir} \usepackage[utf8]{inputenc} \usepackage[...
2
votes
1answer
173 views

TikZ : “what to draw” vs “how to draw”

I have been using TikZ in drawing scientific figures for almost 2 years, and like it very much. I can say several good things about TikZ: simple and natural syntax, good documentation, drawing in ...
1
vote
1answer
40 views

Word wrap 64 character hexadecimal strings in verbatim JSON

I'd like to document example requests/replies in our protocol per How to write narrative documentation. We're using the texlive-latex-base on Ubuntu for our documentation, and I'm linting with lacheck ...
8
votes
2answers
1k views

Online searchable manual for TikZ?

Having used psTricks for years, I'd though I'd drag myself into the modern era and start using TikZ. So far, I like it very much. However, the only manual I can find is the 500+ page PDF manual, ...
81
votes
8answers
10k 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 lose ...
1
vote
2answers
208 views

Explaining function calls in latex (syntax)

I have a software product with an public api, which i want to documentate in LaTeX. The output should look like the following FunctionName(type1 param1, type2 param2 [, type3 param3] ...) param1: (...
1
vote
1answer
166 views

Typesetting matrix multiplication

Here's a very general question: how would you guys write out a tutorial on matrix multiplication? Maybe with indicative arrows in order to show which line associates with its correspondent column, I ...
3
votes
0answers
68 views

Document Class (or Alternative Solution) for Documenting Programming Code

Different from writing a report or thesis involving code, I have the goal of producing a transcription of a C++ solution involving many projects with many .h and .cpp files. Furthermore, this document ...
1
vote
1answer
28 views

Garbled index with ltxdoc document class

When using the ltxdoc document class, index entries are misformatted, looking like this: foomacro= \subitem *+\foomacro+, \usage{1} rather than… however they’re supposed to look. This sounds like a ...
13
votes
3answers
952 views

Where can I find the list of the example images of graphicx?

The graphicx package has many example images, but where are they listed? I can't find this feature in the package documentation. \documentclass{article} \usepackage{graphicx} \begin{document} \...
1
vote
1answer
98 views

If one has package-related documentation notes, where are those posted?

Since they'd be something other than just MWE code examples, are those posted here or, say, on CTAN?
6
votes
2answers
609 views

How to create two box side by side in latex without using tikzlibrary

I want to write down this code in latex. I write down a code for this but it not properly displayed as per the picture. My code \indent\fbox{$\Sigma=\Omega^{-1}$ \\ $\mu=\Omega^{-1}\xi$} What ...
9
votes
3answers
392 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 ...
1
vote
1answer
129 views

If TeX / LaTeX modifies the spacing between individual letters

Wondering if there is any compression / expansion of the between-letter spacing done in TeX / LaTeX. In looking at the font specs, I noticed they only have 2 horizontal properties: advance width and ...
0
votes
1answer
92 views

Dictionary of Hyphenated Words in English

In reading about TeX's hyphenation algorithm, I found the tex-hyphen repo with a bunch of patterns listed (over 4,000 in that file). The answer on the hyphenation algorithm suggested that they compile ...
2
votes
1answer
324 views

If LaTeX tools implement the TeX features from scratch [duplicate]

I just asked about Documentation on the Algorithms or Techniques LaTeX uses for Text Layout, which lead to Alternatives to LaTeX which pointed out some tools such as ConTeXt. I also have heard of ...
1
vote
1answer
151 views

Documentation on the Algorithms or Techniques LaTeX uses for Text Layout

I am wondering how LaTeX implements its algorithms for laying out the text. How it figures out how to break a word in the mid-dle to better fit on the page, or how it slightly compresses the words to ...
3
votes
2answers
217 views

Standard pre-defined macros in LaTeX: where to find them all

I hope this question is not a duplicate, but I couldn't find anything here on tex.stackexchange. What I want is the place where all the macros already defined in LaTeX are. For example I know that ...
0
votes
1answer
116 views

Too much information scattered widely

Many questions on texSE have previously documented answers (for instance). The answers may be in published books (e.g The LaTeX Companion), the many user manuals, TUGboat, The PracTeX Journal, ...
4
votes
2answers
278 views

What happened to mathmode documentation?

There used to be a document distributed with TeXLive that contained a very nice description of the many different math modes, when they should be used, with examples of how to do it. I could easily ...
3
votes
3answers
305 views

How to change the font(size) for verbatim in ltxdoc

The MWE shows what I mean. Using class article I can change the verbatim font. Using ltxdoc nothing happens. I looked in doc.sty and ltxdoc.cls but found nothing. Why does the verbatim environment ...
7
votes
2answers
488 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.?
0
votes
1answer
70 views

How to find the source code of a package in my computer?

Time and again I am in the need of figuring out the arguments/options of a package, and more often than not I get very frustrated with the results I get online. Even worse, sometimes I get confused ...
5
votes
0answers
34 views

beamer, searching in beameruserguide [duplicate]

for reading and searching for some phrase in packages documentation i use Acrobat Reader DC. it works fine for all packages except for beamer. in it only occasionally i find searched phrase, mostly ...
19
votes
4answers
2k views

LaTeX, package documentation look-up

I am on OS X (10.6 Snow Leopard) using TeXLive-2011 to typeset a simple .tex file I am editing in Vim and trying to learn. My problem is: how do I... gradually learn about what TeX can do for me get ...
0
votes
1answer
228 views

Examples of Reusable Master Templates or Project Templates? [closed]

Are there any online examples of reusable Master Page or Project templates - that completely decouple complex layouts from content? Many of the examples I have seen show a single template document, ...
2
votes
1answer
91 views

multiple indexes in ltxdoc

I want to use multiple indexes in ltxdoc. But if I use the package imakeidx my defined "General Index" disappears and I get the standard "Index". Without imakeidx I do get what I want. Is this a bug ...
0
votes
0answers
2k views

How to insert latex into confluence page?

I have some equations that I need to incorporate into a confluence page. How do I do this in confluence? Even if I have to use markdown, that is fine. but I do not see a way to do that. I see this ...
1
vote
2answers
174 views

How can I find the definition of latex macros?

So I've started to become more familiar with LaTeX, still a beginner but comfortable enough to try out the scary patchcmd from the etoolbox package. What has me mystified though is how people find out ...
1
vote
1answer
34 views

Where are the reference docs? [duplicate]

I'm just getting started with LaTeX, so likely missing something simple. I'm just looking for docs: how to get started, what commands do what, etc. I found the documentation page, but all it seems to ...
79
votes
16answers
5k views

Which manuals are on your “TeX Reference” shelf?

This is a community wiki since there is no "one true answer"- if you find an answer that contains a lot of your choices, but is missing something you feel is incredibly useful. Feel free to add it. ...
10
votes
3answers
521 views

does the doc folder contain only documentation?

I'm trying to get rid of some junk on my hard drive and want to make sure I don't delete anything vital, so it's probably a dumb question. In my latex tree there is the texmf-dist/doc folder which is ...
1
vote
1answer
383 views

How do I find the meaning of latex documentclass options?

I saw someone using the [final] option for the beamer documentclass and wanted to see what it did. So I searched the package documentation here on CTAN and also found the directory on my computer that ...
0
votes
0answers
81 views

How can I see a list of commands for each MiKTeX package?

For example, take the 'textcomp' package. I can only find commands like \textdegree, etc. from here and there. Is there a way to see all the available commands for this as well as other packages? (...
0
votes
1answer
160 views

How to input text from a file between tags without source code formatting

I am trying to extract documentation from a C++ source code file into LaTeX. Extracting the code using \lstinputlisting was simple. The problem I am having is extracting the text from comments ...
1
vote
0answers
1k views

About svproc documentclass

I am supposed to submit my paper to conference, whose proceedings will be published by Springer in Lecture notes in Network and Systems(LNNS). But the said latex file is not running. It says svproc....