summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkgdoc.html
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkgdoc.html')
-rw-r--r--Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkgdoc.html26
1 files changed, 13 insertions, 13 deletions
diff --git a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkgdoc.html b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkgdoc.html
index 3ef56eb782f..7912235fa05 100644
--- a/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkgdoc.html
+++ b/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-pkgdoc.html
@@ -2,12 +2,12 @@
<title>UK TeX FAQ -- question label pkgdoc</title>
</head><body>
<h3>Documentation of packages</h3>
-<p/>These FAQs regularly suggest packages that will &ldquo;solve&rdquo;
+<p/>These FAQs regularly suggest packages that will &#8220;solve&#8221;
particular problems. In some cases, the answer provides a recipe for
the job. In other cases, or when the solution needs elaborating, how
is the poor user to find out what to do?
-<p/>If you&rsquo;re lucky, the package you need is already in your installation.
-If you&rsquo;re particularly lucky, you&rsquo;re using a distribution that gives
+<p/>If you&#8217;re lucky, the package you need is already in your installation.
+If you&#8217;re particularly lucky, you&#8217;re using a distribution that gives
access to package documentation and the documentation is available in
a form that can easily be shown. For example, on many current
distributions, the <i>texdoc</i> command often helps, as in:
@@ -20,14 +20,14 @@ which opens a window showing documentation of the
<i>footmisc</i> package. According to the type of file
<i>texdoc</i> finds, it will launch a DVI viewer
or a PDF reader.
-<p/>If <i>texdoc</i> can&rsquo;t find any documentation, it may launch a Web
+<p/>If <i>texdoc</i> can&#8217;t find any documentation, it may launch a Web
browser to look at its copy of the CTAN catalogue. The
catalogue has an entry for package documentation, and since the
CTAN team asks authors documentation of their packages (and
members of the team even occasionally generate documentation that
seems useful), you will more often than not find documentation that
way.
-<p/>If your luck (as defined above) doesn&rsquo;t hold out, you&rsquo;ve got to find
+<p/>If your luck (as defined above) doesn&#8217;t hold out, you&#8217;ve got to find
documentation by other means. This is where you need to exercise your
intelligence: you have to find the documentation for yourself. What
follows offers a range of possible techniques.
@@ -44,7 +44,7 @@ latter case, the <code>.ins</code> file will usually produce a
LaTeX instead. (Sometimes the package author even thinks to
mention this wrinkle in a package <code>README</code> file.)
<p/>Another common form is the separate documentation file; particularly
-if a package is &ldquo;conceptually large&rdquo; (and therefore needs a lot of
+if a package is &#8220;conceptually large&#8221; (and therefore needs a lot of
documentation), the documentation would prove a cumbersome extension
to the <code>.dtx</code> file. Examples of such cases are the <i>memoir</i>
class (whose documentation, <i>memman</i>, is widely praised as an
@@ -59,15 +59,15 @@ existence.
Such documentation ordinarily appears in comments at the head of the
file, though at least one eminent author regularly places it after the
<code>\</code><code>endinput</code> command in the package. (This is desirable, since
-<code>\</code><code>endinput</code> is a &lsquo;logical&rsquo; end-of-file, and (La)TeX doesn&rsquo;t read
-beyond it: thus such documentation does not &lsquo;cost&rsquo; any package loading time.)
+<code>\</code><code>endinput</code> is a &#8216;logical&#8217; end-of-file, and (La)TeX doesn&#8217;t read
+beyond it: thus such documentation does not &#8216;cost&#8217; any package loading time.)
<p/>The above suggestions cover most possible ways of finding
-documentation. If, despite your best efforts, you can&rsquo;t find
-it in any of the above places, there&rsquo;s the awful possibility that the
-author didn&rsquo;t bother to document his package (on the &ldquo;if it was hard
-to write, it should be hard to use&rdquo; philosophy). Most ordinary
+documentation. If, despite your best efforts, you can&#8217;t find
+it in any of the above places, there&#8217;s the awful possibility that the
+author didn&#8217;t bother to document his package (on the &#8220;if it was hard
+to write, it should be hard to use&#8221; philosophy). Most ordinary
mortals will seek support from some more experienced user at this
stage, though it <em>is</em> possible to proceed in the way that the original
-author apparently expected&hellip;by reading his code.
+author apparently expected&#8230;by reading his code.
<p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=pkgdoc">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=pkgdoc</a>
</body>