* Consolidated the common code for the figure[*]/table[*] and marginfigure/margintable environments.

* Suppressed the initial indent of the marginfigure/margintable environments.
* Added a couple hyphenation points to sample-handout.tex to remove some overfull hboxes.


git-svn-id: https://tufte-latex.googlecode.com/svn/trunk@89 516e2f36-ce3a-0410-bea4-1d4a03f5df72

sample-handout.tex

@@ -1,4 +1,4 @@
-\documentclass{tufte-handout}
+\documentclass[draft]{tufte-handout}
 
 %\geometry{showframe}% for debugging purposes -- displays the margins
 
@@ -62,7 +62,7 @@ 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.
+\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
@@ -173,7 +173,7 @@ 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}
+\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
@@ -269,7 +269,7 @@ 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
-letterspacing---that is, the spacing between the letters---should be
+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
@@ -284,10 +284,10 @@ however.  This allows one to use both uppercase and lowercase letters:
 
 \section{Customization}\label{sec:customization}
 \subsection{Document class options}\label{sec:options}
-The \doccls{tufte-handout} class is based on the \LaTeX\ \doccls{article}
+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.
+\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.
@@ -312,7 +312,7 @@ 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
+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.

tufte-common.sty

@@ -226,7 +226,7 @@
 
 % Paragraph indentation and separation for marginal text
 \newcommand{\@tufte@margin@par}{%
-  \setlength{\RaggedRightParindent}{0.5pc}
+  \setlength{\RaggedRightParindent}{0.5pc}%
   \setlength{\parindent}{0.5pc}%
   \setlength{\parskip}{0pt}%
 }
