summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/FAQ-en/faq-docs.tex
diff options
context:
space:
mode:
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.tex93
1 files changed, 53 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 33a819732c5..43c948b6dec 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: faq-docs.tex,v 1.29 2011/10/25 18:22:56 rf10 Exp rf10 $
+% $Id: faq-docs.tex,v 1.37 2012/02/18 19:28:56 rf10 Exp rf10 $
\section{Documentation and Help}
@@ -585,7 +585,7 @@ The above advice, differently phrased, may also be read on the web at
article may be found at \URL{http://www.minimalbeispiel.de/}, in
both German and English.
-\Question[Q-tutorials*]{\AllTeX{} Tutorials, etc.}
+\Question[Q-tutorials*]{Tutorials, etc., for \tex{}-based systems}
From a situation where every \AllTeX{} user \emph{had} to buy a book
if she was not to find herself groping blindly along, we now have what
@@ -599,10 +599,10 @@ Next comes a selection of
\Qref*{``specialised'' \AllTeX{} tutorials}{Q-tutbitslatex},
each of which concentrates on a single \LaTeX{} topic.
-A couple of reference documents (it would be good to have more) are
-listed in an \Qref*{answer of their own}{Q-ref-doc}.
+A small selection of reference documents (it would be good to have
+more) are listed in an \Qref*{answer of their own}{Q-ref-doc}.
-Next comes the (rather new) field of % ! line break
+Next comes the (somewhat newer) field of % ! line break
\Qref*{\TeX{}-related WIKIs}{Q-doc-wiki}.
A rather short list gives us a % ! line break
@@ -614,7 +614,7 @@ A rather short list gives us a % ! line break
Michael Doob's splendid `Gentle Introduction' to \plaintex{}
(available on \acro{CTAN}) has been stable for a very long time.
-Another recommendable document is D. R.~Wilkins `Getting started with \TeX{}',
+Another recommendable document is D. R.~Wilkins' `Getting started with \TeX{}',
available on the web at \URL{http://www.ntg.nl/doc/wilkins/pllong.pdf}
\begin{ctanrefs}
\item[\nothtml{\rmfamily}Gentle Introduction]\CTANref{gentle}
@@ -665,20 +665,33 @@ is a pleasing short introduction to the use of \AllTeX{}; some of the
slides for \emph{actual} tutorials are to be found on the page, as
well.
+D. R.~Wilkins' % ! line break
+\href{http://www.maths.tcd.ie/~dwilkins/LaTeXPrimer/}{`Getting started with \latex{}'}
+also looks good (it appears shorter~--- more of a primer~--- than some
+of the other offerings).
+
Chris Harrison's % ! line break
-\href{http://www.chrisharrison.co.uk/xophbook/mybooks/tex/index.html}{TeX book}
-presents basic \LaTeX{} with useful hints for extensions
+\href{http://xoph.co/20111024/latex-tutorial/}{LaTeX tutorial}
+presents basic \LaTeX{} in a rather pleasing and straightforward way.
Nicola Talbot's % ! line break
\href{http://theoval.cmp.uea.ac.uk/~nlct/latex/novices/}{\LaTeX{} for complete novices}
does what it claims: the author teaches \LaTeX{} at the University of
-East Anglia. That is one of several of Nicola's % ! line break
+East Anglia. That is one of several % ! line break
\href{http://theoval.cmp.uea.ac.uk/~nlct/latex/}{introductory tutorials},
which include exercises (with solutions). Other tutorials include
those for writing theses/dissertations with \LaTeX{}, and for using
\LaTeX{} in administrative work. (The page seems to be an adjunct to
her \LaTeX{} courses~--- fortunate people, the people of \acro{UEA}!).
+Engelbert Buxbaum provides the `slides' for his \latex{} course `The
+\latex{} document preparation system'; this seems to be a departmental
+course at his university.
+
+Mark van Dongen's % line break
+\href{"http://csweb.ucc.ie/~dongen/LaTeX-and-Friends.pdf}{`\latex and friends'}
+appeared as he was writing his book on the subject (soon to be published).
+
An interesting (and practical) tutorial about what \emph{not} to do is
\Package{l2tabu}, or ``A list of sins of \LaTeXe{} users'' by Mark
Trettin, translated into English by J\"urgen Fenn. The
@@ -690,6 +703,7 @@ the source is also available).
\item[\nothtml{\rmfamily}Getting something out of \latex{}]\CTANref{first-latex-doc}
% ! line break
\item[\nothtml{\rmfamily}Getting up and running with \AMSLaTeX{}]\CTANref{amslatex-primer}
+\item[\nothtml{\rmfamily}Slides for \latex{} course]\CTANref{latex-course}
\item[\nothtml{\rmfamily}Not so Short Introduction]\CTANref{lshort}
(in English, you may browse for sources and other language versions at
\CTANref{lshort-parent})
@@ -745,14 +759,19 @@ excellent introduction to graphics use. It's available on
\acro{CTAN}, but not in the \texlive{} or miktex{} distributions, for
lack of sources.
-Kjell Magne Fauske offers a set of examples of the use of the drawing
+Stefan Kottwitz manages a web site devoted to the use of the drawing
packages % ! line break
-\Qref*{\acro{PGF} and \acro{T}ik\acro{Z}}{Q-drawing}; the % ! line break
-\href{http://www.texample.net/tikz/examples/}{examples catalogue}
+\Qref*{\acro{PGF} and \acro{T}ik\acro{Z}}{Q-drawing}, % ! line break
+\url{http://www.texample.net/}
+
+Included is % ! line break
+ \href{http://www.texample.net/tikz/examples/}{examples catalogue}
includes examples (with output) from the package documentation as well
-as code written by the author himself. The compendious
-\acro{PGF}/\acro{T}ik\acro{Z} manual is clear, but is bewildering for
-some beginners. The ! line break
+as code written by the original site maintainer (Kjell Magne Fauske)
+and others.
+
+The compendious \acro{PGF}/\acro{T}ik\acro{Z} manual is clear, but is
+bewildering for some beginners. The % ! line break
\href{http://cremeronline.com/LaTeX/minimaltikz.pdf}{`minimal' introduction}
has helped at least the present author.
@@ -777,23 +796,12 @@ author's macros for papers submitted for \acro{IEEE} publications).
The issues are also covered in a later % ! line break
\Qref{\acro{FAQ} answer}{Q-dvips-pdf}.
-Documentation of Japanese \TeX{} use appears at least twice on the web:
-Haruhiko Okumura's page on
+Documentation of Japanese \ensuremath{\Omega{}} use appears in
+Haruhiko Okumura's page
% ! line break
\href{http://oku.edu.mie-u.ac.jp/~okumura/texfaq/japanese/}{typesetting Japanese with Omega}
(the parent page is in Japanese, so out of the scope of this
-\acro{FAQ}).
-
-One ``Tim'' documents p\TeX{} (a \TeX{} system widely used in Japan)
-in his
-\begin{narrowversion}
- ``English notes on p\TeX{}'' (see
- \url{http://www.users.waitrose.com/~nihilist/English_Notes_on_pTex.pdf}).
-\end{narrowversion}
-\begin{wideversion}
- % ! line break
- ``\href{http://www.users.waitrose.com/~nihilist/English_Notes_on_pTex.pdf}{English notes on p\TeX{}}''.
-\end{wideversion}
+\acro{FAQ} list).
Some university departments make their local documentation available
on the web. Most straightforwardly, there's the simple translation of
@@ -806,7 +814,7 @@ More ambitiously, some university departments have enthusiastic
documenters who
make public record of their \AllTeX{} support. For example, Tim Love
(of Cambridge University Engineering Department) maintains his
-deparment's pages at
+department's pages at
\URL{http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/}
%% and Mimi
%% Burbank (of the School of Computer Science \& Information Technology
@@ -846,6 +854,9 @@ al)'s % !line break
an extent) work in progress, but is generally reliable (source is
available on the.archive as well).
+Martin Scharrer's ``List of internal \latex{} macros'' is a help to
+those aiming to write a class or package.
+
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}
@@ -853,8 +864,9 @@ also looks good.
\begin{ctanrefs}
\item[\nothtml{\rmfamily}Cheat sheet]\CTANref{latexcheat}
\item[\nothtml{\rmfamily}LaTeX reference manual]\CTANref{latex2e-help-texinfo}
+\item[\nothtml{\rmfamily}LaTeX internal macros]\CTANref{macros2e}
\end{ctanrefs}
-\LastEdit{2010-12-08}
+\LastEdit{2012-02-16}
\Question[Q-doc-wiki]{\acro{WIKI} books for \TeX{} and friends}
@@ -963,9 +975,9 @@ seems useful), you will more often than not find documentation that
way.
If your luck (as defined above) doesn't hold out, you'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.
+documentation by other means. That is, you have to find the
+documentation for yourself. The rest of this answer offers a range of
+possible techniques.
The commonest form of documentation of \LaTeX{} add-ons is within the
\extension{dtx} file in which the code is distributed (see
@@ -1009,7 +1021,7 @@ to write, it should be hard to use'' philosophy). Most ordinary
mortals will seek support from some more experienced user at this
stage, though it \emph{is} possible to proceed in the way that the original
author apparently expected\dots{}by reading his code.
-\LastEdit{2011-07-19}
+\LastEdit{2011-12-29}
\Question[Q-writecls]{Learning to write \LaTeX{} classes and packages}
@@ -1078,10 +1090,10 @@ section describes how to use \MP{} illustrations in \LaTeX{} and
\PDFLaTeX{} documents, with an emphasis on how to use appropriate
fonts for any text or mathematics.
-% Hans Hagen (of \CONTeXT{} fame) offers a \MP{} tutorial called
-% MetaFun (which admittedly concentrates on the use of \MP{} within
-% \CONTeXT{}). It may be found on his company's % ! line break
-% \href{http://www.pragma-ade.com/metapost.htm}{\MP{} page}.
+Hans Hagen (of \CONTeXT{} fame) offers a \MP{} tutorial called
+MetaFun (which admittedly concentrates on the use of \MP{} within
+\CONTeXT{}). It may be found on his company's % ! line break
+\href{http://www.pragma-ade.com/general/manuals/metafun-p.pdf}{`manuals' page}.
Other \MP{} tutorials that have appeared are two in English by % ! line breaks
\href{http://remote.science.uva.nl/~heck/Courses/mptut.pdf}{Andr\'e Heck}
@@ -1108,6 +1120,7 @@ written more as a document, and presented in \acro{PDF}.
\item[\nothtml{\rmfamily}Peter Wilson's ``experiences'']\CTANref{metafp-pdf}
\item[\nothtml{\rmfamily}Vincent Zoonekynd's examples]\CTANref{zoon-mp-eg}
\end{ctanrefs}
+\LastEdit{2011-11-21}
\Question[Q-BibTeXing]{\bibtex{} Documentation}
@@ -1123,7 +1136,7 @@ books.)
The document ``Designing \bibtex{} Styles'', also in the \bibtex{}
distribution (look for
-\File{btxhak}, explains the postfix stack-based language used to
+\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},