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
2answers
67 views

Can I programmatically typeset .bib file data with Biblatex?

In working on improved documentation for a Biblatex style, I'd like to print nicely styled verbatim .bib entries beside the output for each, thereby juxtaposing cause and effect. This could be done by ...
2
votes
0answers
96 views

Code highlight in ltxdoc documentation

I wish to add LaTeX code highlight in a package documentation. Usually I use the following code to highlight LaTeX code (copied from classicthesis documentation): \usepackage{listings} \definecolor{...
2
votes
0answers
37 views

How do I view the documentation of the `novel` class?

I tried texdoc novel and got many (over 30) errors of the form (134): Illegal character <22> in hex string How do I use the class? I also tried pdflatex novel-example with no success.
1
vote
1answer
29 views

Where is make4ht “mathjax” argument documented?

I am able to convert a LaTeX file foo.tex to foo.html using make4ht like this, make4ht foo mathjax Where is this argument mathjax documented? I searched the documentation at http://mirrors.ctan.org/...
1
vote
1answer
44 views

viewing documentation of tex packages [duplicate]

I'm new to Latex and I was wondering if it is possible to look up the documentation of tex packages in the terminal like with man pages? I find myself frequently having to look up stuff online that I ...
1
vote
2answers
47 views

No linebreak with \refKey (tcolorbox documentation library)

I currently try to document a LaTeX-package with several keys. When I use the internal tools of the tcolorbox documentation library, I get some ugly results. \documentclass{scrartcl} \usepackage{...
4
votes
3answers
291 views

tcolorbox documentation: documenting dynamic keypaths

I'm documenting a package that has certain key paths which are created dynamically (either by some command or on the fly via the pgfkeys .unknown handler). I want to document these keys with the ...
3
votes
3answers
111 views

Documentation for options to lucidabr package

In postings related to the lucidabr package (like here) one sometimes sees options like expert, nofontinfo, lucidascale, and so on. I tried to find documentation for them, but didn't succeed so far. ...
0
votes
1answer
2k views

How to write using TeX

I've downloaded MiKTeX as I'd like to write a Mathematical document using it (I've had some basic experience using LaTeX on the Maths Stack Exchange page as it requires everything like equations to be ...
3
votes
1answer
71 views

How is LaTeX's online documentation produced?

I like the style of the LaTeX html online documentation on latex-project.org. I assume it is written in LaTeX and then somehow transformed into HTML. I would like to produce a documentation in a ...
0
votes
0answers
60 views

Macro manual for WinEdt 10.3 in pdf - where do I find it?

I need the Macro manual for WinEdt 10.3 in pdf - where do I find it ?
0
votes
0answers
39 views

WinEdt 10.3 - a manual request

Where can I find the WinEdt 10.3 newest manual (from year 2020), any links/references ? Does this manual also come as a book on Amazon.co.uk ?
3
votes
1answer
54 views

How to understand the “v-type” argument error described in xparse package documentation?

I'm getting myself familiar with the LaTeX3 new way of composing a customized command using the xparse package. However, I don't quite understand what does this line means from the documentation: v ...
0
votes
1answer
47 views

How to make add a square box inside another?

Is it possible to create the picture shown below in LaTex? I am fairly new to this software and any help would be greatly appreciated. I know how the code to start off the square but I'm not sure how ...
2
votes
0answers
60 views

Package to obtain the style of the TikZ/PGF-Documentation

The gold standard of LaTeX-documentation is - at least for me - the TikZ/PGF-documentation. It is formatted consistently, has great code highlighting and (one of the best features in my opinion) you ...
2
votes
1answer
28 views

Glossary-esque list of macros in package documentation

I've been on an hours-long journey looking for what should be common TeX knowledge, but without avail. I might just not know the correct search terms to do an efficient search, so I think it's worth ...
2
votes
0answers
58 views

How to compile pgfmanual

I'am trying to compile pgfmanual with texlive 2020. Codes are cloned from pgf-tikz/pgf. I simply run make under path pgf/doc/generic/pgf/version-for-pgftex/en, but got an error pgfmanual-en-macros.tex ...
0
votes
0answers
84 views

titlesec VS amsart

I am just wondering why the titlesec package doesn't work well with the amsart document class. For example, in the code below the first \section seems to work fine whereas the second doesn't even ...
0
votes
0answers
96 views

Chemfig example from documentation doesn't compile

I'm taking a chemfig example about the \charge macro and trying to copy, paste, and compile to get some practice with it. I get a Undefined control sequence error with a recently updated full TeX Live ...
2
votes
0answers
37 views

Can I safely move the LaTeX doc folder in Linux from the distribution folder to the local texmf/ folder?

Latex's documentation is quite big and I am now running out of space on / . I have the main Latex installation under / , where I have a folder ../texmf-dist/doc/ which is quite big. I have space ...
1
vote
1answer
132 views

How to reproduce tkz-euclide documentation

I'm trying to reproduce the tkz-euclide documentation with the files available in CTAN (and TeXLive), but I haven't succeeded, it's missing couverture.tex , zorna.sty and I get the error: ! Package ...
0
votes
0answers
58 views

`LaTeX` documentation and reference guide [duplicate]

Is there anything such as LaTeX documentation? When I am looking for some syntax on google, I only get to forums, but never a site with actual documentation, such as when looking for the meaning of \...
1
vote
2answers
186 views

Documentation of simplewick.sty: clarifications

Sometimes some users use simplewick package to draw contractions above and below expressions. For my humble opinion it is a old package (into the guide there are double dollars ($$...$$) that I still ...
2
votes
0answers
168 views

manual - How to understand ConTeXt commands?

The reference manual ConTeXt commands gives all supported options by command. Unfortunately, there is no description about the conventions used. ¹ ² \setuphead [...,...] [..,....
2
votes
1answer
386 views

How to make a captivating executive summary with LaTeX?

Here's an excerpt clipped from a nice, colourful executive summary. This is the kind of thing that word processors seem to be really good at. There's often a bunch of presets that you can just ...
4
votes
1answer
84 views

Help with makedtx — DocInput undefined

I am trying to generate a CTAN .dtx/.ins files for a package I have and I stumbled upon a problem that I can't solve nor find a way around. I am on a Ubuntu 18.04, with a LaTeX Live 2017. Consider ...
1
vote
0answers
29 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.
9
votes
1answer
993 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 ...
3
votes
1answer
653 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 ...
9
votes
1answer
221 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
542 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, ...
2
votes
1answer
163 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
62 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
392 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
79 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....
3
votes
2answers
2k 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
94 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 ...
2
votes
1answer
265 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 ...
2
votes
1answer
340 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
204 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 ...
3
votes
1answer
69 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
1k 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
104 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
2k 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 ...
45
votes
2answers
4k 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
499 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
195 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
396 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
450 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
1answer
157 views

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

This question refers to LuaTeX-engines prior to luatex 1.10.0 in texlive 2019. With luatex 1.10.1 in texlive 2019 and later the \string-primitive works as expected. Where can I find exact ...

1
2 3 4 5 6