Skip to content

Commit 2c8b327

Browse files
committed
Some URLs updated or added.
Attempt to format error messages as `raw` instead of `latex` code.
1 parent 8c1792c commit 2c8b327

9 files changed

+52
-60
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Changelog](https://keepachangelog.com/en/1.0.0/).
1919

2020
### Changed
2121

22+
- Q-erroradvice: Added link.
2223
- Q-spell: Removed information about VMS and MS-DOS programs. Added `Antidote` as a LaTeX-aware spell checker.
2324
- Q-recovertex: Links added.
2425
- Q-time.md: Added `datetime2`.

FAQ-RCS.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ permalink: /FAQ-RCS
55
redirect_from: /FAQ-rcs
66
---
77

8-
If you use RCS, CVS, `Subversion`,
9-
`Bazaar` or `Git` to maintain
8+
If you use RCS, CVS, `Subversion`, `Bazaar` or `Git` to maintain
109
your (La)TeX documents under version control, you may need some
1110
mechanism for including the version details in your document, in such
1211
a way that they can be typeset (that is, rather than just hiding them
@@ -69,8 +68,7 @@ documentation to see which suits you best.
6968
An alternative script-based approach to version control has been taken
7069
by the [`vc`](https://ctan.org/pkg/vc) bundle, that in certain situations might work more
7170
reliably than any of the packages mentioned above. The [`vc`](https://ctan.org/pkg/vc)
72-
bundle supports `Bazaar`, `Git` and
73-
`Subversion` usage and works with both LaTeX and
71+
bundle supports `Bazaar`, `Git` and `Subversion` usage and works with both LaTeX and
7472
Plain TeX. Note that [`vc`](https://ctan.org/pkg/vc) is the only option that
7573
currently claims to support `Bazaar`-controlled repositories.
7674

FAQ-errmissitem.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ permalink: /FAQ-errmissitem
55
---
66

77
Sometimes, the error
8-
```latex
8+
```raw
99
Something's wrong--perhaps a missing \item
1010
```
1111
actually means what it says:
@@ -99,9 +99,8 @@ modification of the above _does_ work:
9999
```
100100
<!-- {% endraw %} -->
101101
The code above produces a box that's far too wide for the text. One
102-
may want to use something that allows
103-
[variable size boxes](FAQ-varwidth) in place of the
104-
`minipage` environment.
102+
may want to use something that allows [variable size boxes](FAQ-varwidth)
103+
in place of the `minipage` environment.
105104

106105
Oddly, although the `verbatim` environment wouldn't work
107106
inside a `\fbox` command argument (see
@@ -118,6 +117,5 @@ error:
118117
This is a case where you've simply got to be more subtle; you should
119118
either write your own macros to replace the insides of LaTeX's
120119
sectioning macros, or look for some alternative in the packages
121-
discussed in
122-
"[The style of section headings](FAQ-secthead)".
120+
discussed in "[The style of section headings](FAQ-secthead)".
123121

FAQ-erroradvice.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,16 @@ macroprocessors. Knuth makes light of the problem in the TeXbook,
1010
suggesting that you acquire the sleuthing skills of a latter-day
1111
Sherlock Holmes; while this approach has a certain romantic charm to
1212
it, it's not good for the "production" user of (La)TeX. This
13-
answer (derived, in part, from an article by Sebastian Rahtz in
14-
TUGboat 16(4)) offers some general guidance in dealing with TeX
13+
answer (derived, in part, from an [article by Sebastian Rahtz](http://tug.org/TUGboat/tb16-4/tb49rahtz.pdf)
14+
in TUGboat 16(4)) offers some general guidance in dealing with TeX
1515
error reports, and other answers in this section deal with common (but
1616
perplexing) errors that you may encounter. There's a long list of
1717
"hints" in Sebastian's article, including the following:
18-
18+
1919

2020
- Look at TeX errors; those messages may seem cryptic at first,
2121
but they often contain a straightforward clue to the problem. See
22-
[the structure of errors](FAQ-errstruct) for further
23-
details.
22+
[the structure of errors](FAQ-errstruct) for further details.
2423
- Read the `log` file; it contains hints to things you may
2524
not understand, often things that have not even presented as error
2625
messages.
@@ -40,16 +39,15 @@ perplexing) errors that you may encounter. There's a long list of
4039
- As a last resort, tracing can be a useful tool; reading a full
4140
(La)TeX trace takes a strong constitution, but once you know how,
4241
the trace can lead you quickly to the source of a problem. You need
43-
to have read the TeXbook (see
44-
[books about TeX](FAQ-tex-books)) in some detail, fully
45-
to understand the trace.
46-
42+
to have read the TeXbook (see [books about TeX](FAQ-tex-books))
43+
in some detail, fully to understand the trace.
44+
4745
4846
The command `\tracingall` sets up maximum tracing; it also sets
4947
the output to come to the interactive terminal, which is somewhat of
5048
a mixed blessing (since the output tends to be so vast&nbsp;&mdash; all but
5149
the simplest traces are best examined in a text editor after the event).
52-
50+
5351
5452
The LaTeX [`trace`](https://ctan.org/pkg/trace) package (first distributed with the
5553
2001 release of LaTeX) provides more manageable tracing. Its
@@ -65,7 +63,6 @@ most of the common errors are plain to the eye when you go back to the
6563
source line that TeX tells you of. If that approach doesn't work,
6664
the remaining answers in this section deal with some of the odder
6765
error messages you may encounter. You should not ordinarily need to
68-
appeal to the [wider public](FAQ-gethelp)
69-
for assistance, but if you do, be sure to
70-
report full backtraces (see `errorcontextlines` above) and so on.
66+
appeal to the [wider public](FAQ-gethelp) for assistance, but if you do,
67+
be sure to report full backtraces (see `errorcontextlines` above) and so on.
7168

FAQ-errstruct.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ is after all the arguments have been scanned.) For example:
3737
\blah and so on
3838
```
3939
produces the error report
40-
```latex
40+
```raw
4141
! Undefined control sequence.
4242
l.4 \blah
4343
and so on
@@ -48,7 +48,7 @@ while:
4848
\blah{to you}, folks
4949
```
5050
produces the error report
51-
```latex
51+
```raw
5252
! Undefined control sequence.
5353
\blah #1->\bleah
5454
#1
@@ -61,7 +61,7 @@ If the argument itself is in error, we will see things such as
6161
\blah{\bleah}, folks
6262
```
6363
producing
64-
```latex
64+
```raw
6565
! Undefined control sequence.
6666
<argument> \bleah
6767
@@ -70,7 +70,7 @@ l.5 \blah{\bleah}
7070
```
7171

7272
The prompt accepts single-character commands: the list of what's
73-
available may be had by typing `?`. One immediately valuable
73+
available may be obtained by typing `?`. One immediately valuable
7474
command is `h`, which gives you an expansion of TeXs original
7575
précis message, sometimes accompanied by a hint on what to do to
7676
work round the problem in the short term. If you simply type "return"

FAQ-tmupfl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ permalink: /FAQ-tmupfl
66

77
If LaTeX responds to a `\begin{figure}` or
88
`\begin{table}` command with the error message
9-
```latex
9+
```raw
1010
! LaTeX Error: Too many unprocessed floats.
1111
1212
See the LaTeX manual or LaTeX Companion for explanation.

FAQ-verbwithin.md

Lines changed: 24 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ which simply regurgitates its argument, and use it as:
2424
```latex
2525
\unbrace{\verb+\error+}
2626
```
27-
the combinartion will not (it will attempt to execute `\error`).
27+
the combination will not (it will attempt to execute `\error`).
2828
Other errors one
2929
may encounter are "`\verb` ended by end of line", or even the
3030
rather more helpful "`\verb` illegal in command argument". The
31-
same sorts of thing happen with `\begin{verbatim}` &hellip;
31+
same sort of thing happen with `\begin{verbatim}` &hellip;
3232
`\end{verbatim}`:
3333
<!-- {% raw %} -->
3434
```latex
@@ -50,15 +50,13 @@ matching `\end{verbatim}`.
5050
This is why the LaTeX book insists that verbatim
5151
commands must not appear in the argument of any other command; they
5252
aren't just fragile, they're quite unusable in any "normal" command
53-
parameter,
54-
regardless of [`\protect`ion](FAQ-protect). (The `\verb`
53+
parameter, regardless of [`\protect`ion](FAQ-protect). (The `\verb`
5554
command tries hard to detect if you're misusing it; unfortunately, it
5655
can't always do so, and the error message is therefore not reliable as an
5756
indication of problems.)
5857

59-
The first question to ask yourself is: "is `\verb` actually
60-
necessary?".
61-
58+
The first question to ask yourself is: "is `\verb` actually necessary?".
59+
6260

6361
- If `\texttt{_your text_}` produces the same result
6462
as `\verb+_your text_+`, then there's no need of
@@ -99,14 +97,15 @@ Another way out is to use one of "argument types" of the
9997
\cmd{Command }|\furble|{ isn't defined}
10098
```
10199
Which gives us:
102-
Command `\furble` isn't defined
100+
```raw
101+
Command `\furble` isn't defined
102+
```
103103
The `m` tag argument specifies a normal mandatory argument,
104104
and the `v` specifies one of these verbatim arguments.
105105
As you see, it's implanting a `\verb`-style command argument in the
106-
argument sequence of an otherwise "normal" sort of command; that
107-
`|`
108-
may be any old character that doesn't
109-
conflict with the content of the argument.
106+
argument sequence of an otherwise "normal" sort of command; that `|`
107+
may be any old character that doesn't conflict with the content of
108+
the argument.
110109

111110
This is pretty neat (even if the verbatim is in an argument of its
112111
own) but the downside is that [`xparse`](https://ctan.org/pkg/xparse) pulls in
@@ -115,7 +114,7 @@ the experimental LaTeX3 programming environment
115114

116115
Other than the [`cprotect`](https://ctan.org/pkg/cprotect) package, there are four partial
117116
solutions to the problem:
118-
117+
119118

120119
- Some packages have macros which are designed to be responsive
121120
to verbatim text in their arguments. For example,
@@ -127,15 +126,15 @@ solutions to the problem:
127126
arguments of other commands, but it can clash with other packages:
128127
for example, `\VerbatimFootnotes` interacts poorly with the
129128
`para` option of the [`footmisc`](https://ctan.org/pkg/footmisc) package.
130-
129+
131130

132131
The [`memoir`](https://ctan.org/pkg/memoir) class defines its `\footnote` command so that
133132
it will accept verbatim in its arguments, without any supporting package.
134133
- The [`fancyvrb`](https://ctan.org/pkg/fancyvrb) package defines a command `\SaveVerb`,
135134
with a corresponding `\UseVerb` command, that allow you to save
136135
and then to reuse the content of its argument; for details of this
137136
extremely powerful facility, see the package documentation.
138-
137+
139138

140139
Rather simpler is the [`verbdef`](https://ctan.org/pkg/verbdef) package, whose `\verbdef`
141140
command defines a (robust) command which expands to the verbatim
@@ -156,13 +155,11 @@ solutions to the problem:
156155
- The [`tcolorbox`](https://ctan.org/pkg/tcolorbox) package provides a similar facility
157156
- If you have a single character that is giving trouble (in
158157
its absence you could simply use `\texttt`), consider using
159-
`\string`. `\texttt{my`\string`_name}`
160-
typesets the same as
158+
`\string`. `\texttt{my`\string`_name}` typesets the same as
161159
`\verb+my_name+`, and will work in the argument of a command. It
162160
won't, however, work in a moving argument, and no amount of
163-
[`\protect`ion](FAQ-protect) will make it work in
164-
such a case.
165-
161+
[`\protect`ion](FAQ-protect) will make it work in such a case.
162+
166163
167164
A robust alternative is:
168165
```latex
@@ -175,7 +172,7 @@ solutions to the problem:
175172
troublesome character (though it's plainly not necessary for things
176173
like percent signs for which (La)TeX already provides
177174
robust macros).
178-
175+
179176
180177
- One may also consider putting verbatim material in an external
181178
file; this is somewhat more tedious, but the file may be reused
@@ -188,7 +185,7 @@ solutions to the problem:
188185
```
189186
which (as one might guess) writes to the named file; load the saved
190187
contents using `\input{<file name>}`
191-
188+
192189
193190
A second environment puts your verbatim material in an (apparently)
194191
anonymous temporary file:
@@ -200,14 +197,14 @@ solutions to the problem:
200197
In this case, you use the anonymous file with the `\tcbusetemp`
201198
macro. (You can change the name used for the "anonymous" file, if
202199
its default proves troublesome.)
203-
200+
204201
205202
The [`moreverb`](https://ctan.org/pkg/moreverb) package provides a `\verbatimwrite`
206203
command, which doesn't provide an anonynous file.
207-
204+
208205
209206
Macros, to achieve the same effect, are outlined in the
210-
documentation of the [`verbatim`](https://ctan.org/pkg/verbatim) package; the macros use the
211-
facilities of the package, but the user has to write a mini-package
212-
actually to use them.
207+
documentation of the [`verbatim`](https://ctan.org/pkg/verbatim) package;
208+
the macros use the facilities of the package, but the user has to write
209+
a mini-package actually to use them.
213210

FAQ-webpkgs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ outlining the programming techniques, may be had from CTAN.
1414
`CWEB`, by Silvio Levy, is a WEB for C programs.
1515

1616
`FWEB`, by John Krommes, is a version for Fortran,
17-
Ratfor,C, C++, working with LaTeX; it was derived
17+
Ratfor, C, C++, working with LaTeX; it was derived
1818
from `CWEB`.
1919

2020
Spidery WEB, by Norman Ramsey, supports many

FAQ-whereFAQ.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The sources of the present FAQ are available from CTAN.
1515

1616
This FAQ and others are regularly mentioned, on `comp.text.tex` and elsewhere,
1717
in a "pointer FAQ" which is also saved at
18-
[https://tug.org/tex-ptr-faq](https://tug.org/tex-ptr-faq).
18+
[http://tug.org/interest.html](http://tug.org/interest.html#doc).
1919

2020
A 2006 innovation from Scott Pakin is the "visual" LaTeX FAQ.
2121
This is a document with (mostly rubbish) text formatted so as to
@@ -36,17 +36,18 @@ user group CS-TUG have published translations of this FAQ in the past,
3636
with extensions appropriate to their languages.
3737

3838
The French FAQ is currently hosted on an open wiki at
39-
[https://faq.gutenberg.eu.org/](https://faq.gutenberg.eu.org/)
39+
[https://faq.gutenberg.eu.org](https://faq.gutenberg.eu.org/)
4040
and is [actively updated](https://www.gutenberg.eu.org/faq).
4141
Its contributors have gathered material from the French historical FAQ
42-
from `fr.comp.text.tex` and from this FAQ. Feel free to contribute!
42+
from `fr.comp.text.tex` and from [this FAQ](http://faq.tug.org/).
43+
Feel free to contribute!
4344

4445

4546
Other non-English FAQs are available (off-CTAN):
4647

4748
- German: Posted regularly to `de.comp.tex`, and [archived on CTAN](https://www.ctan.org/pkg/faq-de);
4849
another version is maintained on a wiki:
49-
[https://texfragen.de/]([https://texfragen.de/);
50+
[https://texfragen.de](https://texfragen.de/);
5051
- Italian: See [https://www.guitex.org/home/it/faq](https://www.guitex.org/home/it/faq);
5152
- Spanish: A FAQ is [published by CervanTeX](http://www.aq.upm.es/Departamentos/Fisica/agmartin/webpublico/latex/FAQ-CervanTeX/FAQ-CervanTeX.html),
5253
the Spanish TeX user group.

0 commit comments

Comments
 (0)