diff options
Diffstat (limited to 'Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex')
-rw-r--r-- | Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex | 86 |
1 files changed, 46 insertions, 40 deletions
diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex index e85707b25f2..ddf243bb948 100644 --- a/Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex +++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex @@ -1,4 +1,4 @@ -% $id:$ +% $Id: faq-docs.tex,v 1.15 2011/02/10 23:01:29 rf10 Exp rf10 $ \section{Documentation and Help} @@ -78,7 +78,7 @@ For \LaTeX{}, see: \item[The \LaTeX{} Graphics Companion:]% \emph{Illustrating documents with \TeX{} and \PS{}} by Michel Goossens, Sebastian Rahtz, Frank Mittelbach, Denis Roegel and - Herbert Vo\ss{} (second edition, Addison-Wesley, 2007, + Herbert Vo\ss {} (second edition, Addison-Wesley, 2007, \ISBN*{0-321-50892-0}{978-0-321-50892-8}) \item[The \LaTeX{} Web Companion:]% \emph{Integrating \TeX{}, \acro{HTML} and \acro{XML}} by Michel @@ -241,7 +241,7 @@ Both the Francophone \TeX{} user group Gutenberg and the Czech/Slovak user group CS-TUG have published translations of this \acro{FAQ}, with extensions appropriate to their languages. -Herbert Vo\ss{}'s excellent % beware line break +Herbert Vo\ss {}'s excellent % beware line break \href{http://texnik.de/}{\LaTeX{} tips and tricks} provides excellent advice on most topics one might imagine (though it's not strictly a \acro{FAQ})~--- highly recommended for most @@ -300,7 +300,7 @@ Each catalogue entry has a brief description of the package, and links to any known documentation on the net. In fact, a large proportion of \acro{CTAN} package directories now include documentation, so it's often worth looking at the catalogue entry for a package you're considering -using (where possible, each in package link in the main body of these +using (where possible, each package link in the main body of these \acro{FAQ}s \hyperflat{has a link to}{shows the \acro{URL} of} the relevant catalogue entry). @@ -310,7 +310,7 @@ newsgroup \Newsgroup{comp.text.tex} via \href{http://groups.google.com/group/comp.text.tex}{Google groups}, and the mailing list \texttt{texhax} via its \href{http://tug.org/pipermail/texhax/}{archive}, or (as a long shot) -the archives of ancient posts on \acro{CTAN}. +the archives of its ancient posts on \acro{CTAN}. If those ``back question'' searches fail, you'll have to ask the world at large. To ask a question on \Newsgroup{comp.text.tex}, you can use @@ -321,6 +321,13 @@ To ask a question on \texttt{texhax}, you may simply send mail to list (via \URL{http://tug.org/mailman/listinfo/texhax}) % ! no ~ on this line first~--- not everyone will answer to you as well as to the list. +Other alternative sources are the % ! line break +\href{http://www.latex-community.org/}{``\LaTeX{} community'' site} or +\href{http://tex.stackexchange.com/}{\TeX{}, \LaTeX{} and friends Q\&A site}. +Neither of these is particularly long-established (the ``friends'' +site is still in \latexhtml{\ensuremath{\beta}-state}{beta state} at +the time of writing), but they're already popular and helpful. + Do \textbf{not} try mailing the % ! line break \Qref*{\LaTeX{} project team}{Q-LaTeX3}, the maintainers of the \texlive{} or \miktex{} distributions @@ -642,7 +649,7 @@ available (in several formats) via \URL{http://www.ams.org/tex/amslatex.html} (the ``Additional Documentation'' about half-way down the page. -Herbert Vo\ss{} has written an extensive guide to mathematics in +Herbert Vo\ss {} has written an extensive guide to mathematics in \LaTeX{} (a German version of which is published as a book). The guide is part of his ``\Qref*{tips and tricks}{Q-doc-dirs}'' and a copy is maintained on \acro{CTAN}. @@ -742,7 +749,7 @@ deparment's pages at \begin{ctanrefs} \item[\nothtml{\rmfamily}Graphics in \LaTeXe{}]\CTANref{epslatex} \item[testflow]\CTANref{testflow} -\item[\nothtml{\rmfamily}Herbert Vo\ss{}'s Maths tutorial]\CTANref{voss-mathmode} +\item[\nothtml{\rmfamily}Herbert Vo\ss {}'s Maths tutorial]\CTANref{voss-mathmode} \end{ctanrefs} \Question[Q-ref-doc]{Reference documents} @@ -765,20 +772,20 @@ basic \LaTeX{} use. (It's laid out very compactly for printing on N.\ American `letter'; printed on \acro{ISO} \acro{A}4, using Adobe Acrobat's ``shrink to fit'', it strains aged eyes\dots{}) -Similarly, there's no completely reliable command-organised reference -to \LaTeX{}. The page (provided by \acro{NASA}) % ! line break -\href{http://www.giss.nasa.gov/latex/}{Hypertext Help with LaTeX} is -recently much improved. It still talks in \LaTeXo{}-isms in places, -but it's been updated for current \LaTeX{}. There are a number of -mirrors of the site, and it may be worth choosing a ``local'' one if -you're going to use it a lot. +For command organised references to \LaTeX{}, Karl Berry (et +al)'s % !line break +\href{http://home.gna.org/latexrefman}{LaTeX reference manual} is (to +an extent) work in progress, but is generally reliable. -Another \LaTeXe{} reference (provided by the Emerson Center of Emory -University) is: % ! line break +The reference provided by the Emerson Center of Emory +University), % ! line break \href{http://www.emerson.emory.edu/services/latex/latex2e/latex2e_toc.html}{LaTeXe help} +also looks good. \begin{ctanrefs} \item[\nothtml{\rmfamily}Cheat sheet]\CTANref{latexcheat} +\item[\nothtml{\rmfamily}LaTeX reference manual]\CTANref{latex2e-help-texinfo} \end{ctanrefs} +\LastEdit{2010-12-08} \Question[Q-doc-wiki]{\acro{WIKI} books for \TeX{} and friends} @@ -798,10 +805,12 @@ they both seem useful reference sources. \Question[Q-typo-style]{Typography tutorials} -Peter Wilson's manual for his \Class{memoir} class has a lengthy -introductory section on typographic considerations, which is a fine -tutorial, written by someone who is aware of the issues as they apply -to \AllTeX{} users. +Peter Wilson's article \Package{memdesign} has a lengthy introductory +section on typographic considerations, which is a fine tutorial, +written by someone who is aware of the issues as they apply to +\AllTeX{} users. (\Package{Memdesign} now distributed separately from +the manual for his \Class{memoir} class, but was originally part of +that manual) There's also (at least one) typographic style tutorial available on the Web, the excellent % ! line break @@ -816,7 +825,7 @@ ambition to supplant such excellent books as contain its Rutgers-local matter) is a fine introduction to the issues of producing readable documents. \begin{ctanrefs} -\item[memoir \nothtml{\rmfamily}distribution]\CTANref{memoir} +\item[memdesign]\CTANref{memdesign} \end{ctanrefs} \Question[Q-doc-dirs]{Directories of \AllTeX{} information} @@ -829,10 +838,6 @@ set comprises two parts, ``Text'' and ``Graphics'', so far. Once, there were other links like that, but all the others have faded away, leaving the \acro{TUG} India set in splendid isolation. -% Herbert Vo\ss{}'s excellent % beware line break -% \href{http://texnik.de/}{\LaTeX{} tips and tricks} is an excellent -% source of small articles on the use of \LaTeX{}. - \Question[Q-ol-books]{Freely available \AllTeX{} books} People have long argued for \AllTeX{} books to be made available on @@ -1039,33 +1044,34 @@ written more as a document, and presented in \acro{PDF}. \item[\nothtml{\rmfamily}Vincent Zoonekynd's examples]\CTANref{zoon-mp-eg} \end{ctanrefs} -\Question[Q-BibTeXing]{\BibTeX{} Documentation} +\Question[Q-BibTeXing]{\bibtex{} Documentation} -\BibTeX{}, a program originally designed to produce bibliographies in +\bibtex{}, a program originally designed to produce bibliographies in conjunction with \LaTeX{}, is explained in Section~4.3 and Appendix~B of Leslie Lamport's \LaTeX{} manual. -The document ``\BibTeX{}ing'', contained in the file \File{btxdoc.tex}, +The document ``\bibtex{}ing'', in the \bibtex{} distribution (look for +\File{btxdoc}), expands on the chapter in Lamport's book. \emph{The \LaTeX{} Companion} -also has information on \BibTeX{} and writing \BibTeX{} style files. +also has information on \bibtex{} and writing \bibtex{} style files. (See \Qref[question]{TeX-related books}{Q-books} for details of both books.) -The document ``Designing \BibTeX{} Styles'', contained in the file -\File{btxhak.tex}, explains the postfix stack-based language used to -write \BibTeX{} styles (\File{.bst} files). The file \File{btxbst.doc} +The document ``Designing \bibtex{} Styles'', also in the \bibtex{} +distribution (look for +\File{btxhak}, explains the postfix stack-based language used to +write \bibtex{} styles (\File{.bst} files). The file\File{btxbst.doc}, +also in the \bibtex{} distribution, is the template for the four standard styles (\Package{plain}, -\Package{abbrv}, \Package{alpha}, and \Package{unsrt}). It also -contains their documentation. The complete \BibTeX{} documentation -set (including all the files above) is available on \acro{CTAN}. +\Package{abbrv}, \Package{alpha}, and \Package{unsrt}); it also +contains their documentation. A useful tutorial of the whole process of using \BibTeX{} is Nicolas Markey's ``\emph{Tame the BeaST (The B to X of \BibTeX{})}'', which -may also be found on \acro{CTAN}. A summary and \acro{FAQ} -(\File{btxFAQ}), by Michael Shell and David Hoadley, is also to be -recommended. +may also be found on \acro{CTAN}. A summary and \acro{FAQ} by Michael +Shell and David Hoadley, is also to be recommended. \begin{ctanrefs} -\item[\nothtml{\rmfamily}\BibTeX{} documentation]\CTANref{bibtex-doc} -\item[btxFAQ.pdf]\CTANref{bibtex-faq} +\item[\nothtml{\rmfamily}\BibTeX{} distribution]\CTANref{bibtex} +\item[\nothtml{\rmfamily}Shell and Hoadley's FAQ]\CTANref{bibtex-faq} \item[\nothtml{\rmfamily}Tame the BeaST]\CTANref{ttb-pdf} \end{ctanrefs} |