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
0 answers
63 views

Documentation with l3doc.cls

I have been trying to convert my package documentation from ltxdoc to l3doc, and I've met several obstacles. First is getting \ProvidesExplFile to work. I tried to do something like this: % \iffalse ...
karlh's user avatar
  • 640
0 votes
1 answer
63 views

l3build - Work directly with a documentation as a `PDF` file

To work with l3build, I want to use the following structure where I give the documentation directly in the form of a PDF file. . ├── MANIFEST.md ├── README.md ├── build.lua ├── code │   ├── bdoc-...
projetmbc's user avatar
  • 13.3k
2 votes
1 answer
92 views

l3build - CTAN zip - Doc with resources not compiled

I use the following folder to put my sty files in code, and my tex file and its resources in doc that are imported by bdoc-fr.tex. rollout ├── build.Lua ├── code └── doc    ├── bdoc-fr.tex    └── ...
projetmbc's user avatar
  • 13.3k
0 votes
0 answers
32 views

The documentation of Mathalfa and tx \mathbb{1} [duplicate]

I've not been able to produce a \mathbb{1} with \usepackage[bb=tx]{mathalfa}. I haven't been able to produce anything of that matter (no blackboard bold symbols of the ones I've tried - just some ...
studying mathematics 's user avatar
6 votes
2 answers
145 views

Titlespacing command not working for \subsection and also causing error for \section

I'm using the packages \documentclass{amsart} \usepackage{amsmath} they do not leave a vertical space between the section's title and the following text. So i'm trying to use the titlespacing ...
tutizeri's user avatar
  • 161
2 votes
1 answer
346 views

new LuaTeX primitives documentation

Compared to pdfeTeX, which primitives have been added to LuaTeX? Besides the rearrangement of the standard pdfeTeX PDF primitives, and the somewhat odd (as compared to XeTeX) beaviour of \font (which ...
jarnosc's user avatar
  • 4,266
0 votes
1 answer
103 views

Documentation for commands [duplicate]

Is there a way to view the documentation for a particular command. Consider, as example \NewDocumentCommand. Is it possible to find its description and synopsis ?
Veak's user avatar
  • 1
0 votes
1 answer
97 views

Texdoc and the various files [closed]

Have been looking at texdoc and have found texdoc interface3 texdoc source3 One of the documents states that it is a reference manual, the other that it is a reference documentation, for the L3 ...
Veak's user avatar
  • 1
0 votes
1 answer
76 views

Descriptions of m o D for \NewDocumentCommand

Where can I find documentation for m, o ,and D for \NewDocumentCommand as I cannot find them in interface3.pdf. \NewDocumentCommand{\newconject}{momoD(){black}}
Veak's user avatar
  • 1
0 votes
0 answers
70 views

Newcomer wanting to work on Latex Programming Code [duplicate]

I would like to have a list of documents to read so that a newcomer can start working on Latex Programming. What would be a good material sequence to read (e.g. described by documentation section ...
Veak's user avatar
  • 1
3 votes
2 answers
283 views

Documentation for programmers regarding expl3

Does there exist documentation for programmers regarding Latex3 ? With details about \cs, \tl, \use, and so on ?
Veak's user avatar
  • 1
0 votes
1 answer
190 views

Tikz renders filled lines as dashed with `Lines`

I am attempting to reproduce a pattern fill from the tikz documentation. Specifically, I run \usetikzlibrary {patterns,patterns.meta} \begin{tikzpicture} \draw[pattern={Lines[angle=45,distance={3pt/...
Seraf Fej's user avatar
  • 133
1 vote
1 answer
67 views

pgf: codeexample with verbatim code

I'm using pgfmanual to document a library and the nice looking codeexample environment to typeset a code block + the result. However, I'd like to use it when the code contains verbatim code. Is it ...
tobiasBora's user avatar
  • 8,704
2 votes
1 answer
41 views

pgf: copy codeexample style

I'm using pgfmanual to document a library and the nice looking codeexample environment to typeset a codeblock + the resulting image. However, I'd like to use a the same style (lstlisting is too ...
tobiasBora's user avatar
  • 8,704
3 votes
0 answers
79 views

How do you learn to read package documentation and LaTeX typesetting concepts like glue and boxes (primitives)?

I'm having trouble reading documentation from packages. It seems like there's something wrong with the way I'm reading them. How should I read them, in order to learn how to use the packages correctly ...
Adrik Ivanov's user avatar
4 votes
1 answer
107 views

Can I use ltxdoc, makeidx, doc and bookmarks? If so, how?

Is it possible to use ltxdoc.cls with makeidx and bookmark? MNWE: \documentclass{ltxdoc} \usepackage{makeidx} \usepackage{bookmark} \makeindex \begin{document} \DescribeMacro{\mymacro}\marg{argument}\...
cfr's user avatar
  • 199k
5 votes
1 answer
99 views

How to modify doc's v3 documentation macros à la doctools?

I used the ltxdoc class with doc and doctools to document prooftrees. That documentation currently requires the compatibility option doc2 as my modifications don't work with version 3 of doc. I'm ...
cfr's user avatar
  • 199k
0 votes
0 answers
113 views

Compiling the PGF/TikZ manual with other fonts: 𝛺 (U+03A9) and 𝜇 (U+1D707) in the circuit libraries

I wish to have the PGF/TikZ manual with a different font. I find the default Latin Modern too spindly. Thus, I have tried to compile the manual with the MLModern and New Computer Modern (NCM) fonts. I ...
Apoorv Potnis's user avatar
1 vote
1 answer
158 views

How to compile the pgfmanual with mlmodern fonts?

I simply want a version of the pgf/TikZ manual with the bolder mlmodern fonts instead of the original lm fonts. To achieve this, I cloned the pgf repo from git, loaded the mlmodern package after the ...
Apoorv Potnis's user avatar
0 votes
0 answers
39 views

Where is the `\marginpar` command defined?

I couldn't find official documentation for the \marginpar command. Where is it defined? I looked at the documentation for Standard Document Classes for LaTeX Version 2e. While this discusses \...
red_trumpet's user avatar
1 vote
1 answer
52 views

Function of "Elements" without Backslash in Command-Definitions

I have a general question which I couldn't solve so far. It came up a few days ago, while I was trying to redefine the different parts of the footer of the scrlayer-scrpage package (this still isn't ...
lukeflo's user avatar
  • 1,555
0 votes
0 answers
29 views

If you were to write the LaTeX command `\tfrac` as a Full English phrase, what would that English phrase be? [duplicate]

I saw someone use \tfrac in one of their documents. What does the letter "t" in \tfrac stand for? \text{young children are often taught } \tfrac 18 \text{ is } \tfrac 12 \text{ of } \...
IdleCustard's user avatar
  • 1,204
3 votes
1 answer
95 views

What phrase from natural language does the letter "**t**" in `\tfrac` stand for?

I saw someone use \tfrac in one of their documents. \text{young children are often taught } \tfrac 18 \text{ is } \tfrac 12 \text{ of } \tfrac 14 As two examples of what I am looking for, we have: ...
IdleCustard's user avatar
  • 1,204
1 vote
0 answers
76 views

What English phrase corresponds to the latex command `\rlap`

Using an alignat environment, it is possible to write down some notation for a linear program (optimization problem with linear objective function and linear constraints). What English phrase is a ...
IdleCustard's user avatar
  • 1,204
1 vote
0 answers
65 views

What English word does the `b` in `\bbox` represent? [closed]

Two of the LaTeX commands for building boxes are: The h in \hbox is a subsequence of the English word horizontal The v in \vbox is a subsequence of the English word vertical What English word might ...
IdleCustard's user avatar
  • 1,204
0 votes
0 answers
51 views

Where is the "documentation"? [duplicate]

I got many errors and ... "See the reledmac package documentation for explanation". Where is that? Thanks in advance!
Arthur's user avatar
  • 1
2 votes
2 answers
170 views

Where is the up-to-date, full pstricks documentation?

The contents of my /usr/share/texlive/texmf-dist/doc/generic/pstricks/*pdf is this (sorted by time): 189902 May 30 2009 /usr/share/texlive/texmf-dist/doc/generic/pstricks/test-pst.pdf 898183 May 30 ...
user avatar
0 votes
0 answers
32 views

Lot of documentation split across several documents [duplicate]

Going through https://www.latex-project.org/help/documentation/ There is a lot of documentation and is currently split across several documents. When people give the advice of going through the ...
Veak's user avatar
  • 1
1 vote
0 answers
59 views

TeX compiler with written privacy policy

I have a weird question: I am working at a public high school in New Hampshire, and I can't have any software installed on my school laptop unless the tech office determines that it does not violate ...
Justin Freeman's user avatar
0 votes
1 answer
69 views

Is there a way to get hyperlinks in Change History using the tcolorbox documentation library?

When I create documentation using doc the page numbers in my Change History become hyperlinks. That doesn't happen when I use tcolorbox's documentation library. Is there a way to get page numbers to ...
LaTeXereXeTaL's user avatar
-1 votes
2 answers
176 views

Make a color gradient with tikz

Where I can find the section about color gradient in the tikz documentation? Specifically, I would like to make the gradient you see in the outermost ring of this image. Forget the rest, I can easily ...
user3713179's user avatar
0 votes
0 answers
66 views

Accessing all TeX Live documentation files in Kile

I have set the location of TeX documentation as /usr/local/texlive/2022/texmf-dist/doc in Kile and selected the option of 'Use your system's TeXLive documentation'. Still, when I go to Help -> TeX ...
Apoorv Potnis's user avatar
0 votes
0 answers
44 views

Generating display mockups (ex. for datasheets or documentation)

I understand this is a very generic question but I have been trying to find something ready made to generate mock-ups of basic character displays (such as OLED screens) in LaTeX. I have considered ...
blahblahblahdev's user avatar
14 votes
1 answer
833 views

Which LaTeX package has the longest documentation?

I began learning LaTeX in the last week and I'm really feeling the learning curve. Something I appreciate is the thoroughness of the documentation for the packages. At first I came across the caption ...
arara's user avatar
  • 776
2 votes
1 answer
170 views

Is there an English manual for the geometry package?

I use texdoc to get package manuals. For the geometry package I have tried: `texdoc geometry` which returned `geometry-de.pdf` `texdoc geometry-en` which returned `geometry-de.pdf` `texdoc geometry-...
Peter Wilson's user avatar
  • 28.1k
3 votes
1 answer
105 views

listings: highlight LaTeX2e and expl3 code with separate colors

I'm planning to write new documentations for my packages, and in particular, this time I wish to improvement the code displaying. Below is the code I'm currently using for code highlighting. To ...
Jinwen's user avatar
  • 8,518
2 votes
1 answer
70 views

\PrintChanges in dtx file does not produce output

I'm trying to compile several .dtx files containing a \PrintChanges command, but those never produce a Change History chapter. For example, I tried this on Joseph Wright's self-extracting demopkg.dtx: ...
Wybo Dekker's user avatar
3 votes
0 answers
89 views

Systematic and structured study of (Lua)(Xe)(La)TeX

I have a general question for the TeX.SE community. I'm a regular user of LaTeX for the last 4 years or so. I can say with some degree of confidence that I am conversant with the bare basics of (Xe)...
vrgovinda's user avatar
  • 330
3 votes
0 answers
146 views

Is there a guide to writing good TeX package documentation?

I've put together a basic package which I think could be useful, and is working great. The code is simple, and I want to submit to CTAN. However, first, I have to write documentation, and I've never ...
luaplaying's user avatar
8 votes
2 answers
474 views

Latest user-level manuals for LaTeX 3 (follow up to Ivo Welch)

This is not a duplicate but a follow up spurred on by Ivo Welch's question Is there a LaTeX 3 transition guide for users (not gurus)? where he asked if there was a LaTeX 3 transition guide for users. ...
Peter Wilson's user avatar
  • 28.1k
1 vote
1 answer
455 views

Find source code and documentation of Overleaf package

I am faced with a very specific issue: I wish to know which commands are provided by a package, in this specific case, by fontawesome. For that to happen, I would like to know if there is a standard ...
José Ferreira's user avatar
2 votes
1 answer
92 views

The `macrocode` environment not working in a normal use of the `l3doc` class

I am writing a package with .dtx and .ins pair. I want it's documentation to be bilingual, but I don't want to complicate my .dtx file by having the documentation to have two languages and the source ...
Niranjan's user avatar
  • 3,435
1 vote
0 answers
77 views

Exact meaning of <balanced text> in LaTeX3 documentation

This is both a question as well as a (potential) suggestion for the LaTeX3 documentation: When specifying the syntax of documented macros, <description> is used to denote an argument to be ...
Maximilian Keßler's user avatar
2 votes
1 answer
84 views

Correct way to/best practice for using a custom class for my university?

I've written a really nice, pretty comprehensive class for my particular department's particular way of doing things. I've also got biblatex citation and bibliography styles. Once I have them a bit ...
modallyFragile's user avatar
1 vote
1 answer
161 views

How to use the pgfmanual package to document packages in tikz-style

I love the way tikz's (and tizk-cd's) documentation is formatted with clickable links to go to the definition of a style/command, colors, examples with image and code next to each others etc… As ...
tobiasBora's user avatar
  • 8,704
1 vote
1 answer
221 views

Taking screenshots of Java code from IDE to Latex (Text being to small)

I have been trying to make the screenshot of my code fit the document better, where it fills from side to side, without being stretched as a "background" Any idea of how to implement it? ...
Christian K's user avatar
4 votes
2 answers
422 views

Books for Latex in greek and documentation usage

Well I have been using Latex for a couple of weeks only, so that I can write in math exchange site. I have some problems and any piece of advice is very welcome. I am Greek and there aren't many ...
Νικολέτα Σεβαστού's user avatar
1 vote
2 answers
70 views

doc package: multiple macros with one definition

I'm writing class documentation with the doc package (well, via ltxdoc documentclass). I have several similar options like font sizes and line spacing, that I want to group together in one macro ...
jessexknight's user avatar
  • 2,742
0 votes
0 answers
138 views

Where are the docs? (Or: We may need an online documentation portal)

This is basically Where is the documentation?, but let me repeat it for a bit and then suggest an idea... skip past the line to get there immediately After thinking about this for a while, I reached ...
Peter Nerlich's user avatar
1 vote
2 answers
231 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 ...
jmclawson's user avatar
  • 890

1
2 3 4 5
7