diff options
Diffstat (limited to 'Master')
| -rw-r--r-- | Master/texmf-doc/doc/english/l2tabu-english/README | 4 | ||||
| -rw-r--r-- | Master/texmf-doc/doc/english/l2tabu-english/l2tabuen.pdf | bin | 309086 -> 310072 bytes | |||
| -rw-r--r-- | Master/texmf-doc/doc/english/l2tabu-english/l2tabuen.tex | 84 |
3 files changed, 43 insertions, 45 deletions
diff --git a/Master/texmf-doc/doc/english/l2tabu-english/README b/Master/texmf-doc/doc/english/l2tabu-english/README deleted file mode 100644 index c27929258e1..00000000000 --- a/Master/texmf-doc/doc/english/l2tabu-english/README +++ /dev/null @@ -1,4 +0,0 @@ -l2tabuen is the English translation of Mark Trettin's guide to LaTeX -called `l2tabu' v1.8, giving a lot of practical advice about how to -avoid the most common mistakes a user is prone to make (i.e., obsolete -commands and packages). diff --git a/Master/texmf-doc/doc/english/l2tabu-english/l2tabuen.pdf b/Master/texmf-doc/doc/english/l2tabu-english/l2tabuen.pdf Binary files differindex b6b157bcc0c..7eb04655211 100644 --- a/Master/texmf-doc/doc/english/l2tabu-english/l2tabuen.pdf +++ b/Master/texmf-doc/doc/english/l2tabu-english/l2tabuen.pdf diff --git a/Master/texmf-doc/doc/english/l2tabu-english/l2tabuen.tex b/Master/texmf-doc/doc/english/l2tabu-english/l2tabuen.tex index 0ffe77d23f3..9330ce12411 100644 --- a/Master/texmf-doc/doc/english/l2tabu-english/l2tabuen.tex +++ b/Master/texmf-doc/doc/english/l2tabu-english/l2tabuen.tex @@ -1,11 +1,11 @@ %%%------------------------------------------------------------------ %%% Filename: l2tabuen.tex %%% Author: Mark Trettin, Jürgen Fenn <juergen.fenn@gmx.de> -%%% Created: 11 Juni 2006 +%%% Created: 16 Juni 2007 %%% Time-stamp: none -%%% Version: $Id: l2tabuen.tex,v 1.8.5.6 $ +%%% Version: $Id: l2tabuen.tex,v 1.8.5.7 $ %%% -%%% Copyright (C) 2004--2006 by Mark Trettin and Jürgen Fenn +%%% Copyright (C) 2004--2007 by Mark Trettin and Jürgen Fenn %%%------------------------------------------------------------------ %%% TODO: %%% - \input{../asdf/} instead of \input ../asdf/ @@ -43,7 +43,7 @@ \ifpdfoutput{% % needs KOMA-Script class \usepackage{hyperref} % hyperref settings for pdf \hypersetup{% - pdfauthor={(c) 2006 Mark Trettin and Juergen Fenn},% + pdfauthor={(c) 2007 Mark Trettin and Juergen Fenn},% pdftitle={l2tabuen -- An essential guide to \LaTeXe\ usage},% pdfsubject={Some hints on LaTeX2e},% bookmarksopen=true,% Temp @@ -193,7 +193,7 @@ %\begin{Form}\end{Form} \pagestyle{headings} %%% RCS Info for version control -\rcsInfo $Id: l2tabuen.tex,v 1.8.5.6 2006/08/11 00:00:00 juergen Exp $ +\rcsInfo $Id: l2tabuen.tex,v 1.8.5.7 2007/06/17 00:00:00 juergen Exp $ \maketitle \begin{abstract} \noindent @@ -206,7 +206,7 @@ \subsection*{Legal notice} \label{sec:legalnotice} -Copyright \copyright{} 2006 by Mark Trettin and Jürgen Fenn. +Copyright \copyright{} 2007 by Mark Trettin and Jürgen Fenn. \medskip Permission is granted to copy, distribute and/or modify this document @@ -233,13 +233,13 @@ ago.\footnote{\Doku{altepakete} was first announced on 18 February 2003 on \News{de.comp.text.tex}.} I (Jürgen Fenn) joined Mark later for translating his paper into English in order to help it spread to those users who do not speak German. - + In this article we give a demonstration of the most common mistakes in using \LaTeX. We also explain how to avoid them. This overview is neither meant to replace introductions such as \Doku{lshort}~\cite{l2kurz:99} nor the \Doku{De-TeX-FAQ}~\cite[version 72]{faq:02} nor the \Doku{UK FAQ}~\cite[version 3.16]{ukfaq:99}. Our -goal is just to give a small overview of how to write `good' \LaTeXe\ +goal is just to give a small overview of how to write `good' \LaTeXe{} code. \subsection*{More translations of this paper} @@ -300,6 +300,7 @@ Karl Berry, Christoph Bier, Stephen Eglen, Klas Elmgren, +Gernot Hassenpflug, Yvon Henel, Hendrik Maryns, Walter Schmidt, @@ -322,7 +323,7 @@ send an email to the maintainer of the respective language version. \tableofcontents %\clearpage -\section{`Deadly sins'---The most severe mistakes in using \LaTeXe} +\section{`Deadly sins'\,---\,The most severe mistakes in using \LaTeXe} \label{sec:todsunden} In this section we probably have gathered together the most severe mistakes that appear again and again in \News{de.comp.text.tex}, @@ -339,7 +340,7 @@ packages, or others similar to these do not provide good layout. What is even worse, there is more than one version of these packages around, and different versions of those packages are incompatible with one another, providing deviating settings for page margins. So you -may not trust that your document will look the same -- or just as bad? +may not trust that your document will look the same\,---\,or just as bad? -- when being compiled on someone else's system when exchanging \LaTeX{} source. @@ -390,7 +391,7 @@ packages you only need in one particular project or which you may want to hand on to someone you wish to share your project with may as well be saved in the current working directory. See the \Doku{De-TeX-FAQ}~\cite[question 5.1.4]{faq:02}, or the \Doku{UK - FAQ}\cite[`Installing \LaTeX\ files', section K, `Where to put new + FAQ}\cite[`Installing \LaTeX{} files', section K, `Where to put new files', question 90]{ukfaq:99}. \subsection{Changing inter-line space using \texttt{\textbackslash @@ -406,7 +407,7 @@ space you can do so on three levels: \item or by redefining \Macro{baselinestretch}. \end{enumerate} Redefining parameters such as \Macro{baselinestretch} works on the -lowest \LaTeX{} level available --- which should better be left to +lowest \LaTeX{} level available\,---\,which should better be left to packages. The \Macro{linespread} command is provided for this, so it is a better way to get more inter-line space than fiddling with \Macro{baselinestretch}. It is even better, though, to use @@ -432,8 +433,8 @@ It may make sense to change the indent of the first line in paragraphs (\Macro{parindent}). However, if you do so, please note the following: \begin{itemize} \item Never use absolute sizes (\emph{e.g.}, `mm') to modify paragraph - indent. Use sizes that depend on font size, such as `em', - \emph{e.g.} The latter does \emph{not} mean that indent adapts + indent. Use sizes that depend on font size, such as `em', for + example. The latter does \emph{not} mean that indent adapts automatically when changing the font size. Rather, the value that goes with the font currently activated is used. \item Always use \LaTeX{} commands. For example, this may make it @@ -441,7 +442,7 @@ It may make sense to change the indent of the first line in paragraphs split up.} a \LaTeX{} file through an external program, or script. Your code will be easier to maintain, too. So problems concerning compatibility with other packages can be avoided as well - (\Paket{calc}, \emph{e.g.}). + (\Paket{calc}, for example). \Ersetze{\Macro{parindent}\texttt{=1em}}{\LMacro{setlength}{\Macro{parindent}}\{1em\}} \end{itemize} % @@ -456,7 +457,7 @@ paragraph indent') do \emph{not} use \normalcolor % \Macro{parskip} should not be used as it will also modify settings for -list environments, table of contents etc., and headings. +list environments, table of contents, etc., and headings. The \Paket{parskip} package, however, as well as the \KOMAScript\ classes go to some lengths to avoid these side effects. On how to use @@ -572,8 +573,8 @@ Only if this fails you may try to typeset the following paragraph more \end{minipage} \end{figure} -In figures~\ref{fig:beispiel-mit-latex} and -\vref{fig:beisp-mit-textttstr} I have tried to show the effect of +In figures~\ref{fig:beispiel-mit-latex} +and~\vref{fig:beisp-mit-textttstr} I have tried to show the effect of \Macro{sloppy}. This also depends on the font employed. When using Times the negative effects of \Macro{sloppy} do not show as extremely as with, say, Computer Modern. The effect in principle, however, @@ -668,7 +669,7 @@ denominator, especially with more complex fractions. \Ersetze{\texttt{\$a \textbackslash over b\$}}% {\texttt{\$\textbackslash frac\{a\}\{b\}\$}} -\subsubsection{Centring text using \texttt{\textbackslash centerline}} +\subsubsection{Centering text using \texttt{\textbackslash centerline}} \label{sec:centerline} The \Macro{centerline} command is another \TeX{} command you should @@ -702,7 +703,7 @@ package may yield unexpected results. \paragraph{Note:} \label{sec:anmerkung-5} -On how to centre graphics and tables see +On how to center graphics and tables see section~\vref{sec:gleit-figure-table}. \subsection{Class files and packages} @@ -748,7 +749,7 @@ then. \Paket{epsfig} is mainly provided for reasons of compatibility, as mentioned above. For the differences between \Paket{graphics}, and \Paket{graphicx} see -\Doku{grfguide}~\cite{graphicx:99}. For hints on centring graphics see +\Doku{grfguide}~\cite{graphicx:99}. For hints on centering graphics see section~\vref{sec:gleit-figure-table}. \sbox{\Breite}{\LMacro{psfig}{file=Bild,\dots}} @@ -763,7 +764,7 @@ section~\vref{sec:gleit-figure-table}. For changing inter-line space use the \Paket{setspace} package. \Paket{doublespace} is obsolete. It was replaced by \Paket{setspace}. -Cf. section ~\vref{sec:ander-des-zeil}. +Cf. section~\vref{sec:ander-des-zeil}. \Ersetze{\Use{doublespace}}{\Use{setspace}} @@ -812,7 +813,7 @@ other non-ASCII characters: So this variant should \emph{always} be avoided due to the problems as far as kerning is concerned. -\item With \verb+H\"ulle+ or \verb+H\"{u}lle+ the abovementioned +\item With \verb+H\"ulle+ or \verb+H\"{u}lle+ the aforementioned problems as far as kerning is concerned do not appear. It can be used on every system, too. @@ -824,9 +825,9 @@ other non-ASCII characters: any additional packages.\label{item:die-eingabe-der} \item With \Paket{(n)german} or the \Option{(n)german} option in - \Paket{babel} German \emph{umlauts} can be input easier + \Paket{babel} German \emph{umlauts} can be input more easily (\verb+H"ulle+). Again this will work on all systems. As both - \Paket{babel} and \Paket{(n)german} are available on all \TeX\ + \Paket{babel} and \Paket{(n)german} are available on all \TeX\ systems there should be no problems as far as compatibility is concerned. @@ -840,9 +841,9 @@ other non-ASCII characters: obvious. You can input and read the continuous source text just as any other `normal' text. - On the other hand you have to tell \LaTeX\ which input encoding is + On the other hand you have to tell \LaTeX{} which input encoding is used. There may also be problems when exchanging files between - different systems. This is \emph{not} a problem for \TeX, or \LaTeX\ + different systems. This is \emph{not} a problem for \TeX, or \LaTeX{} itself, but it may cause \emph{problems in displaying text in editors} on different systems. For example, a Euro currency symbol encoded in iso-8859-15 (latin9) may be \emph{displayed} in an @@ -966,7 +967,7 @@ You do not have to load \Paket{courier} at all. You may use the usual \subsubsection{\Paket{palatino}} \label{sec:paketpalatino} -\Paket{palatino} behaves like \Paket{times} -- apart from setting +\Paket{palatino} behaves like \Paket{times}\,---\,apart from setting \Macro{rmdefault} to Palatino, of course. \Paket{palatino} is obsolete, too. This is why it should not be used any more. @@ -1051,14 +1052,13 @@ documentation \Doku{eulervm}~\cite{eulervm:04} for details. \section{Miscellaneous} \label{sec:verschiedenes} -This section -- apart from \vref{sec:der-anhang} -- gives some more -general advice than the `deadly sins' section, pp. -\pageref{sec:todsunden}\,ff. +This section\,---\,apart from~\vref{sec:der-anhang}\,---\,gives some more +general advice than the `deadly sins' section, pp.\,\pageref{sec:todsunden}\,ff. -\subsection{Floats---`figure', `table'} +\subsection{Floats\,---\,`figure', `table'} \label{sec:gleit-figure-table} -For centring a float environment we recommend you use +For centering a float environment we recommend you use \Macro{centering} instead of \newline\LMacro{begin}{center} \dots{} \LMacro{end}{center} because the latter will include an additional vertical skip you can do without in most cases. @@ -1072,7 +1072,7 @@ vertical skip you can do without in most cases. \paragraph{Note:} \label{sec:anmerkung-4} -However, when centring a region within continuous text or within a +However, when centering a region within continuous text or within a \verb+titlepage+ environment this additional space may be welcome! \subsection{The appendix} @@ -1103,7 +1103,7 @@ package are these: be printed over any more. \item Some new environments, \emph{e.g.}, \texttt{split}, provide a solution to split up long equations easily. -\item It is easy to define new operators (similar to \Macro{sin} +\item It is easy to define new operators (similar to \Macro{sin}, etc.)\ with proper spacing. \end{itemize} @@ -1148,7 +1148,7 @@ There are several reasons why you should avoid the Kohm's `Bug-Report' at\newline \url{http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/2618}} \begin{enumerate} -\item There are \emph{different} seperators in path names on different +\item There are \emph{different} separators in path names on different platforms. While MS Windows and Unices both use a slash `/', a colon `:' was used on Macintosh systems before Mac OS~X. \item \TeX{} search takes longer than with using the kpathsea library @@ -1188,7 +1188,7 @@ that \texttt{TEXINPUTS} may be set in different ways. Please see the documentation of your operating system, or of your \TeX{} distribution for more. -\subsection{Language-specific macros -- \texttt{\textbackslash*name}} +\subsection{Language-specific macros\,---\,\texttt{\textbackslash*name}} \label{sec:die-macroname-makros} From time to time the question comes up in \News{de.comp.text.tex} how @@ -1449,7 +1449,7 @@ An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called \textbf{"Opaque"}. Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, LaTeX input format, SGML +ASCII without markup, Texinfo input format, \LaTeX{} input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats @@ -1631,9 +1631,9 @@ These titles must be distinct from any other section titles. You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various -parties--for example, statements of peer review or that the text has -been approved by an organization as the authoritative definition of a -standard. +parties\,---\,for example, statements of peer review or that the text +has been approved by an organization as the authoritative definition +of a standard. You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list @@ -1790,6 +1790,8 @@ to permit their use in free software. \section{\Doku{l2tabuen} revision history} \begin{description} +\item[v1.8.5.7] Some minor changes by \emph{Gernot Hassenpflug} to + English typography and style. \item[v1.8.5.6] Adapted to the UK \TeX{} FAQ v3.16. \item[v1.8.5.5] Minor fix in the section on \Macro{graphicspath} as to the correct notation regarding Mac OS~X. Thanks to \emph{Stephen |