diff options
Diffstat (limited to 'Master/texmf-dist/doc/generic/FAQ-en/faq-how-do-i.tex')
| -rw-r--r-- | Master/texmf-dist/doc/generic/FAQ-en/faq-how-do-i.tex | 155 |
1 files changed, 70 insertions, 85 deletions
diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-how-do-i.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-how-do-i.tex index 40d334a538d..af25715e63a 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-how-do-i.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-how-do-i.tex @@ -1,4 +1,4 @@ -% $Id: faq-how-do-i.tex,v 1.7 2010/01/19 22:44:39 rf10 Exp rf10 $ +% $Id: faq-how-do-i.tex,v 1.13 2010/04/02 18:20:00 rf10 Exp rf10 $ \section{How do I do\dots{}?} @@ -37,7 +37,7 @@ The \cmdinvoke{tag*}{\csx{qedhere}} construction may be used in any of \AMSLaTeX{}'s numbering environments. \begin{ctanrefs} \item[amsthm.sty]Distributed as part of the \AMSLaTeX{} bundle - \CTANref{amslatex} + \CTANref{amslatex}[amsthm] \item[ntheorem.sty]\CTANref{ntheorem} \end{ctanrefs} @@ -71,9 +71,9 @@ Alternatively, the following sets up an environment The \Package{ntheorem} package provides control of the fonts used by theorems, directly. \begin{ctanrefs} -\item[amsthm.sty]Distributed as part of \CTANref{amslatex} +\item[amsthm.sty]Distributed as part of \CTANref{amslatex}[amsthm] \item[ntheorem.sty]\CTANref{ntheorem} -\item[theorem.sty]Distributed as part of \CTANref{2etools} +\item[theorem.sty]Distributed as part of \CTANref{2etools}[theorem] \end{ctanrefs} \Question[Q-newfunction]{Defining a new log-like function in \LaTeX{}} @@ -136,7 +136,8 @@ As with \csx{DeclareMathOperator} there's a starred version (It should be noted that ``log-like'' was reportedly a \emph{joke} on Lamport's part; it is of course clear what was meant.) \begin{ctanrefs} -\item[amsopn.sty]In the \AMSLaTeX{} distribution \CTANref{amslatex} +\item[amsopn.sty]Distributed as part of the \AMSLaTeX{} distribution + \CTANref{amslatex}[amsopn] \end{ctanrefs} \Question[Q-braket]{Set specifications and Dirac brackets} @@ -484,19 +485,13 @@ signs): \end{flalign} \end{verbatim} \end{quote} - -Comprehensive documentation of \AMSLaTeX{} is to be found in -\File{amsldoc}, in the distribution; it is also available on the web -at \URL{ftp://ftp.ams.org/pub/tex/doc/amsmath/amsldoc.pdf} \begin{ctanrefs} -\item[amsldoc.tex]Distributed as part of \AMSLaTeX{} - \CTANref{amslatex} \item[amsmath.sty]Distributed as part of \AMSLaTeX{} - \CTANref{amslatex} + \CTANref{amslatex}[amsmath] \item[amstext.sty]Distributed as part of \AMSLaTeX{} - \CTANref{amslatex} + \CTANref{amslatex}[amstext] \item[mathtools.sty]Distributed as part of the \Package{mh} bundle - \CTANref{mh} + \CTANref{mh}[mathtools] \end{ctanrefs} \Question[Q-reuseq]{Re-using an equation} @@ -523,15 +518,9 @@ Remember that Here, the second instance of \ensuremath{a=b} will be typeset with a copy, made by the \csx{tag} command, of the label of the first instance. - -Comprehensive documentation of \AMSLaTeX{} is to be found in -\File{amsldoc}, in the distribution; it is also available on the web -at \URL{ftp://ftp.ams.org/pub/tex/doc/amsmath/amsldoc.pdf} \begin{ctanrefs} -\item[amsldoc.tex]Distributed as part of \AMSLaTeX{} - \CTANref{amslatex} \item[amsmath.sty]Distributed as part of \AMSLaTeX{} - \CTANref{amslatex} + \CTANref{amslatex}[amsmath] \end{ctanrefs} \Question[Q-brkinline]{Line-breaking in in-line maths} @@ -608,7 +597,7 @@ operation, only those equations to which you make reference will be numbered in the final output. See the package's documentation for details of how to make references when the switch is in effect. \begin{ctanrefs} -\item[mathtools.sty]Distributed as part of \CTANref{mh} +\item[mathtools.sty]Distributed as part of \CTANref{mh}[mathtools] \end{ctanrefs} \subsection{Lists} @@ -707,7 +696,7 @@ The \Class{memoir} class includes functions that match those in the %% larger than the default, you should also change \csx{leftmargini}, %% \csx{leftmarginii}, \emph{etc}. \begin{ctanrefs} -\item[enumerate.sty]Distributed as part of \CTANref{2etools} +\item[enumerate.sty]Distributed as part of \CTANref{2etools}[enumerate] \item[enumitem.sty]\CTANref{enumitem} \item[memoir.cls]\CTANref{memoir} \item[paralist.sty]\CTANref{paralist} @@ -817,11 +806,11 @@ to set spacing between items and between paragraphs within items. more ``basic'' (and therefore more flexible) manner than the % ! line break \Qref*{\Package{enumerate} package}{Q-enumerate} does. \begin{ctanrefs} -\item[enumerate.sty]Distributed as part of \CTANref{2etools} +\item[enumerate.sty]Distributed as part of \CTANref{2etools}[enumitem] \item[enumitem.sty]\CTANref{enumitem} \item[expdlist.sty]\CTANref{expdlist} \item[memoir.cls]\CTANref{memoir} -\item[mdwlist.sty]Distributed as part of \CTANref{mdwtools} +\item[mdwlist.sty]Distributed as part of \CTANref{mdwtools}[mdwlist] \item[multenum.sty]\CTANref{multenum} \item[paralist.sty]\CTANref{paralist} \item[savetrees.sty]\CTANref{savetrees} @@ -966,10 +955,10 @@ However, the `nested comment' interpolated in the nested enumeration appears as if it were a second paragraph to ``outer item 2'', which is hardly satisfactory. \begin{ctanrefs} -\item[enumerate.sty]Distributed as part of \CTANref{2etools} +\item[enumerate.sty]Distributed as part of \CTANref{2etools}[enumerate] \item[enumitem.sty]\CTANref{enumitem} \item[expdlist.sty]\CTANref{expdlist} -\item[mdwlist.sty]Distributed as part of \CTANref{mdwtools} +\item[mdwlist.sty]Distributed as part of \CTANref{mdwtools}[mdwlist] \end{ctanrefs} \subsection{Tables, figures and diagrams} @@ -1115,8 +1104,8 @@ should process using \LaTeX{}. Processing will give you a \File{.sty} file as well as the \File{.dvi} or \File{.pdf} output containing the documentation. \begin{ctanrefs} -\item[ltxtable.sty]Distributed as part of \CTANref{carlisle} -\item[tabularx.sty]Distributed as part of \CTANref{2etools} +\item[ltxtable.sty]Distributed as part of \CTANref{carlisle}[ltxtable] +\item[tabularx.sty]Distributed as part of \CTANref{2etools}[tabularx] \item[tabulary.sty]\CTANref{tabulary} \end{ctanrefs} @@ -1177,7 +1166,7 @@ or you can use it as follows: where the second column will end up noticeably wider, and will wrap to a second line in the third row. \begin{ctanrefs} -\item[array.sty]Distributed as part of \CTANref{2etools} +\item[array.sty]Distributed as part of \CTANref{2etools}[array] \item[varwidth.sty]\CTANref{varwidth} \end{ctanrefs} @@ -1254,12 +1243,9 @@ interesting. The package provides rule commands to support the author's scheme, but deals with inter-row spacing too. The most recent release of \Package{booktabs} sports compatibility with packages such as \Package{longtable}. - -Documentation of both \Package{bigstrut} and \Package{tabls} may be -found as comments in the package files themselves. \begin{ctanrefs} -\item[array.sty]Distributed as part of \CTANref{2etools} -\item[bigstrut.sty]Distributed as part of \CTANref{multirow} +\item[array.sty]Distributed as part of \CTANref{2etools}[array] +\item[bigstrut.sty]\CTANref{bigstrut} \item[booktabs.sty]\CTANref{booktabs} \item[cellspace.sty]\CTANref{cellspace} \item[tabls.sty]\CTANref{tabls} @@ -1329,10 +1315,10 @@ the head- and footline capabilities of the major packages. Documentation of \Package{ltablex} is to be found in the package file. \begin{ctanrefs} -\item[longtable.sty]Distributed as part of \CTANref{2etools} +\item[longtable.sty]Distributed as part of \CTANref{2etools}[longtable] \item[ltablex.sty]\CTANref{ltablex} \item[ltxtable.sty]Generate by running \CTANref{ltxtable} -\item[stabular.sty]Distributed as part of \CTANref{sttools} +\item[stabular.sty]Distributed as part of \CTANref{sttools}[stabular] \item[supertabular.sty]\CTANref{supertabular} \item[xtab.sty]\CTANref{xtab} \end{ctanrefs} @@ -1358,17 +1344,16 @@ arises in the last cell of a row: since each cell is set into a box, its settings are lost at the \texttt{\&} (or \texttt{\bsbs }) that terminates it. - -The technique using \csx{PBS} was developed in the days of \LaTeXo{} -because the actual value of \texttt{\bsbs } that the \environment{tabular} -environment uses was only available as an internal command. Nowadays, -the value is a public command, and you can in principle use it -explicitly: +In the old days, the actual value of \texttt{\bsbs } that the +\environment{tabular} environment uses was only available as an +internal command. Nowadays, the value is a public command, and you +can in principle use it explicitly: \begin{quote} \begin{verbatim} ... & \centering blah ... \tabularnewline \end{verbatim} \end{quote} +(but that's a rather verbose way of doing things). The \Package{array} package provides a command \csx{arraybackslash} which restores \texttt{\bsbs } to its correct (within table) meaning; @@ -1393,8 +1378,9 @@ specifications: The \csx{tabularnewline} and \csx{arraybackslash} commands are (somewhat) modern additions to \LaTeX{} and the \Package{array} -package, respectively. If neither is available, the user may try the -(old) solution which preserves the meaning of \texttt{\bsbs }: +package, respectively. In the unlikely event that neither is +available, the user may try the (old) solution which preserves the +meaning of \texttt{\bsbs }: \begin{quote} \begin{verbatim} \newcommand\PBS[1]{\let\temp=\\% @@ -1416,7 +1402,7 @@ or in the preamble as: \end{verbatim} \end{quote} \begin{ctanrefs} -\item[array.sty]Distributed as part of \CTANref{2etools} +\item[array.sty]Distributed as part of \CTANref{2etools}[array] \end{ctanrefs} \nothtml{\vskip 0pt plus 4ex} @@ -1700,7 +1686,7 @@ The \Package{array} package works with several other example \environment{longtable}), but unfortunately this trick won't always work. \begin{ctanrefs} -\item[array.sty]Distributed as part of \CTANref{2etools} +\item[array.sty]Distributed as part of \CTANref{2etools}[array] \end{ctanrefs} \Question[Q-multirow]{Merging cells in a column of a table} @@ -1814,7 +1800,7 @@ rows in the multi-row have been opened up with \csx{bigstrut}. The documentation of both \Package{multirow} and \Package{bigstrut} is to be found, as comments, in the package files themselves. \begin{ctanrefs} -\item[bigstrut.sty]Distributed as part of \CTANref{multirow} +\item[bigstrut.sty]\CTANref{bigstrut} \item[multirow.sty]\CTANref{multirow} \end{ctanrefs} @@ -1984,8 +1970,8 @@ float is set \emph{before} any single column floats). something approximating the effect it would have.) \begin{ctanrefs} \item[dblfloatfix.sty]\CTANref{dblfloatfix} -\item[stfloats.sty, midfloat.sty]Distributed as part of - \CTANref{sttools} +\item[midfloat.sty]Distributed as part of \CTANref{sttools}[midfloat] +\item[stfloats.sty]Distributed as part of \CTANref{sttools}[stfloats] \end{ctanrefs} \Question[Q-mcfloat]{Floats in multicolumn setting} @@ -2018,7 +2004,7 @@ running off the end of the column at the end of the \environment{multicols} environment). \begin{ctanrefs} \item[float.sty]\CTANref{float} -\item[multicol.sty]Distributed as part of \CTANref{2etools} +\item[multicol.sty]Distributed as part of \CTANref{2etools}[multicol] \end{ctanrefs} \Question[Q-dpfloat]{Facing floats on 2-page spread} @@ -2043,9 +2029,6 @@ this: the construction to use is: \end{quote} The construction has no effect unless the standard class option \pkgoption{twoside} is in effect. - -Full documentation of the package (such as it is) is to be found in -\File{README.dpfloat} \begin{ctanrefs} \item[dpfloat.sty]\CTANref{dpfloat} \end{ctanrefs} @@ -2173,7 +2156,7 @@ and the sequence of float numbers is all correct. \item[caption.sty]\CTANref{caption} \item[float.sty]\CTANref{float} \item[here.sty]\CTANref{here} -\item[perpage.sty]Distributed as part \CTANref{bigfoot} +\item[perpage.sty]Distributed as part \CTANref{bigfoot}[perpage] \end{ctanrefs} \subsection{Footnotes} @@ -2237,12 +2220,12 @@ in ordinary text. The author of this \acro{FAQ} answer doesn't actually recommend any of them, believing that table notes are the way to go\dots{} \begin{ctanrefs} \item[ctable.sty]\CTANref{ctable} -\item[footnote.sty]Distributed as part of \CTANref{mdwtools} -\item[longtable.sty]Distributed as part of \CTANref{2etools} -\item[mdwtab.sty]Distributed as part of \CTANref{mdwtools} +\item[footnote.sty]Distributed as part of \CTANref{mdwtools}[footnote] +\item[longtable.sty]Distributed as part of \CTANref{2etools}[longtable] +\item[mdwtab.sty]Distributed as part of \CTANref{mdwtools}[mdwtab] \item[threeparttable.sty]\CTANref{threeparttable} \item[threeparttablex.sty]\CTANref{threeparttablex} -\item[tabularx.sty]Distributed as part of \CTANref{2etools} +\item[tabularx.sty]Distributed as part of \CTANref{2etools}[tabularx] \end{ctanrefs} \Question[Q-ftnsect]{Footnotes in \LaTeX{} section headings} @@ -2449,8 +2432,7 @@ also designed to support typesetting critical editions. \item[edmac]\CTANref{edmac} \item[ednotes]\CTANref{ednotes} \item[ledmac]\CTANref{ledmac} -\item[manyfoot.sty]Distributed as part of the \CTANref{ncctools} - bundle +\item[manyfoot.sty]Distributed as part of \CTANref{ncctools}[manyfoot] \end{ctanrefs} \Question[Q-footnpp]{Footnotes numbered ``per page''} @@ -2491,15 +2473,14 @@ the one package to achieve your ends. The \Package{footnpag} package also does per-page footnotes (and nothing else). With the competition from \Package{perpage}, it's -probably not particularly useful any more. (Documentation is -\File{footnpag-user.pdf} in the distribution.) +probably not particularly useful any more. \begin{ctanrefs} \item[footmisc.sty]\CTANref{footmisc} \item[footnpag.sty]\CTANref{footnpag} -\item[perpage.sty]Distributed as part \CTANref{bigfoot} -\item[zref.sty]Distributed as a collection member in \CTANref{oberdiek} -\item[zref-perpage.sty]Distributed as a collection member in - \CTANref{oberdiek} +\item[perpage.sty]Distributed as part \CTANref{bigfoot}[perpage] +\item[zref.sty]Distributed as part of \CTANref{oberdiek}[zref] +\item[zref-perpage.sty]Distributed as part of \Package{zref} in + \CTANref{oberdiek}[zref] \end{ctanrefs} \Question[Q-run-fn-nos]{Not resetting footnote numbers per chapter} @@ -2643,13 +2624,19 @@ be used as a check-list in case that problems arise. Note that \csx{listfiles} only registers things that are input by the ``standard'' \LaTeX{} mechanisms (\csx{documentclass}, \csx{usepackage}, -\csx{input}, \csx{include}, \csx{includegraphics} and so on). But if you -use \TeX{} primitive syntax, as in +\csx{include}, \csx{includegraphics} and so on). +The \csx{input} command, as modified by \LaTeX{} and used, with +\LaTeX{} syntax, as: +\begin{verbatim} + \input{mymacros} +\end{verbatim} +records file details for \File{mymacros.tex}, but if you use \TeX{} +primitive syntax for \csx{input}, as: \begin{verbatim} \input mymacros \end{verbatim} -\File{mymacros.tex} \emph{won't} be listed by \csx{listfiles}, since -you've bypassed the mechanism that records its use. +\File{mymacros.tex} \emph{won't} be recorded, and so won't listed by +\csx{listfiles}~--- you've bypassed the mechanism that records its use. The \Package{snapshot} package helps the owner of a \LaTeX{} document obtain a list of the external dependencies of the document, in a form @@ -2923,21 +2910,19 @@ including (numeric or labelled) ranges of environments to extract, and an \environment{extract} environment which you can use to create complete ready-to-run \LaTeX{} documents with stuff you've extracted. \begin{ctanrefs} -\item[askinclude.sty]Distributed with Heiko Oberdiek's packages~--- - \CTANref{oberdiek} +\item[askinclude.sty]Distributed as part of \CTANref{oberdiek}[askinclude] \item[comment.sty]\CTANref{comment} \item[excludeonly.sty]\CTANref{excludeonly} \item[extract.sty]\CTANref{extract} \item[memoir.cls]\CTANref{memoir} \item[optional.sty]\CTANref{optional} -\item[pagesel.sty]Distributed with Heiko Oberdiek's packages~--- - \CTANref{oberdiek} +\item[pagesel.sty]Distributed as part of \CTANref{oberdiek}[pagesel] \item[pdfpages.sty]\CTANref{pdfpages} \item[selectp.sty]\CTANref{selectp} -\item[verbatim.sty]Distributed as part of \CTANref{2etools} +\item[verbatim.sty]Distributed as part of \CTANref{2etools}[verbatim] \item[version.sty]\CTANref{version} \item[versions.sty]\CTANref{versions} -\item[xcomment.sty]Distributed as part of \CTANref{seminar} +\item[xcomment.sty]Distributed as part of \CTANref{seminar}[xcomment] \end{ctanrefs} \Question[Q-docotherdir]{Bits of document from other directories} @@ -3031,8 +3016,8 @@ following minimal solution: \begin{wideversion} \begin{verbatim} \def\RCS$#1: #2 ${\expandafter\def\csname RCS#1\endcsname{#2}} -\RCS$Revision: 1.7 $ % or any RCS keyword -\RCS$Date: 2010/01/19 22:44:39 $ +\RCS$Revision: 1.13 $ % or any RCS keyword +\RCS$Date: 2010/04/02 18:20:00 $ ... \date{Revision \RCSRevision, \RCSDate} \end{verbatim} @@ -3042,8 +3027,8 @@ following minimal solution: \def\RCS$#1: #2 ${\expandafter \def\csname RCS#1\endcsname{#2}% } -\RCS$Revision: 1.7 $ % or any RCS keyword -\RCS$Date: 2010/01/19 22:44:39 $ +\RCS$Revision: 1.13 $ % or any RCS keyword +\RCS$Date: 2010/04/02 18:20:00 $ ... \date{Revision \RCSRevision, \RCSDate} \end{verbatim} @@ -3188,8 +3173,8 @@ to the equivalent of the \texttt{LastPage} label and the Both \Package{count1to} and \Package{totpages} need the support of the \Package{everyshi} package. \begin{ctanrefs} -\item[count1to.sty \nothtml{\bgroup\rmfamily}and\nothtml{\egroup} everyshi.sty]% line break!! - Distributed in \CTANref{ms} +\item[count1to.sty]Distributed as part of \CTANref{ms}[count1to] +\item[everyshi.sty]Distributed as part of \CTANref{ms}[everyshi] \item[lastpage.sty]\CTANref{lastpage} \item[memoir.cls]\CTANref{memoir} \item[totpages.sty]\CTANref{totpages} @@ -3221,7 +3206,7 @@ The package is known to fail, for example, with documents that use All these things can be overcome (although it's not often easy), but the environment saves a lot of work on many occasions. \begin{ctanrefs} -\item[plain.sty]Distributed as part of \CTANref{carlisle} +\item[plain.sty]Distributed as part of \CTANref{carlisle}[plain-ltx] \end{ctanrefs} \subsection{Hyphenation} @@ -3519,7 +3504,7 @@ and the \Package{hyphenat} package uses this technique for its \csx{nohyphens} command which sets its argument without any hyphenation. You can load \Package{hyphenat} with the command \begin{quote} - \cmdinvoke{usepckage}[none]{hyphenat} + \cmdinvoke{usepackage}[none]{hyphenat} \end{quote} to prevent any hyphenation in a single-language document. The technique cannot work in a document in which \Package{babel} controls |