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
0 votes
0 answers
30 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 ...
user avatar
  • 579
13 votes
1 answer
735 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 ...
user avatar
  • 736
1 vote
1 answer
78 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-...
user avatar
  • 25.2k
3 votes
1 answer
51 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 ...
user avatar
  • 4,515
2 votes
1 answer
23 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: ...
user avatar
3 votes
0 answers
76 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)...
user avatar
2 votes
0 answers
88 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 ...
user avatar
6 votes
2 answers
261 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. ...
user avatar
  • 25.2k
0 votes
1 answer
63 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 ...
user avatar
2 votes
1 answer
39 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 ...
user avatar
  • 2,203
1 vote
0 answers
47 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 ...
user avatar
0 votes
0 answers
20 views

hyphenation omitting from a whole text [duplicate]

I was wondering if there is any command to omit hyphenation throughout a document. As seen in the attached picture, and there are a lot of these in my compiled thesis, which is not quite desirable, is ...
user avatar
2 votes
1 answer
47 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 ...
user avatar
1 vote
1 answer
79 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 ...
user avatar
  • 5,043
1 vote
1 answer
55 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? ...
user avatar
4 votes
2 answers
263 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 ...
user avatar
1 vote
2 answers
26 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 ...
user avatar
  • 2,503
0 votes
0 answers
129 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 ...
user avatar
1 vote
2 answers
113 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 ...
user avatar
  • 880
2 votes
0 answers
121 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{...
user avatar
  • 4,515
2 votes
0 answers
45 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.
user avatar
  • 25.2k
1 vote
1 answer
76 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/...
user avatar
  • 2,887
1 vote
1 answer
54 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 ...
user avatar
1 vote
2 answers
65 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{...
user avatar
  • 977
4 votes
3 answers
328 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 ...
user avatar
  • 969
3 votes
3 answers
176 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. ...
user avatar
  • 1,638
0 votes
1 answer
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 ...
user avatar
3 votes
1 answer
92 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 ...
user avatar
0 votes
0 answers
106 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 ?
user avatar
  • 1,838
0 votes
0 answers
51 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 ?
user avatar
  • 1,838
3 votes
1 answer
70 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 ...
user avatar
0 votes
3 answers
81 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 ...
user avatar
  • 47
3 votes
1 answer
108 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 ...
user avatar
  • 977
2 votes
1 answer
38 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 ...
user avatar
  • 263
2 votes
0 answers
77 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 ...
user avatar
  • 4,336
0 votes
0 answers
155 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 ...
user avatar
  • 447
0 votes
0 answers
136 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 ...
user avatar
2 votes
0 answers
40 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 ...
user avatar
  • 2,168
1 vote
1 answer
153 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 ...
user avatar
0 votes
0 answers
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 \...
user avatar
  • 365
1 vote
2 answers
266 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 ...
user avatar
  • 46.1k
2 votes
0 answers
196 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 [...,...] [..,....
user avatar
2 votes
1 answer
574 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 ...
user avatar
  • 1,969
4 votes
1 answer
105 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 ...
user avatar
  • 28.7k
1 vote
0 answers
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.
user avatar
  • 515
11 votes
1 answer
1k 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 ...
user avatar
  • 28.7k
4 votes
1 answer
968 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 ...
user avatar
9 votes
1 answer
230 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 "...
user avatar
6 votes
3 answers
693 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, ...
user avatar
  • 1,411
2 votes
1 answer
205 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 [...
user avatar

1
2 3 4 5
7