summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-install-doc.html
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-05-22 23:51:44 +0000
committerKarl Berry <karl@freefriends.org>2009-05-22 23:51:44 +0000
commit566f5207d7e3cafb0633d31277067336ccd9cca7 (patch)
tree7af53e7ac405185168bc1dc38c4e820f442b78d0 /Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-install-doc.html
parentb0beea26ffffd915bb6d9b82f2d65a0a05b7e23b (diff)
move generic english documents out of texmf-doc
git-svn-id: svn://tug.org/texlive/trunk@13396 c570f23f-e606-0410-a88d-b1316a301751
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.html42
1 files changed, 42 insertions, 0 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
new file mode 100644
index 00000000000..b0248ad8f6e
--- /dev/null
+++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-install-doc.html
@@ -0,0 +1,42 @@
+<head>
+<title>UK TeX FAQ -- question label install-doc</title>
+</head><body>
+<h3>Generating package documentation</h3>
+<p/>We are faced with a range of &ldquo;normal&rdquo; 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 &mdash; 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
+yourself from what you download from the archive.
+<p/>The standard mechanism, for LaTeX packages, is simply to run
+LaTeX on the <i>package.dtx</i> file, as you would any ordinary
+LaTeX file (i.e., repeatedly until the warnings go away).
+<p/>A variant is that the unpacking process provides a file
+<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&rsquo;s not widely used nowadays).
+<p/>Sometimes, the LaTeX run will complain that it can&rsquo;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>
+style files; appropriate commands are:
+<blockquote>
+<pre>
+makeindex -s gind package
+makeindex -s gglo -o package.gls package.glo
+</pre>
+</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&rsquo;re part of the package development team. If you don&rsquo;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&rsquo;t help, simply
+look around for such alternatives. The files are treated in the same
+way as any &ldquo;ordinary&rdquo; 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>