summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-latexqual.html
blob: d155571fdca64f54b9d3708352032ca47c0723c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<head>
<title>UK TeX FAQ -- question label latexqual</title>
</head><body>
<h3>The quality of your LaTeX</h3>
<p/>The <i>l2tabu</i> tutorial (mentioned in 
<a href="FAQ-man-latex.html">online introductions</a>) is undoubtedly a
good read.
<p/>However, it&#8217;s always difficult to remember the things you should
<em>not</em> do, when there are so many things to remember that you
really must do: some automation is needed&#8230;.
<p/>The nicely-named <i>nag</i> allows you to apply a configurable set
of checks to your document, as you run it through LaTeX; you get
messages like:
<blockquote>
<pre>
Package nag Warning: Command \bf is an old LaTeX 2.09 command. 
(nag)                Use \bfseries or \textbf instead on input line 30.
</pre>

</blockquote><p>
  (the package provides a demo file which contains most of the sorts
  of errors you might make &#8212; this is one of them).

<p/>There&#8217;s also a web site
<a href="http://www.kohm.name/markus/texidate.html">TeXidate</a>
which will do a static analysis of your document (unfortunately, you
have to paste your document source into a text window).  The site
doesn&#8217;t seem as comprehensive as <i>nag</i>, but it allows you to
download its script, which you can then juggle with to make it more
draconian.
<dl>
<dt><tt><i>l2tabu</i></tt><dd>Browse <a href="http://mirror.ctan.org/info/l2tabu">info/l2tabu</a> for a copy in a language that&#8217;s
  convenient for you
<dt><tt><i>nag.sty</i></tt><dd><a href="http://mirror.ctan.org/macros/latex/contrib/nag.zip">macros/latex/contrib/nag</a> (or <a href="http://mirror.ctan.org/macros/latex/contrib/nag/">browse the directory</a>); <a href="http://mirror.ctan.org/help/Catalogue/entries/nag.html">catalogue entry</a>
</dl>
<p/>
<p/><p/><p/><p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexqual">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexqual</a>
</body>