* Added some default colors for hyperlinks. (Colors provided by Jason Catena.

Thanks, Jason!)
* Write some troubleshooting/support documentation.
* Added list of unsupported class options and warned about their use.
* Now formatting the description label (of the description environment) in
  italics instead of bold.


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

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.}}
@@ -113,6 +115,7 @@
 \newcommand{\docpkg}[1]{\texttt{#1}\index{#1@\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{\docmsg}[2]{\bigskip\begin{fullwidth}\noindent\ttfamily#1\end{fullwidth}\medskip\par\noindent#2}
 
 % Generates the index
 \usepackage{makeidx}
@@ -204,7 +207,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.
 
 
 %%
@@ -388,7 +391,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,7 +441,7 @@ 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
@@ -732,14 +735,112 @@ being loaded.  The default is to load the \docpkg{hyperref} package and use the
 \index{class options|)}
 
 
+\chapter{Troubleshooting and Support}
+\label{ch:troubleshooting}
+
+\section{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.
+
+\section{Tufte-\LaTeX\ 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.
+
+
+\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{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.}
+
+
+
+
+\section{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}
+
+
+
 
 %%
 % The back matter contains appendices, bibliographies, indices, glossaries, etc.
 
-\backmatter
 
 
 
+
+
+
+\backmatter
+
 \bibliography{sample-handout}
 \bibliographystyle{plainnat}
 

tufte-common.sty

@@ -113,7 +113,23 @@
 \DeclareOption{hyper}{\setboolean{@tufte@loadhyper}{true}}
 \DeclareOption{nohyper}{\setboolean{@tufte@loadhyper}{false}}
 
-% FIXME: should probably specify options not supported like Mittelbach's aipproc.cls
+%%
+% Unsupported options
+
+\newcommand{\@tufte@unsupported@option}[1]{\PackageWarningNoLine{\@tufte@pkgname}{Option `#1' is not supported -- \MessageBreak ignoring option}}
+
+\DeclareOption{10pt}{\@tufte@unsupported@option{\CurrentOption}}
+\DeclareOption{11pt}{\@tufte@unsupported@option{\CurrentOption}}
+\DeclareOption{12pt}{\@tufte@unsupported@option{\CurrentOption}}
+\DeclareOption{a5paper}{\@tufte@unsupported@option{\CurrentOption}}
+\DeclareOption{b5paper}{\@tufte@unsupported@option{\CurrentOption}}
+\DeclareOption{executivepaper}{\@tufte@unsupported@option{\CurrentOption}}
+\DeclareOption{executivepaper}{\@tufte@unsupported@option{\CurrentOption}}
+\DeclareOption{legalpaper}{\@tufte@unsupported@option{\CurrentOption}}
+\DeclareOption{landscape}{\@tufte@unsupported@option{\CurrentOption}}
+\DeclareOption{onecolumn}{\@tufte@unsupported@option{\CurrentOption}}
+\DeclareOption{twocolumn}{\@tufte@unsupported@option{\CurrentOption}}
+
 
 \DeclareOption*{\PassOptionsToClass{\CurrentOption}{\@tufte@class}}
 \ProcessOptions
@@ -164,7 +180,11 @@
   \hypersetup{%
     pdfborder = {0 0 0},
     bookmarksdepth = section,
-    hyperfootnotes=false,
+    hyperfootnotes = false,
+    citecolor = DarkGreen,
+    linkcolor = DarkBlue,
+    pagecolor = DarkBlue,
+    urlcolor = DarkGreen,
   }%
 }{%
 }
@@ -552,6 +572,11 @@
                 \item\relax}
                {\endlist}
 
+%%
+% Italicize description run-in headings (instead of the default bold)
+
+\renewcommand*\descriptionlabel[1]{\hspace\labelsep\normalfont\em #1}
+
 
 %%
 % Used for doublespacing, and other linespacing