diff options
Diffstat (limited to 'Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-install-doc.html')
| -rw-r--r-- | Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-install-doc.html | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-install-doc.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-install-doc.html index b0248ad8f6e..8d7a25681a1 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-install-doc.html +++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-install-doc.html @@ -2,10 +2,10 @@ <title>UK TeX FAQ -- question label install-doc</title> </head><body> <h3>Generating package documentation</h3> -<p/>We are faced with a range of “normal” provision, as well as several +<p/>We are faced with a range of “normal” provision, as well as several oddities. One should note that documentation of many packages is available on CTAN, without the need of any further effort by -the user — such documentation can usually be browsed <em>in situ</em>. +the user — such documentation can usually be browsed <em>in situ</em>. <p/>However, if you find a package that does not offer documentation on the archive, or if you need the documentation in some other format than the archive offers, you can usually generate the documentation @@ -17,8 +17,8 @@ LaTeX file (i.e., repeatedly until the warnings go away). <i>package.drv</i>; if such a thing appears, process it in preference to the <i>package.dtx</i> (it seems that when the documented LaTeX source mechanism was first discussed, the <i>.drv</i> mechanism was -suggested, but it’s not widely used nowadays). -<p/>Sometimes, the LaTeX run will complain that it can’t find +suggested, but it’s not widely used nowadays). +<p/>Sometimes, the LaTeX run will complain that it can’t find <i>package.ind</i> (the code line index) and/or <i>package.gls</i> (the list of change records, not as you might imagine, a glossary). Both types of file are processed with special <i>makeindex</i> @@ -31,12 +31,12 @@ makeindex -s gglo -o package.gls package.glo </blockquote><p> This author finds that the second (the change record) is generally of limited utility when reading package documentation; it is, however, -valuable if you’re part of the package development team. If you don’t +valuable if you’re part of the package development team. If you don’t feel you need it, just leave out that step <p/>Another common (and reasonable) trick performed by package authors is to provide a separate file <i>package-doc.tex</i> or even simply -<i>manual.tex</i>; if the file <i>package.dtx</i> doesn’t help, simply +<i>manual.tex</i>; if the file <i>package.dtx</i> doesn’t help, simply look around for such alternatives. The files are treated in the same -way as any “ordinary” LaTeX file. +way as any “ordinary” LaTeX file. <p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=install-doc">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=install-doc</a> </body> |