@@ -263,9 +263,9 @@
 % Set the justification baesed on the `justified' class option
 
 \newcommand{\@tufte@justification}{%
-  \ifthenelse{\boolean{@tufte@justified}}
-    {\justifying}
-    {\RaggedRight}
+  \ifthenelse{\boolean{@tufte@justified}}%
+    {\justifying}%
+    {\RaggedRight}%
 }
 
 %%
@@ -726,44 +726,40 @@
 \RequirePackage{placeins}
 
 %%
-% Margin figure environment
+% Margin float environment
 
-\newsavebox{\@tufte@marginfigbox}
-\newenvironment{marginfigure}[1][-1.2ex]
-  {\FloatBarrier% process all floats before this point so the figure numbers stay in order.
-  \begin{lrbox}{\@tufte@marginfigbox}%
+\newsavebox{\@tufte@margin@floatbox}
+\newenvironment{@tufte@margin@float}[2][-1.2ex]%
+  {\FloatBarrier% process all floats before this point so the figure/table numbers stay in order.
+  \begin{lrbox}{\@tufte@margin@floatbox}%
   \begin{minipage}{\marginparwidth}%
     \@tufte@marginfont%
-    \def\@captype{figure}%
+    \def\@captype{#2}%
     \hbox{}\vspace*{#1}%
     \@tufte@justification%
     \@tufte@margin@par%
-  }    
+    \noindent%
+  }
   {\end{minipage}%
   \end{lrbox}%
-  \marginpar{\usebox{\@tufte@marginfigbox}}%
+  \marginpar{\usebox{\@tufte@margin@floatbox}}%
   \@tufte@reset@par%
   }
 
 
+%%
+% Margin figure environment
+
+\newenvironment{marginfigure}[1][-1.2ex]%
+  {\begin{@tufte@margin@float}[#1]{figure}}
+  {\end{@tufte@margin@float}}
+
+
 %%
 % Margin table environment
-\newsavebox{\@tufte@margintablebox}
-\newenvironment{margintable}[1][-1.2ex]
-  {\FloatBarrier% process all floats before this point so the figure numbers stay in order.
-   \begin{lrbox}{\@tufte@margintablebox}%
-   \begin{minipage}{\marginparwidth}%
-     \@tufte@marginfont%
-     \def\@captype{table}%
-     \hbox{}\vspace*{#1}%
-     \@tufte@justification%
-     \@tufte@margin@par%
-  }
-  {\end{minipage}%
-   \end{lrbox}%
-   \marginpar{\usebox{\@tufte@margintablebox}}
-   \@tufte@reset@par%
-  }
+\newenvironment{margintable}[1][-1.2ex]%
+  {\begin{@tufte@margin@float}[#1]{table}}
+  {\end{@tufte@margin@float}}
 
 
 %%
@@ -808,9 +804,9 @@
 % TODO handle the symmetric class option (move caption to other side of verso pages)
 
 %%
-% Redefine the figure environment to place the captions in the margin space
+% Define a float environment to place the captions in the margin space
 
-\renewenvironment{figure}[1][htbp]
+\newenvironment{@tufte@float}[2][htbp]
   {% If the float placement specifier is 'b' and only 'b', then bottom-align the mini-pages, otherwise top-align them.
     \renewcommand{\@tufte@fps}{#1}%
     \ifthenelse{\equal{#1}{b}\OR\equal{#1}{B}}%
@@ -818,11 +814,11 @@
       {\renewcommand{\floatalignment}{t}}%
     \renewcommand{\caption}[2][]{\@tufte@caption[##1]{##2}}%
     \renewcommand{\label}[1]{\@tufte@label{##1}}%
-    \@tufte@orig@float{figure}[#1]%
+    \@tufte@orig@float{#2}[#1]%
     \begin{lrbox}{\@tufte@figure@box}%
       \begin{minipage}[\floatalignment]{\textwidth}\hbox{}%
   }
-  {% end tfigure
+  {% end @tufte@float
         \par\hbox{}\vspace{-\baselineskip}\ifthenelse{\prevdepth>0}{\vspace{-\prevdepth}}{}% align baselines of boxes
       \end{minipage}%
     \end{lrbox}%
@@ -852,59 +848,27 @@
     \gdef\@tufte@stored@caption{}
   }
 
+%%
+% Redefine the figure environment to place the captions in the margin space
+
+\renewenvironment{figure}[1][htbp]
+  {\begin{@tufte@float}[#1]{figure}}
+  {\end{@tufte@float}}
+
 
 %%
 % Redefine the table environment to place the captions in the margin space
 
 \renewenvironment{table}[1][htbp]
-  {% If the float placement specifier is 'b' and only 'b', then bottom-align the mini-pages, otherwise top-align them.
-    \renewcommand{\@tufte@fps}{#1}%
-    \ifthenelse{\equal{#1}{b}\OR\equal{#1}{B}}%
-      {\renewcommand{\floatalignment}{b}}%
-      {\renewcommand{\floatalignment}{t}}%
-    \renewcommand{\caption}[2][]{\@tufte@caption[##1]{##2}}%
-    \renewcommand{\label}[1]{\@tufte@label{##1}}%
-    \@tufte@orig@float{table}[#1]%
-    \begin{lrbox}{\@tufte@figure@box}%
-      \begin{minipage}[\floatalignment]{\textwidth}\hbox{}%
-  }
-  {% end table
-        \par\hbox{}\vspace{-\baselineskip}\ifthenelse{\prevdepth>0}{\vspace{-\prevdepth}}{}% align baselines of boxes
-      \end{minipage}%
-    \end{lrbox}%
-    % build the caption box
-    \begin{lrbox}{\@tufte@caption@box}%
-      \begin{minipage}[\floatalignment]{\marginparwidth}\hbox{}%
-        \ifthenelse{\NOT\equal{\@tufte@stored@caption}{}}{\@tufte@orig@caption[\@tufte@stored@shortcaption]{\@tufte@stored@caption}}{}%
-        \ifthenelse{\NOT\equal{\@tufte@stored@label}{}}{\@tufte@orig@label{\@tufte@stored@label}}{}%
-        \par\vspace{-\prevdepth}%% TODO: DOUBLE-CHECK FOR SAFETY
-      \end{minipage}%
-    \end{lrbox}%
-    % now typeset the stored boxes
-    \begin{fullwidth}%
-      \begin{minipage}[\floatalignment]{\paperwidth}%
-        \usebox{\@tufte@figure@box}%
-        \hspace{\marginparsep}%
-        \smash{\usebox{\@tufte@caption@box}}%
-      \end{minipage}%
-    \end{fullwidth}%
-    \@tufte@orig@endfloat%
-    % reset commands and temp boxes and captions
-    \let\caption\@tufte@orig@caption%
-    \let\label\@tufte@orig@label%
-    \begin{lrbox}{\@tufte@figure@box}\hbox{}\end{lrbox}
-    \begin{lrbox}{\@tufte@caption@box}\hbox{}\end{lrbox}
-    \gdef\@tufte@stored@shortcaption{}
-    \gdef\@tufte@stored@caption{}
-  }
+  {\begin{@tufte@float}[#1]{table}}
+  {\end{@tufte@float}}
 
 
 %%
-% Full-width figure
+% Full-width figures and tables
 
-\renewenvironment{figure*}[1]%
-  [htbp]%
-  {% begin figure*
+\newenvironment{@tufte@float@star}[2][htbp]%
+  {% begin
     % If the float placement specifier is 'b' and only 'b', then place the caption above the figure, else place the caption below the figure.
     \renewcommand{\@tufte@fps}{#1}%
     \ifthenelse{\equal{#1}{b}\OR\equal{#1}{B}}%
@@ -912,7 +876,7 @@
       {\renewcommand{\floatalignment}{t}}%
     \renewcommand{\caption}[2][]{\@tufte@caption[##1]{##2}}%
     \renewcommand{\label}[1]{\@tufte@label{##1}}%
-    \@tufte@orig@float{figure}[#1]%
+    \@tufte@orig@float{#2}[#1]%
     \begin{lrbox}{\@tufte@figure@box}%
       \begin{minipage}[\floatalignment]{\linewidth}\hbox{}%
         \begin{fullwidth}
@@ -956,62 +920,22 @@
     \gdef\@tufte@stored@caption{}
   }
 
+
+%%
+% Full-width figure
+
+\renewenvironment{figure*}[1][htbp]%
+  {\begin{@tufte@float@star}[#1]{figure}}
+  {\end{@tufte@float@star}}
+
+
 %%
 % Full-width table
 
-\renewenvironment{table*}[1]%
-  [htbp]%
-  {% begin table*
-    % If the float placement specifier is 'b' and only 'b', then place the caption above the table, else place the caption below the table.
-    \renewcommand{\@tufte@fps}{#1}%
-    \ifthenelse{\equal{#1}{b}\OR\equal{#1}{B}}%
-      {\renewcommand{\floatalignment}{b}}%
-      {\renewcommand{\floatalignment}{t}}%
-    \renewcommand{\caption}[2][]{\@tufte@caption[##1]{##2}}%
-    \renewcommand{\label}[1]{\@tufte@label{##1}}%
-    \@tufte@orig@float{table}[#1]%
-    \begin{lrbox}{\@tufte@table@box}%
-      \begin{minipage}[\floatalignment]{\linewidth}\hbox{}%
-        \begin{fullwidth}
-  }%
-  {% end table*
-          \par\hbox{}\vspace{-\baselineskip}\ifthenelse{\prevdepth>0}{\vspace{-\prevdepth}}{}% align baselines of boxes
-        \end{fullwidth}%
-      \end{minipage}%
-    \end{lrbox}%
-    % build the caption box
-    % TODO use \captionaboveskip and \captionbelowskip for spacing between caption and figure boxes
-    \begin{lrbox}{\@tufte@caption@box}%
-      \begin{minipage}[\floatalignment]{\marginparwidth}\hbox{}%
-        \ifthenelse{\NOT\equal{\@tufte@stored@caption}{}}{\@tufte@orig@caption[\@tufte@stored@shortcaption]{\@tufte@stored@caption}}{}%
-        \ifthenelse{\NOT\equal{\@tufte@stored@label}{}}{\@tufte@orig@label{\@tufte@stored@label}}{}%
-        \par\vspace{-\prevdepth}%% TODO: DOUBLE-CHECK FOR SAFETY
-      \end{minipage}%
-    \end{lrbox}%
-    % now typeset the stored boxes
-    \begin{fullwidth}%
-      \begin{minipage}[\floatalignment]{\paperwidth}%
-        \hbox{}%
-        \ifthenelse{\equal{\floatalignment}{b}}
-          {% place caption above table
-            \hspace{\@tufte@caption@fill}\smash{\usebox{\@tufte@caption@box}}\\
-            \usebox{\@tufte@table@box}%
-          }
-          {% place caption below table
-            \usebox{\@tufte@table@box}\\
-            \hspace{\@tufte@caption@fill}\smash{\usebox{\@tufte@caption@box}}%
-          }
-      \end{minipage}%
-    \end{fullwidth}%
-    \@tufte@orig@endfloat%
-    % reset commands and temp boxes and captions
-    \let\caption\@tufte@orig@caption%
-    \let\label\@tufte@orig@label%
-    \begin{lrbox}{\@tufte@table@box}\hbox{}\end{lrbox}
-    \begin{lrbox}{\@tufte@caption@box}\hbox{}\end{lrbox}
-    \gdef\@tufte@stored@shortcaption{}
-    \gdef\@tufte@stored@caption{}
-  }
+\renewenvironment{table*}[1][htbp]%
+  {\begin{@tufte@float@star}[#1]{table}}
+  {\end{@tufte@float@star}}
+
 
 %%
 % Full-page-width area