diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/tufte-latex/sample-book.tex')
| -rw-r--r-- | Master/texmf-dist/doc/latex/tufte-latex/sample-book.tex | 537 |
1 files changed, 484 insertions, 53 deletions
diff --git a/Master/texmf-dist/doc/latex/tufte-latex/sample-book.tex b/Master/texmf-dist/doc/latex/tufte-latex/sample-book.tex index eb95dec6311..c22cb2a87cc 100644 --- a/Master/texmf-dist/doc/latex/tufte-latex/sample-book.tex +++ b/Master/texmf-dist/doc/latex/tufte-latex/sample-book.tex @@ -1,5 +1,7 @@ \documentclass{tufte-book} +\hypersetup{colorlinks}% uncomment this line if you prefer colored hyperlinks (e.g., for onscreen viewing) + %% % Book metadata \title{A Tufte-Style Book\thanks{Thanks to Edward R.~Tufte for his inspiration.}} @@ -91,28 +93,53 @@ \newcommand{\measure}[3]{#1/#2$\times$\unit[#3]{pc}} % Macros for typesetting the documentation -\newcommand{\hl}[1]{\textcolor{Maroon}{#1}}% prints in red +\newcommand{\hlred}[1]{\textcolor{Maroon}{#1}}% prints in red \newcommand{\hangleft}[1]{\makebox[0pt][r]{#1}} \newcommand{\hairsp}{\hspace{1pt}}% hair space \newcommand{\hquad}{\hskip0.5em\relax}% half quad space \newcommand{\TODO}{\textcolor{red}{\bf TODO!}\xspace} \newcommand{\ie}{\textit{i.\hairsp{}e.}\xspace} \newcommand{\eg}{\textit{e.\hairsp{}g.}\xspace} +\newcommand{\na}{\quad--}% used in tables for N/A cells \providecommand{\XeLaTeX}{X\lower.5ex\hbox{\kern-0.15em\reflectbox{E}}\kern-0.1em\LaTeX} \newcommand{\tXeLaTeX}{\XeLaTeX\index{XeLaTeX@\protect\XeLaTeX}} % \index{\texttt{\textbackslash xyz}@\hangleft{\texttt{\textbackslash}}\texttt{xyz}} \newcommand{\tuftebs}{\symbol{'134}}% a backslash in tt type in OT1/T1 -\newcommand{\doccmd}[1]{% - \texttt{\tuftebs#1}% - \index{#1@\protect\hangleft{\texttt{\tuftebs}}\texttt{#1}}% +\newcommand{\doccmdnoindex}[2][]{\texttt{\tuftebs#2}}% command name -- adds backslash automatically (and doesn't add cmd to the index) +\newcommand{\doccmddef}[2][]{% + \hlred{\texttt{\tuftebs#2}}\label{cmd:#2}% + \ifthenelse{\isempty{#1}}% + {% add the command to the index + \index{#2 command@\protect\hangleft{\texttt{\tuftebs}}\texttt{#2}}% command name + }% + {% add the command and package to the index + \index{#2 command@\protect\hangleft{\texttt{\tuftebs}}\texttt{#2} (\texttt{#1} package)}% command name + \index{#1 package@\texttt{#1} package}\index{packages!#1@\texttt{#1}}% package name + }% +}% command name -- adds backslash automatically +\newcommand{\doccmd}[2][]{% + \texttt{\tuftebs#2}% + \ifthenelse{\isempty{#1}}% + {% add the command to the index + \index{#2 command@\protect\hangleft{\texttt{\tuftebs}}\texttt{#2}}% command name + }% + {% add the command and package to the index + \index{#2 command@\protect\hangleft{\texttt{\tuftebs}}\texttt{#2} (\texttt{#1} package)}% command name + \index{#1 package@\texttt{#1} package}\index{packages!#1@\texttt{#1}}% package name + }% }% command name -- adds backslash automatically \newcommand{\docopt}[1]{\ensuremath{\langle}\textrm{\textit{#1}}\ensuremath{\rangle}}% optional command argument \newcommand{\docarg}[1]{\textrm{\textit{#1}}}% (required) command argument \newenvironment{docspec}{\begin{quotation}\ttfamily\parskip0pt\parindent0pt\ignorespaces}{\end{quotation}}% command specification environment -\newcommand{\docenv}[1]{\texttt{#1}\index{#1@\texttt{#1} environment}\index{environments!#1@\texttt{#1}}}% environment name -\newcommand{\docpkg}[1]{\texttt{#1}\index{#1@\texttt{#1} package}\index{packages!#1@\texttt{#1}}}% package name +\newcommand{\docenv}[1]{\texttt{#1}\index{#1 environment@\texttt{#1} environment}\index{environments!#1@\texttt{#1}}}% environment name +\newcommand{\docenvdef}[1]{\hlred{\texttt{#1}}\label{env:#1}\index{#1 environment@\texttt{#1} environment}\index{environments!#1@\texttt{#1}}}% environment name +\newcommand{\docpkg}[1]{\texttt{#1}\index{#1 package@\texttt{#1} package}\index{packages!#1@\texttt{#1}}}% package name \newcommand{\doccls}[1]{\texttt{#1}}% document class name -\newcommand{\docclsopt}[1]{\texttt{#1}\index{#1@\texttt{#1} class option}\index{class options!#1@\texttt{#1}}}% document class option name +\newcommand{\docclsopt}[1]{\texttt{#1}\index{#1 class option@\texttt{#1} class option}\index{class options!#1@\texttt{#1}}}% document class option name +\newcommand{\docclsoptdef}[1]{\hlred{\texttt{#1}}\label{clsopt:#1}\index{#1 class option@\texttt{#1} class option}\index{class options!#1@\texttt{#1}}}% document class option name defined +\newcommand{\docmsg}[2]{\bigskip\begin{fullwidth}\noindent\ttfamily#1\end{fullwidth}\medskip\par\noindent#2} +\newcommand{\docfilehook}[2]{\texttt{#1}\index{file hooks!#2}\index{#1@\texttt{#1}}} +\newcommand{\doccounter}[1]{\texttt{#1}\index{#1 counter@\texttt{#1} counter}} % Generates the index \usepackage{makeidx} @@ -140,7 +167,7 @@ The new becomes threatening, the old reassuring. A designer knows that he has achieved perfection not when there is nothing left to add, but when there is nothing left to take away. -}{Antoine de St-Expurey} +}{Antoine de Saint-Exup\'{e}ry} \vfill \openepigraph{% \ldots the designer of a new system must not only be the implementor and the first @@ -184,6 +211,10 @@ under the License.\index{license} % r.5 contents \tableofcontents +\listoffigures + +\listoftables + % r.7 dedication \cleardoublepage ~\vfill @@ -204,7 +235,7 @@ and \mbox{Donald E.~Knuth}. This sample book discusses the design of Edward Tufte's books\cite{Tufte2001,Tufte1990,Tufte1997,Tufte2006} -and the use of the \texttt{tufte-book} and \texttt{sample-handout} document classes. +and the use of the \doccls{tufte-book} and \doccls{tufte-handout} document classes. %% @@ -304,14 +335,14 @@ Title & & & & \\ \quad Size & 36 pt & 48 pt & 48 pt & 36 pt \\ \addlinespace Subtitle & & & & \\ -\quad Typeface & -- & -- & serif & -- \\ -\quad Style & -- & -- & upright & -- \\ -\quad Size & -- & -- & 20 pt & -- \\ +\quad Typeface & \na & \na & serif & \na \\ +\quad Style & \na & \na & upright & \na \\ +\quad Size & \na & \na & 20 pt & \na \\ \addlinespace Edition & & & & \\ -\quad Typeface & sans serif & -- & -- & -- \\ -\quad Style & upright, caps & -- & -- & -- \\ -\quad Size & 14 pt & -- & -- & -- \\ +\quad Typeface & sans serif & \na & \na & \na \\ +\quad Style & upright, caps & \na & \na & \na \\ +\quad Size & 14 pt & \na & \na & \na \\ \addlinespace Publisher & & & & \\ \quad Typeface & serif & serif & serif & sans serif \\ @@ -369,7 +400,7 @@ The following font sizes are defined by the \TL classes: \LaTeX{} size & Font size & Leading & Used for \\ \midrule \verb+\tiny+ & 5 & 6 & sidenote numbers \\ - \verb+\scriptsize+ & 7 & 8 & --- \\ + \verb+\scriptsize+ & 7 & 8 & \na \\ \verb+\footnotesize+ & 8 & 10 & sidenotes, captions \\ \verb+\small+ & 9 & 12 & quote, quotation, and verse environments \\ \verb+\normalsize+ & 10 & 14 & body text \\ @@ -388,7 +419,7 @@ The following font sizes are defined by the \TL classes: \section{Headings}\label{sec:headings1}\index{headings} Tufte's books include the following heading levels: parts, -chapters,\sidenote{Parts and chapters are defined for the \texttt{tufte\-book} +chapters,\sidenote{Parts and chapters are defined for the \texttt{tufte-book} class only.} sections, subsections, and paragraphs. Not defined by default are: sub-subsections and subparagraphs. @@ -438,14 +469,14 @@ The following characteristics define the various environments: \end{table} -\chapter{On the Use of the \texttt{tufte-book} Document Class} +\chapter[On the Use of the tufte-book Document Class]{On the Use of the \texttt{tufte-book} Document Class} \label{ch:tufte-book} -The Tufte-\LaTeX\ document classes define a style similar to the +The \TL document classes define a style similar to the style Edward Tufte uses in his books and handouts. Tufte's style is known for its extensive use of sidenotes, tight integration of graphics with text, and well-set typography. This document aims to be at once a -demonstration of the features of the Tufte-\LaTeX\ document classes +demonstration of the features of the \TL document classes and a style guide to their use. \section{Page Layout}\label{sec:page-layout} @@ -459,14 +490,14 @@ a \Verb|\subsection|. As Bringhurst points out in \textit{The Elements of Typographic Style},\cite{Bringhurst2005} you should ``use as many levels of headings as you need: no more, and no fewer.'' -The Tufte-\LaTeX\ classes will emit an error if you try to use +The \TL classes will emit an error if you try to use \linebreak\Verb|\subsubsection| and smaller headings. % let's start a new thought -- a new section \newthought{In his later books},\cite{Tufte2006} Tufte starts each section with a bit of vertical space, a non-indented paragraph, and sets the first few words of the sentence in \textsc{small caps}. To -accomplish this using this style, use the \hl{\doccmd{newthought}} command: +accomplish this using this style, use the \doccmddef{newthought} command: \begin{docspec} \doccmd{newthought}\{In his later books\}, Tufte starts\ldots \end{docspec} @@ -479,11 +510,11 @@ for sidenotes and small figures. Any \doccmd{footnote}s will automatically be converted to sidenotes.\footnote{This is a sidenote that was entered using the \texttt{\textbackslash footnote} command.} If you'd like to place ancillary information in the margin without the sidenote mark (the superscript -number), you can use the \hl{\doccmd{marginnote}} command.\marginnote{This is a +number), you can use the \doccmd{marginnote} command.\marginnote{This is a margin note. Notice that there isn't a number preceding the note, and there is no number in the main text where this note was written.} -The specification of the \hl{\doccmd{sidenote}} command is: +The specification of the \doccmddef{sidenote} command is: \begin{docspec} \doccmd{sidenote}[\docopt{number}][\docopt{offset}]\{\docarg{Sidenote text.}\} \end{docspec} @@ -518,20 +549,20 @@ completely omit the \docopt{offset} argument: \doccmd{sidenote}[\docopt{number}]\{\docarg{Sidenote text.}\} \end{docspec} -The \doccmd{marginnote} command has a similar \docarg{offset} argument: +The \doccmddef{marginnote} command has a similar \docarg{offset} argument: \begin{docspec} \doccmd{marginnote}[\docopt{offset}]\{\docarg{Margin note text.}\} \end{docspec} \section{References} References are placed alongside their citations as sidenotes, -as well. This can be accomplished using the normal \hl{\doccmd{cite}} +as well. This can be accomplished using the normal \doccmddef{cite} command.\sidenote{The first paragraph of this document includes a citation.} The complete list of references may also be printed automatically by using -the \hl{\doccmd{bibliography}} command. (See the end of this document for an +the \doccmddef{bibliography} command. (See the end of this document for an example.) If you do not want to print a bibliography at the end of your -document, use the \hl{\doccmd{nobibliography}} command in its place. +document, use the \doccmddef{nobibliography} command in its place. To enter multiple citations at one location,\cite[-3\baselineskip]{Tufte2006,Tufte1990} you can provide a list of keys separated by commas and the same optional vertical @@ -542,13 +573,13 @@ offset argument: \Verb|\cite{Tufte2006,Tufte1990}|. \section{Figures and Tables}\label{sec:figures-and-tables} Images and graphics play an integral role in Tufte's work. -In addition to the standard \hl{\docenv{figure}} and \hl{\docenv{tabular}} environments, +In addition to the standard \docenvdef{figure} and \docenvdef{tabular} environments, this style provides special figure and table environments for full-width floats. -Full page--width figures and tables may be placed in \hl{\docenv{figure*}} or -\hl{\docenv{table*}} environments. To place figures or tables in the margin, -use the \hl{\docenv{marginfigure}} or \hl{\docenv{margintable}} environments as follows +Full page--width figures and tables may be placed in \docenvdef{figure*} or +\docenvdef{table*} environments. To place figures or tables in the margin, +use the \docenvdef{marginfigure} or \docenvdef{margintable} environments as follows (see figure~\ref{fig:marginfig}): \begin{marginfigure}% @@ -592,12 +623,34 @@ environment and figure~\ref{fig:textfig} is an example of the normal \begin{figure} \includegraphics{hilbertcurves.pdf} % \checkparity This is an \pageparity\ page.% - \caption{Hilbert curves of various degrees $n$. - \emph{Notice that this figure only takes up the main textblock width.}} + \caption[Hilbert curves of various degrees $n$.][6pt]{Hilbert curves of various degrees $n$. \emph{Notice that this figure only takes up the main textblock width.}} \label{fig:textfig} %\zsavepos{pos:textfig} \end{figure} +As with sidenotes and marginnotes, a caption may sometimes require vertical +adjustment. The \doccmddef{caption} command now takes a second optional +argument that enables you to do this by providing a dimension \docopt{offset}. +You may specify the caption in any one of the following forms: +\begin{docspec} + \doccmd{caption}\{\docarg{long caption}\}\\ + \doccmd{caption}[\docarg{short caption}]\{\docarg{long caption}\}\\ + \doccmd{caption}[][\docopt{offset}]\{\docarg{long caption}\}\\ + \doccmd{caption}[\docarg{short caption}][\docopt{offset}]% + \{\docarg{long caption}\} +\end{docspec} +A positive \docopt{offset} will push the caption down the page. The short +caption, if provided, is what appears in the list of figures/tables, otherwise +the ``long'' caption appears there. Note that although the arguments +\docopt{short caption} and \docopt{offset} are both optional, they must be +provided in order. Thus, to specify an \docopt{offset} without specifying a +\docopt{short caption}, you must include the first set of empty brackets +\Verb|[]|, which tell \doccmd{caption} to use the default ``long'' caption. As +an example, the caption to figure~\ref{fig:textfig} above was given in the form +\begin{docspec} + \doccmd{caption}[Hilbert curves...][6pt]\{Hilbert curves...\} +\end{docspec} + Table~\ref{tab:normaltab} shows table created with the \docpkg{booktabs} package. Notice the lack of vertical rules---they serve only to clutter the table's data. @@ -621,9 +674,103 @@ the table's data. %\zsavepos{pos:normaltab} \end{table} +\newthought{Occasionally} \LaTeX{} will generate an error message:\label{err:too-many-floats} +\begin{docspec} + Error: Too many unprocessed floats +\end{docspec} +\LaTeX{} tries to place floats in the best position on the page. Until it's +finished composing the page, however, it won't know where those positions are. +If you have a lot of floats on a page (including sidenotes, margin notes, +figures, tables, etc.), \LaTeX{} may run out of ``slots'' to keep track of them +and will generate the above error. + +\LaTeX{} initially allocates 18 slots for storing floats. To work around this +limitation, the \TL document classes provide a \doccmddef{morefloats} command +that will reserve more slots. + +The first time \doccmd{morefloats} is called, it allocates an additional 34 +slots. The second time \doccmd{morefloats} is called, it allocates another 26 +slots. + +The \doccmd{morefloats} command may only be used two times. Calling it a +third time will generate an error message. (This is because we can't safely +allocate many more floats or \LaTeX{} will run out of memory.) + +If, after using the \doccmd{morefloats} command twice, you continue to get the +\texttt{Too many unprocessed floats} error, there are a couple things you can +do. + +The \doccmddef{FloatBarrier} command will immediately process all the floats +before typesetting more material. Since \doccmd{FloatBarrier} will start a new +paragraph, you should place this command at the beginning or end of a +paragraph. + +The \doccmddef{clearpage} command will also process the floats before +continuing, but instead of starting a new paragraph, it will start a new page. + +You can also try moving your floats around a bit: move a figure or table to the +next page or reduce the number of sidenotes. (Each sidenote actually uses +\emph{two} slots.) + +After the floats have placed, \LaTeX{} will mark those slots as unused so they +are available for the next page to be composed. + +\section{Captions} +You may notice that the captions are sometimes misaligned. +Due to the way \LaTeX's float mechanism works, we can't know for sure where it +decided to put a float. Therefore, the \TL document classes provide commands to +override the caption position. + +\paragraph{Vertical alignment} To override the vertical alignment, use the +\doccmd{setfloatalignment} command inside the float environment. For +example: + +\begin{fullwidth} +\begin{docspec} + \textbackslash begin\{figure\}[btp]\\ + \qquad \textbackslash includegraphics\{sinewave\}\\ + \qquad \textbackslash caption\{This is an example of a sine wave.\}\\ + \qquad \textbackslash label\{fig:sinewave\}\\ + \qquad \hlred{\textbackslash setfloatalignment\{b\}\% forces caption to be bottom-aligned}\\ + \textbackslash end\{figure\} +\end{docspec} +\end{fullwidth} + +\noindent The syntax of the \doccmddef{setfloatalignment} command is: + +\begin{docspec} + \doccmd{setfloatalignment}\{\docopt{pos}\} +\end{docspec} + +\noindent where \docopt{pos} can be either \texttt{b} for bottom-aligned +captions, or \texttt{t} for top-aligned captions. + +\paragraph{Horizontal alignment}\label{par:overriding-horizontal} +To override the horizontal alignment, use either the \doccmd{forceversofloat} +or the \doccmd{forcerectofloat} command inside of the float environment. For +example: + +\begin{fullwidth} +\begin{docspec} + \textbackslash begin\{figure\}[btp]\\ + \qquad \textbackslash includegraphics\{sinewave\}\\ + \qquad \textbackslash caption\{This is an example of a sine wave.\}\\ + \qquad \textbackslash label\{fig:sinewave\}\\ + \qquad \hlred{\textbackslash forceversofloat\% forces caption to be set to the left of the float}\\ + \textbackslash end\{figure\} +\end{docspec} +\end{fullwidth} + +The \doccmddef{forceversofloat} command causes the algorithm to assume the +float has been placed on a verso page---that is, a page on the left side of a +two-page spread. Conversely, the \doccmddef{forcerectofloat} command causes +the algorithm to assume the float has been placed on a recto page---that is, a +page on the right side of a two-page spread. + + \section{Full-width text blocks} -In addition to the new float types, there is a \hl{\docenv{fullwidth}} +In addition to the new float types, there is a \docenvdef{fullwidth} environment that stretches across the main text block and the sidenotes area. @@ -650,13 +797,13 @@ existing commands for letterspacing. When setting strings of \allcaps{ALL CAPS} or \smallcaps{small caps}, the letter\-spacing---that is, the spacing between the letters---should be -increased slightly.\cite{Bringhurst2005} The \hl{\doccmd{allcaps}} command has proper letterspacing for -strings of \allcaps{FULL CAPITAL LETTERS}, and the \hl{\doccmd{smallcaps}} command +increased slightly.\cite{Bringhurst2005} The \doccmddef{allcaps} command has proper letterspacing for +strings of \allcaps{FULL CAPITAL LETTERS}, and the \doccmddef{smallcaps} command has letterspacing for \smallcaps{small capital letters}. These commands will also automatically convert the case of the text to upper- or lowercase, respectively. -The \hl{\doccmd{textsc}} command has also been redefined to include +The \doccmddef{textsc} command has also been redefined to include letterspacing. The case of the \doccmd{textsc} argument is left as is, however. This allows one to use both uppercase and lowercase letters: \textsc{The Initial Letters Of The Words In This Sentence Are Capitalized.} @@ -671,72 +818,356 @@ document class. Therefore, you can pass any of the typical book options. There are a few options that are specific to the \doccls{tufte-book} document class, however. -The \hl{\docclsopt{a4paper}} option will set the paper size to \smallcaps{A4} instead of +The \docclsoptdef{a4paper} option will set the paper size to \smallcaps{A4} instead of the default \smallcaps{US} letter size. -The \hl{\docclsopt{sfsidenotes}} option will set the sidenotes and title block in a +The \docclsoptdef{sfsidenotes} option will set the sidenotes and title block in a \textsf{sans serif} typeface instead of the default roman. -The \hl{\docclsopt{twoside}} option will modify the running heads so that the page +The \docclsoptdef{twoside} option will modify the running heads so that the page number is printed on the outside edge (as opposed to always printing the page -number on the right-side edge in \hl{\docclsopt{oneside}} mode). +number on the right-side edge in \docclsoptdef{oneside} mode). -The \hl{\docclsopt{symmetric}} option typesets the sidenotes on the outside edge of +The \docclsoptdef{symmetric} option typesets the sidenotes on the outside edge of the page. This is how books are traditionally printed, but is contrary to Tufte's book design which sets the sidenotes on the right side of the page. This option implicitly sets the \docclsopt{twoside} option. -The \hl{\docclsopt{justified}} option sets all the text fully justified (flush left +The \docclsoptdef{justified} option sets all the text fully justified (flush left and right). The default is to set the text ragged right. The body text of Tufte's books are set ragged right. This prevents needless hyphenation and makes it easier to read the text in the slightly narrower column. -The \hl{\docclsopt{bidi}} option loads the \docpkg{bidi} package which is used with +The \docclsoptdef{bidi} option loads the \docpkg{bidi} package which is used with \tXeLaTeX\ to typeset bi-directional text. Since the \docpkg{bidi} package needs to be loaded before the sidenotes and cite commands are defined, it can't be loaded in the document preamble. -The \hl{\docclsopt{debug}} option causes the Tufte-\LaTeX\ classes to output debug +The \docclsoptdef{debug} option causes the \TL classes to output debug information to the log file which is useful in troubleshooting bugs. It will also cause the graphics to be replaced by outlines. -The \hl{\docclsopt{nofonts}} option prevents the Tufte-\LaTeX\ classes from +The \docclsoptdef{nofonts} option prevents the \TL classes from automatically loading the Palatino and Helvetica typefaces. You should use this option if you wish to load your own fonts. If you're using \tXeLaTeX, this option is implied (\ie, the Palatino and Helvetica fonts aren't loaded if you use \tXeLaTeX). -The \hl{\docclsopt{nols}} option inhibits the letterspacing code. The Tufte-\LaTeX\ +The \docclsoptdef{nols} option inhibits the letterspacing code. The \TL\ classes try to load the appropriate letterspacing package (either pdf\TeX's \docpkg{letterspace} package or the \docpkg{soul} package). If you're using \tXeLaTeX\ with \docpkg{fontenc}, however, you should configure your own letterspacing. -The \hl{\docclsopt{notitlepage}} option causes \verb|\maketitle| to generate a title +The \docclsoptdef{notitlepage} option causes \doccmd{maketitle} to generate a title block instead of a title page. The \doccls{book} class defaults to a title page and the \doccls{handout} class defaults to the title block. There is an -analogous \hl{\docclsopt{titlepage}} option that forces \verb|\maketitle| to +analogous \docclsoptdef{titlepage} option that forces \doccmd{maketitle} to generate a full title page instead of the title block. -The \hl{\docclsopt{notoc}} option suppresses Tufte-\LaTeX's custom table of contents +The \docclsoptdef{notoc} option suppresses \TL's custom table of contents (\textsc{toc}) design. The current \textsc{toc} design only shows unnumbered chapter titles; it doesn't show sections or subsections. The \docclsopt{notoc} option will revert to \LaTeX's \textsc{toc} design. +The \docclsoptdef{nohyper} option prevents the \docpkg{hyperref} package from +being loaded. The default is to load the \docpkg{hyperref} package and use the +\doccmd{title} and \doccmd{author} contents as metadata for the generated +\textsc{pdf}. + \index{class options|)} -\chapter{Debug Stuff} + +\chapter[Customizing Tufte-LaTeX]{Customizing \TL} +\label{ch:customizing} + +The \TL document classes are designed to closely emulate Tufte's book +design by default. However, each document is different and you may encounter +situations where the default settings are insufficient. This chapter explores +many of the ways you can adjust the \TL document classes to better fit +your needs. + +\section{File Hooks} +\label{sec:filehooks} + +\index{file hooks|(} +If you create many documents using the \TL classes, it's easier to +store your customizations in a separate file instead of copying them into the +preamble of each document. The \TL classes provide three file hooks: +\docfilehook{tufte-common-local.tex}{common}, \docfilehook{tufte-book-local.tex}{book}, and +\docfilehook{tufte-handout-local.tex}{handout}.\sloppy + +\begin{description} + \item[\docfilehook{tufte-common-local.tex}{common}] + If this file exists, it will be loaded by all of the \TL document + classes just prior to any document-class-specific code. If your + customizations or code should be included in both the book and handout + classes, use this file hook. + \item[\docfilehook{tufte-book-local.tex}{book}] + If this file exists, it will be loaded after all of the common and + book-specific code has been read. If your customizations apply only to the + book class, use this file hook. + \item[\docfilehook{tufte-common-handout.tex}{handout}] + If this file exists, it will be loaded after all of the common and + handout-specific code has been read. If your customizations apply only to + the handout class, use this file hook. +\end{description} + +\index{file hooks|)} + +\section{Numbered Section Headings} +\label{sec:numbered-sections} +\index{headings!numbered} + +While Tufte dispenses with numbered headings in his books, if you require them, +they can be anabled by changing the value of the \doccounter{secnumdepth} +counter. From the table below, select the heading level at which numbering +should stop and set the \doccounter{secnumdepth} counter to that value. For +example, if you want parts and chapters numbered, but don't want numbering for +sections or subsections, use the command: +\begin{docspec} + \doccmd{setcounter}\{secnumdepth\}\{0\} +\end{docspec} + +The default \doccounter{secnumdepth} for the \TL document classes is $-1$. + +\begin{table} + \footnotesize + \begin{center} + \begin{tabular}{lr} + \toprule + Heading level & Value \\ + \midrule + Part (in \doccls{tufte-book}) & $-1$ \\ + Part (in \doccls{tufte-handout}) & $0$ \\ + Chapter (only in \doccls{tufte-book}) & $0$ \\ + Section & $1$ \\ + Subsection & $2$ \\ + Subsubsection & $3$ \\ + Paragraph & $4$ \\ + Subparagraph & $5$ \\ + \bottomrule + \end{tabular} + \end{center} + \caption{Heading levels used with the \texttt{secnumdepth} counter.} +\end{table} + +\section{Changing the Paper Size} +\label{sec:paper-size} + +The \TL classes currently only provide three paper sizes: \textsc{a4}, +\textsc{b5}, and \textsc{us} letter. To specify a different paper size (and/or +margins), use the \doccmd[geometry]{geometrysetup} command in the preamble of your +document (or one of the file hooks). The full documentation of the +\doccmd{geometrysetup} command may be found in the \docpkg{geometry} package +documentation.\cite{pkg-geometry} + + +\section{Customizing Marginal Material} +\label{sec:marginal-material} + +Marginal material includes sidenotes, citations, margin notes, and captions. +Normally, the justification of the marginal material follows the justification +of the body text. If you specify the \docclsopt{justified} document class +option, all of the margin material will be fully justified as well. If you +don't specify the \docclsopt{justified} option, then the marginal material will +be set ragged right. + +You can set the justification of the marginal material separately from the body +text using the following document class options: \docclsopt{sidenote}, +\docclsopt{marginnote}, \docclsopt{caption}, \docclsopt{citation}, and +\docclsopt{marginals}. Each option refers to its obviously corresponding +marginal material type. The \docclsopt{marginals} option simultaneously sets +the justification on all four marginal material types. + +Each of the document class options takes one of five justification types: +\begin{description} + \item[\docclsopt{justified}] Fully justifies the text (sets it flush left and + right). + \item[\docclsopt{raggedleft}] Sets the text ragged left, regardless of which + page it falls on. + \item[\docclsopt{raggedright}] Sets the text ragged right, regardless of + which page it falls on. + \item[\doccls{raggedouter}] Sets the text ragged left if it falls on the + left-hand (verso) page of the spread and otherwise sets it ragged right. + This is useful in conjunction with the \docclsopt{symmetric} document class + option. + \item[\docclsopt{auto}] If the \docclsopt{justified} document class option + was specified, then set the text fully justified; otherwise the text is set + ragged right. This is the default justification option if one is not + explicitly specified. +\end{description} + +\noindent For example, +\begin{docspec} + \doccmdnoindex{documentclass}[symmetric,justified,marginals=raggedouter]\{tufte-book\} +\end{docspec} +will set the body text of the document to be fully justified and all of the +margin material (sidenotes, margin notes, captions, and citations) to be flush +against the body text with ragged outer edges. + +\newthought{The font and style} of the marginal material may also be modified using the following commands: + +\begin{docspec} + \doccmd{setsidenotefont}\{\docopt{font commands}\}\\ + \doccmd{setcaptionfont}\{\docopt{font commands}\}\\ + \doccmd{setmarginnotefont}\{\docopt{font commands}\}\\ + \doccmd{setcitationfont}\{\docopt{font commands}\} +\end{docspec} + +The \doccmddef{setsidenotefont} sets the font and style for sidenotes, the +\doccmddef{setcaptionfont} for captions, the \doccmddef{setmarginnotefont} for +margin notes, and the \doccmddef{setcitationfont} for citations. The +\docopt{font commands} can contain font size changes (e.g., +\doccmdnoindex{footnotesize}, \doccmdnoindex{Huge}, etc.), font style changes (e.g., +\doccmdnoindex{sffamily}, \doccmdnoindex{ttfamily}, \doccmdnoindex{itshape}, etc.), color changes (e.g., +\doccmdnoindex{color}\texttt{\{blue\}}), and many other adjustments. + +If, for example, you wanted the captions to be set in italic sans serif, you could use: +\begin{docspec} + \doccmd{setcaptionfont}\{\doccmdnoindex{itshape}\doccmdnoindex{sffamily}\} +\end{docspec} + +\chapter{Compatibility Issues} +\label{ch:compatibility} + +When switching an existing document from one document class to a \TL document class, a few changes to the document may have to be made. + +\section{Converting from \doccls{article} to \doccls{tufte-handout}} + +The following \doccls{article} class options are unsupported: \docclsopt{10pt}, \docclsopt{11pt}, \docclsopt{12pt}, \docclsopt{a5paper}, \docclsopt{b5paper}, \docclsopt{executivepaper}, \docclsopt{legalpaper}, \docclsopt{landscape}, \docclsopt{onecolumn}, and \doccls{twocolumn}. + +The following headings are not supported: \doccmd{subsubsection} and \doccmd{subparagraph}. + +\section{Converting from \doccls{book} to \doccls{tufte-book}} + +The following \doccls{report} class options are unsupported: \docclsopt{10pt}, \docclsopt{11pt}, \docclsopt{12pt}, \docclsopt{a5paper}, \docclsopt{b5paper}, \docclsopt{executivepaper}, \docclsopt{legalpaper}, \docclsopt{landscape}, \docclsopt{onecolumn}, and \doccls{twocolumn}. + +The following headings are not supported: \doccmd{subsubsection} and \doccmd{subparagraph}. + + + +\chapter{Troubleshooting and Support} +\label{ch:troubleshooting} + +\section{\TL Website}\label{sec:website} +The website for the \TL packages is located at +\url{http://code.google.com/p/tufte-latex/}. On our website, you'll find +links to our \smallcaps{svn} repository, mailing lists, bug tracker, and documentation. + +\section{\TL Mailing Lists}\label{sec:mailing-lists} +There are two mailing lists for the \TL project: + +\paragraph{Discussion list} +The \texttt{tufte-latex} discussion list is for asking questions, getting +assistance with problems, and help with troubleshooting. Release announcements +are also posted to this list. You can subscribe to the \texttt{tufte-latex} +discussion list at \url{http://groups.google.com/group/tufte-latex}. + +\paragraph{Commits list} +The \texttt{tufte-latex-commits} list is a read-only mailing list. A message +is sent to the list any time the \TL code has been updated. If you'd like to +keep up with the latest code developments, you may subscribe to this list. You +can subscribe to the \texttt{tufte-latex-commits} mailing list at +\url{http://groups.google.com/group/tufte-latex-commits}. + +\section{Getting Help}\label{sec:getting-help} +If you've encountered a problem with one of the \TL document classes, have a +question, or would like to report a bug, please send an email to our +mailing list or visit our website. + +To help us troubleshoot the problem more quickly, please try to compile your +document using the \docclsopt{debug} class option and send the generated +\texttt{.log} file to the mailing list with a brief description of the problem. + + + +\section{Errors, Warnings, and Informational Messages}\label{sec:tl-messages} +The following is a list of all of the errors, warnings, and other messages generated by the \TL classes and a brief description of their meanings. +\index{error messages}\index{warning messages}\index{debug messages} + +% Errors +\docmsg{Error: \doccmd{subparagraph} is undefined by this class.}{% +The \doccmd{subparagraph} command is not defined in the \TL document classes. +If you'd like to use the \doccmd{subparagraph} command, you'll need to redefine +it yourself. See the ``Headings'' section on page~\pageref{sec:headings} for a +description of the heading styles availaboe in the \TL document classes.} + +\docmsg{Error: \doccmd{subsubsection} is undefined by this class.}{% +The \doccmd{subsubsection} command is not defined in the \TL document classes. +If you'd like to use the \doccmd{subsubsection} command, you'll need to +redefine it yourself. See the ``Headings'' section on +page~\pageref{sec:headings} for a description of the heading styles availaboe +in the \TL document classes.} + +\docmsg{Error: You may only call \doccmd{morefloats} twice. See the\par\noindent\ \ \ \ \ \ \ \ Tufte-LaTeX documentation for other workarounds.}{% +\LaTeX{} allocates 18 slots for storing floats. The first time +\doccmd{morefloats} is called, it allocates an additional 34 slots. The second +time \doccmd{morefloats} is called, it allocates another 26 slots. + +The \doccmd{morefloats} command may only be called two times. Calling it a +third time will generate this error message. See +page~\pageref{err:too-many-floats} for more information.} + +% Warnings +\docmsg{Warning: Option `\docopt{class option}' is not supported -{}- ignoring option.}{% +This warning appears when you've tried to use \docopt{class option} with a \TL +document class, but \docopt{class option} isn't supported by the \TL document +class. In this situation, \docopt{class option} is ignored.} + +% Info / Debug messages +\docmsg{Info: The `\docclsopt{symmetric}' option implies `\docclsopt{twoside}'}{% +You specified the \docclsopt{symmetric} document class option. This option automatically forces the \docclsopt{twoside} option as well. See page~\pageref{clsopt:symmetric} for more information on the \docclsopt{symmetric} class option.} + + +\section{Package Dependencies}\label{sec:dependencies} +The following is a list of packages that the \TL document +classes rely upon. Packages marked with an asterisk are optional. +\begin{multicols}{2} +\begin{itemize} + \item xifthen + \item ifpdf* + \item ifxetex* + \item hyperref + \item geometry + \item ragged2e + \item chngpage \emph{or} changepage + \item paralist + \item textcase + \item soul* + \item letterspace* + \item setspace + \item natbib \emph{and} bibentry + \item optparams + \item placeins + \item mathpazo* + \item helvet* + \item fontenc + \item beramono* + \item fancyhdr + \item xcolor + \item textcomp + \item titlesec + \item titletoc +\end{itemize} +\end{multicols} + + %% % The back matter contains appendices, bibliographies, indices, glossaries, etc. -\backmatter + + + +\backmatter + \bibliography{sample-handout} \bibliographystyle{plainnat} |