summaryrefslogtreecommitdiff
path: root/Master/texmf-doc/doc/english/FAQ-en/html/FAQ-dtx.html
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-doc/doc/english/FAQ-en/html/FAQ-dtx.html')
-rw-r--r--Master/texmf-doc/doc/english/FAQ-en/html/FAQ-dtx.html37
1 files changed, 18 insertions, 19 deletions
diff --git a/Master/texmf-doc/doc/english/FAQ-en/html/FAQ-dtx.html b/Master/texmf-doc/doc/english/FAQ-en/html/FAQ-dtx.html
index 35bea68fcd6..e22c17504e6 100644
--- a/Master/texmf-doc/doc/english/FAQ-en/html/FAQ-dtx.html
+++ b/Master/texmf-doc/doc/english/FAQ-en/html/FAQ-dtx.html
@@ -2,43 +2,42 @@
<title>UK TeX FAQ -- question label dtx</title>
</head><body>
<h3>Documented LaTeX sources (<code>.dtx</code> files)</h3>
-<p>LaTeX2e, and most contributed macro packages, are now written in a
+<p/>LaTeX2e, and most contributed macro packages, are now written in a
<a href="FAQ-lit.html">literate programming style</a>, with source and
documentation in the
same file. This format, known as &lsquo;doc&rsquo;, in fact originated before the
days of the LaTeX project as one of the &ldquo;Mainz&rdquo; series of
-packages. The documented sources conventionally have the suffix
-<code>.dtx</code>, and should normally be stripped of documentation
-before use with LaTeX. Alternatively you can run LaTeX on a
+packages. A documented source file conventionally has the suffix
+<code>.dtx</code>, and will normally be &lsquo;stripped&rsquo; before use with
+LaTeX; an installation file (<code>.ins</code>) is normally provided,
+to automate this process of removing comments for speed of loading.
+To read the comments, you can run LaTeX on the
<code>.dtx</code> file to produce a nicely formatted version of the
-documented code. An installation script (with suffix
-<code>.ins</code>) is usually provided, which needs the standard LaTeX2e
-<i>docstrip</i> package (among other things, the installation
-process strips all the comments that make up the documentation for
-speed when loading the file into a running LaTeX system). Several
-packages can be included in one <code>.dtx</code> file, with conditional
-sections, and there facilities for indices of macros etc. Anyone can
-write <code>.dtx</code> files; the format is explained in
-<a href="FAQ-books.html">The LaTeX Companion</a>, and a tutorial is
-available from CTAN (which comes with skeleton <code>.dtx</code> and
+documented code. Several
+packages can be included in one <code>.dtx</code> file (they&rsquo;re sorted
+out by the <code>.ins</code> file), with conditional
+sections, and there are facilities for indexes of macros, etc.
+<p/>Anyone can write <code>.dtx</code> files; the format is explained in
+<a href="FAQ-books.html">The LaTeX Companion</a>, and a tutorial is available
+from CTAN (which comes with skeleton <code>.dtx</code> and
<code>.ins</code> files).
-<p>Composition of <code>.dtx</code> files is supported in <i>emacs</i> by
+<p/>Composition of <code>.dtx</code> files is supported in <i>emacs</i> by
Matt Swift&rsquo;s <i>swiftex</i> system: it provides a
<code>doc-tex</code> mode which treats <code>.dtx</code> files rather
better than <a href="FAQ-editors.html">AUC-TeX</a> manages.
-<p>Another useful way of generating <code>.dtx</code> files is to write the
+<p/>Another useful way of generating <code>.dtx</code> files is to write the
documentation and the code separately, and then to combine them using
the <i>makedtx</i> system. This technique has particular value in
that the documentation file can be used separately to generate
HTML output; it is often quite difficult to make
<a href="FAQ-LaTeX2HTML.html">LaTeX to HTML conversion</a> tools deal
with <code>.dtx</code> files, since they use an unusual class file.
-<p><code>.dtx</code> files are not used by LaTeX after they have been
+<p/>The <code>.dtx</code> files are not used by LaTeX after they have been
processed to produce <code>.sty</code> or <code>.cls</code> (or whatever)
files. They need not be kept with the working system; however, for
many packages the <code>.dtx</code> file is the primary source of
documentation, so you may want to keep <code>.dtx</code> files elsewhere.
-<p>An interesting sideline to the story of <code>.dtx</code> files is the
+<p/>An interesting sideline to the story of <code>.dtx</code> files is the
<i>docmfp</i> package, which extends the model of the <i>doc</i>
package to <a href="FAQ-MF.html">Metafont</a> and
<a href="FAQ-MP.html">MetaPost</a>,
@@ -52,5 +51,5 @@ Metafont and MetaPost together with related LaTeX code.
<dt><tt><i>makedtx</i></tt><dd><a href="ftp://cam.ctan.org/tex-archive/support/makedtx.zip">support/makedtx</a> (<a href="ftp://cam.ctan.org/tex-archive/support/makedtx.tar.gz">gzipped tar</a>, <a href="http://www.tex.ac.uk/tex-archive/support/makedtx/">browse</a>)
<dt><tt><i>swiftex.el</i></tt><dd><a href="ftp://cam.ctan.org/tex-archive/support/emacs-modes/swiftex.zip">support/emacs-modes/swiftex</a> (<a href="ftp://cam.ctan.org/tex-archive/support/emacs-modes/swiftex.tar.gz">gzipped tar</a>, <a href="http://www.tex.ac.uk/tex-archive/support/emacs-modes/swiftex/">browse</a>)
</dl>
-<p><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dtx">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dtx</a>
+<p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dtx">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=dtx</a>
</body>