Stack Exchange Network

Stack Exchange network consists of 175 Q&A communities including Stack Overflow, the largest, most trusted online community for developers to learn, share their knowledge, and build their careers.

Visit Stack Exchange

Questions tagged [documentation]

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

1
vote
1answer
20 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
0answers
51 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 ...
1
vote
1answer
51 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 ...
2
votes
1answer
35 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....
2
votes
2answers
307 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[...
1
vote
1answer
30 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 ...
3
votes
1answer
156 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
137 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
52 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
25 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 ...
14
votes
3answers
754 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
97 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
407 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 ...
30
votes
1answer
950 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. ...
1
vote
1answer
125 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
74 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
314 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
118 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 ...
5
votes
0answers
97 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....
3
votes
2answers
202 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
113 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, ...
3
votes
3answers
258 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 ...
0
votes
1answer
67 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
33 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 ...
0
votes
0answers
1k 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 ...
2
votes
1answer
73 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
1answer
204 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, ...
1
vote
2answers
136 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
33 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 ...
1
vote
1answer
316 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
71 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
122 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
884 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....
2
votes
1answer
183 views

Package documentation in TeXworks

Does exist a way to open/read the documentation of packages directly from TeXworks?
2
votes
1answer
318 views

Where to report bugs in the LaTeX3 documentation?

Where can I report bugs in the LaTeX3 documentation, e.g. in The LaTeX3 Interfaces document?
5
votes
5answers
309 views

Where is the user manual for the Novel class?

I'm interested in the recent novel class. I tried texdoc novel to get the documentation but all it gave was an interesting puff for the class and saying that the user manual was in HTML format. I went ...
0
votes
1answer
154 views

Biblatex @manual - file path using understrike

I have kind of a problem with my entries for biblatex... I want do write an entry for my bibliography like this @manual{test, author = {{me}}, title = {Test-PDF}, version = {0.9}, ...
0
votes
2answers
489 views

Why moderncv documentation is not shown?

moderncv package is installed in my distribution. But when I try to open documentation using texdoc moderncv some text are appeared instead of documentation. Why?
3
votes
1answer
125 views

tcolorbox disable blank option

While writing a package I started to use tcolorbox and its documentation library. I found the keys doc head command etc. and started to customize. But there are strong limitations to that, because I ...
1
vote
1answer
335 views

How to put a no-filled box around a paragraph [duplicate]

I want to emphasize a certain part of a document by putting a box around it. Any help is much appreciated.
2
votes
1answer
132 views

Change the comment character (%) for the doc class

When generating files from a *.dtx source, Docstrip discards lines starting with the comment character % (unless they contain guards %<guard>content). When typesetting the documentation with ...
4
votes
0answers
5k views

PGF manual 3.0.1a permalink [closed]

I was wondering whether anyone knows of a permalink to the current version of the pgf manual. I am cross referencing links from my package documentation to the tikz manual and would like to make sure ...
8
votes
3answers
983 views

Where can I find LaTeX and its package installation guide in details?

After some days when my university will be closed for vacation of Eid al-Fitr I will go to my village (InshaAllah). I have decided to learn LaTeX in the vacation. But in my village there is no ...
1
vote
1answer
214 views

Output plaintext document instead of DVI/PDF

Is there a way to get LaTeX to generate a plaintext (ie: .txt file) output instead of a .pdf/.dvi file? I have some lengthy manuals that I'm writing, and I'm trying to find a way to generate pretty ...
3
votes
2answers
427 views

List of Plain TeX macros [duplicate]

Where can I get a list of all Plain TeX macros. In the TeXbook, it is said that Plain TeX adds about 600 macros (to the ~300 TeX primitives). Where are they listed (with their documentation)?
4
votes
2answers
241 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 ...
1
vote
2answers
168 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
0answers
47 views

How to install the documentation for a package

I installed the hanging package with tkmgr gui but it came without documentation. How can install the documentation?
0
votes
0answers
344 views

Where can I find documentation for the dsp-tikz library?

I would like to track down the best source of documentation for the (digital signal processing) dsp-tikz library. An example using the library is shown here.
2
votes
0answers
43 views

What is the LaTeX manual and how can I see a particular page of it? [duplicate]

Any of us, especially me, usually get error messages like: ! LaTeX Error: Command \c@XXX already defined. Or name \end... illegal, see p.192 of the manual. See the LaTeX manual or ...