diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/tufte-latex/sample-handout.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/tufte-latex/sample-handout.tex | 382 |
1 files changed, 0 insertions, 382 deletions
diff --git a/Master/texmf-dist/source/latex/tufte-latex/sample-handout.tex b/Master/texmf-dist/source/latex/tufte-latex/sample-handout.tex deleted file mode 100644 index 3d8309f9f7e..00000000000 --- a/Master/texmf-dist/source/latex/tufte-latex/sample-handout.tex +++ /dev/null @@ -1,382 +0,0 @@ -\documentclass{tufte-handout} - -%\geometry{showframe}% for debugging purposes -- displays the margins - -\usepackage{amsmath} - -% Set up the images/graphics package -\usepackage{graphicx} -\setkeys{Gin}{width=\linewidth,totalheight=\textheight,keepaspectratio} -\graphicspath{{graphics/}} - -\title{An Example of the Usage of the Tufte-Handout Style\thanks{Inspired by Edward~R. Tufte!}} -\author[The Tufte-LaTeX Developers]{The Tufte-\LaTeX\ Developers} -\date{24 January 2009} % if the \date{} command is left out, the current date will be used - -% The following package makes prettier tables. We're all about the bling! -\usepackage{booktabs} - -% The units package provides nice, non-stacked fractions and better spacing -% for units. -\usepackage{units} - -% The fancyvrb package lets us customize the formatting of verbatim -% environments. We use a slightly smaller font. -\usepackage{fancyvrb} -\fvset{fontsize=\normalsize} - -% Small sections of multiple columns -\usepackage{multicol} - -% Provides paragraphs of dummy text -\usepackage{lipsum} - -% These commands are used to pretty-print LaTeX commands -\newcommand{\doccmd}[1]{\texttt{\textbackslash#1}}% 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{quote}\noindent}{\end{quote}}% command specification environment -\newcommand{\docenv}[1]{\textsf{#1}}% environment name -\newcommand{\docpkg}[1]{\texttt{#1}}% package name -\newcommand{\doccls}[1]{\texttt{#1}}% document class name -\newcommand{\docclsopt}[1]{\texttt{#1}}% document class option name - -\begin{document} - -\maketitle% this prints the handout title, author, and date - -\begin{abstract} -\noindent This document describes the Tufte handout \LaTeX\ document style. -It also provides examples and comments on the style's use. -\end{abstract} - -%\printclassoptions - -The Tufte-\LaTeX\ 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 -and a style guide to their use. - -\section{Page Layout}\label{sec:page-layout} -\subsection{Headings}\label{sec:headings} -This style provides \textsc{a}- and \textsc{b}-heads (that is, -\Verb|\section| and \Verb|\subsection|), demonstrated above. - -If you need more than two levels of section headings, you'll have to define -them yourself at the moment;\sidenote{See see ``\nameref{sec:defining-sections}'' on -page~\pageref{sec:defining-sections} for help with defining more heading -levels.} there are no pre-defined styles for anything below 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 -\linebreak\Verb|\subsubsection| and smaller headings. - -%\medskip -%\begin{fullwidth} -%\begin{Verbatim} -%! Package tufte-handout Error: \subsubsection is undefined by this class. -%(tufte-handout) See Robert Bringhurst's _The Elements of -%(tufte-handout) Typographic Style_, section 4.2.2. -%(tufte-handout) \subsubsection was used. -%\end{Verbatim} -%\end{fullwidth} -%\medskip - -% 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 \Verb|\newthought| command: -\begin{docspec} - \doccmd{newthought\{In his later books\}, Tufte starts\ldots} -\end{docspec} - -\subsection{Sidenotes}\label{sec:sidenotes} -One of the most prominent and distinctive features of this style is the -extensive use of sidenotes. There is a wide margin to provide ample room -for sidenotes and small figures. Any \Verb|\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 \Verb|\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 \Verb|\sidenote| command is: -\begin{docspec} - \doccmd{sidenote[\docopt{number}][\docopt{offset}]\{\docarg{Sidenote text.}\}} -\end{docspec} - -Both the \docopt{number} and \docopt{offset} arguments are optional. If you -provide a \docopt{number} argument, then that number will be used as the -sidenote number. It will change of the number of the current sidenote only and -will not affect the numbering sequence of subsequent sidenotes. - -Sometimes a sidenote may run over the top of other text or graphics in the -margin space. If this happens, you can adjust the vertical position of the -sidenote by providing a dimension in the \docopt{offset} argument. Some -examples of valid dimensions are: -\begin{docspec} - \ttfamily 1.0in \qquad 2.54cm \qquad 254mm \qquad 6\Verb|\baselineskip| -\end{docspec} -If the dimension is positive it will push the sidenote down the page; if the -dimension is negative, it will move the sidenote up the page. - -While both the \docopt{number} and \docopt{offset} arguments are optional, they -must be provided in order. To adjust the vertical position of the sidenote -while leaving the sidenote number alone, use the following syntax: -\begin{docspec} - \doccmd{sidenote[][\docopt{offset}]\{\docarg{Sidenote text.}\}} -\end{docspec} -The empty brackets tell the \Verb|\sidenote| command to use the default -sidenote number. - -If you \emph{only} want to change the sidenote number, however, you may -completely omit the \docopt{offset} argument: -\begin{docspec} - \doccmd{sidenote[\docopt{number}]\{\docarg{Sidenote text.}\}} -\end{docspec} - -The \Verb|\marginnote| command has a similar \docarg{offset} argument: -\begin{docspec} - \doccmd{marginnote[\docopt{offset}]\{\docarg{Margin note text.}\}} -\end{docspec} - -\subsection{References} -References are placed alongside their citations as sidenotes, -as well. This can be accomplished using the normal \Verb|\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 \Verb|\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 \Verb|\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 -offset argument: \Verb|\cite{Tufte2006,Tufte1990}|. -\begin{docspec} - \doccmd{cite[\docopt{offset}]\{\docarg{bibkey1,bibkey2,\ldots}\}} -\end{docspec} - -\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 \docenv{figure} and \docenv{tabular} environments, -this style provides special figure and table environments for full-width -floats. - -Full page--width figures and tables may be placed in \docenv{figure*} or -\docenv{table*} environments. To place figures or tables in the margin, -use the \docenv{marginfigure} or \docenv{margintable} environments as follows -(see figure~\ref{fig:marginfig}): - -\begin{marginfigure}% - \includegraphics[width=\linewidth]{helix} - \caption{This is a margin figure. The helix is defined by - $x = \cos(2\pi z)$, $y = \sin(2\pi z)$, and $z = [0, 2.7]$. The figure was - drawn using Asymptote (\url{http://asymptote.sf.net/}).} - \label{fig:marginfig} -\end{marginfigure} -\begin{Verbatim} -\begin{marginfigure} - \includegraphics{helix} - \caption{This is a margin figure.} -\end{marginfigure} -\end{Verbatim} - -The \docenv{marginfigure} and \docenv{margintable} environments accept an optional parameter \docopt{offset} that adjusts the vertical position of the figure or table. See the ``\nameref{sec:sidenotes}'' section above for examples. The specifications are: -\begin{docspec} - \doccmd{begin\{marginfigure\}[\docopt{offset}]}\\ - \qquad\ldots\\ - \doccmd{end\{marginfigure\}}\\ - \mbox{}\\ - \doccmd{begin\{margintable\}[\docopt{offset}]}\\ - \qquad\ldots\\ - \doccmd{end\{margintable\}}\\ -\end{docspec} - -Figure~\ref{fig:fullfig} is an example of the \Verb|figure*| -environment and figure~\ref{fig:textfig} is an example of the normal -\Verb|figure| environment. - -\begin{figure*}[h] - \includegraphics[width=\linewidth]{sine.pdf}% - \caption{This graph shows $y = \sin x$ from about $x = [-10, 10]$. - \emph{Notice that this figure takes up the full page width.}}% - \label{fig:fullfig}% -\end{figure*} - -\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.}} - \label{fig:textfig} - %\zsavepos{pos:textfig} -\end{figure} - -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. - -\begin{table}[ht] - \centering - \fontfamily{ppl}\selectfont - \begin{tabular}{ll} - \toprule - Margin & Length \\ - \midrule - Paper width & \unit[8\nicefrac{1}{2}]{inches} \\ - Paper height & \unit[11]{inches} \\ - Textblock width & \unit[6\nicefrac{1}{2}]{inches} \\ - Textblock/sidenote gutter & \unit[\nicefrac{3}{8}]{inches} \\ - Sidenote width & \unit[2]{inches} \\ - \bottomrule - \end{tabular} - \caption{Here are the dimensions of the various margins used in the Tufte-handout class.} - \label{tab:normaltab} - %\zsavepos{pos:normaltab} -\end{table} - -\section{Full-width text blocks} - -In addition to the new float types, there is a \docenv{fullwidth} -environment that stretches across the main text block and the sidenotes -area. - -\begin{Verbatim} -\begin{fullwidth} -Lorem ipsum dolor sit amet... -\end{fullwidth} -\end{Verbatim} - -\begin{fullwidth} -\small\itshape\lipsum[1] -\end{fullwidth} - -\section{Typography}\label{sec:typography} - -\subsection{Typefaces}\label{sec:typefaces} -If the Palatino, \textsf{Helvetica}, and \texttt{Bera Mono} typefaces are installed, this style -will use them automatically. Otherwise, we'll fall back on the Computer Modern -typefaces. - -\subsection{Letterspacing}\label{sec:letterspacing} -This document class includes two new commands and some improvements on -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 \Verb|\allcaps| command has proper letterspacing for -strings of \allcaps{FULL CAPITAL LETTERS}, and the \Verb|\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 \Verb|\textsc| command has also been redefined to include -letterspacing. The case of the \Verb|\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.} - - -\section{Customization}\label{sec:customization} -\subsection{Document class options}\label{sec:options} -The \doccls{tufte-handout} class is based on the \LaTeX\ \doccls{article} -document class. Therefore, you can pass any of the typical article -options. There are a few options that are specific to the -\doccls{tufte-handout} document class, however. - -The \docclsopt{a4paper} option will set the paper size to \smallcaps{A4} instead of -the default \smallcaps{US} letter size. - -The \docclsopt{sfsidenotes} option will set the sidenotes and title block in a -\textsf{sans serif} typeface instead of the default roman. - -The \docclsopt{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 \docclsopt{oneside} mode). - -The \docclsopt{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 \docclsopt{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. - -\subsection{Defining new sections}\label{sec:defining-sections} -As mentioned in the ``\nameref{sec:headings}'' section (see -page~\pageref{sec:headings}), the \doccls{tufte\-handout} document class only -defines \doccmd{section} and \doccmd{subsection} headings. - -We use the \docpkg{titlesec} package to define the appearance of the headings. -To modify an existing section or to add a new section, see the documentation of -the \docpkg{titlesec} package. - - -\section{Installation}\label{sec:installation} -To install the Tufte-\LaTeX\ classes, simply drop the -following files into the same directory as your \texttt{.tex} -file: -\begin{quote} - \ttfamily - tufte-common.sty\\ - tufte-handout.cls\\ - tufte-book.cls -\end{quote} - -% TODO add instructions for installing it globally - - -\section{Support}\label{sec:support} - -\subsection{Package Dependencies}\label{sec:dependencies} -The following is a list of packages that the Tufte-\LaTeX\ 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} - -\subsection{Tufte-\LaTeX\ Website}\label{sec:website} -The website for the Tufte-\LaTeX\ 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. - -\bibliography{sample-handout} -\bibliographystyle{plainnat} - - - -\end{document} |