Added \crefname{part} example

[drexel-thesis.git] / drexel-thesis.dtx

diff --git a/drexel-thesis.dtx b/drexel-thesis.dtx
index 2cce1b61d6e85b5dd06a598ffaece9957b1bbe76..31d58698c790e5730800b21151bc16d6fc2bfe78 100644 (file)
--- a/drexel-thesis.dtx
+++ b/drexel-thesis.dtx
@@ -511,7 +511,19 @@
 % For more useful float information, see the
 % \href{http://en.wikibooks.org/wiki/LaTeX/Floats,_Figures_and_Captions}
 %   {\LaTeX\ wikibook page}.
-% 
+%
+% \href{http://www.ctan.org/tex-archive/macros/latex/contrib/subfig/}{\pkg{subfig}}
+% cooperates with \cls{drexel-thesis}'s included \pkg{floatrow}.  If
+% you wish to use the \pkg{subfig} macros, you should add something
+% like
+% \begin{example}
+%   \usepackage{subfig}
+%   \usepackage{fr-subfig}
+% \end{example}
+% See the \pkg{floatrow} documentation (Sec.~7.1, ``The \pkg{subfig}
+% package'') and \pkg{subfig} documentation (Sec.~4.3,
+% ``\pkg{FloatRow} Package'') for details.
+%
 %
 % \subsubsection{Citations}
 %
@@ -529,8 +541,16 @@
 %
 % \subsubsection{References}
 %
+% Easier cross referencing with
 % \href{http://www.ctan.org/tex-archive/macros/latex/contrib/cleveref/}{\pkg{cleveref}}.
-% Is a wonderful tool for easy, consistent crosslinking.  The manual is also very good.
+% Is a wonderful tool for easy, consistent crosslinking via |\cref|,
+% |\Cref|, etc..  The manual is also very good.
+% Note that if you use |\part|s in your document, you need to tell
+% \pkg{cleveref} how to deal with them:
+% \begin{example}
+%   \usepackage{cleveref}
+%   \crefname{part}{part}{parts}
+% \end{example}
 %
 %
 % \subsubsection{Hyperlinks}
@@ -548,6 +568,39 @@
 % set options overriding these defaults.
 %
 %
+% \subsubsection{Developing large \LaTeX\ documents}
+%
+% A thesis may take a while to compile, especially if it contains
+% lots of images, etc..  One way to save time, is to use |\includeonly|
+% when including chapter \file{*.tex} files (see
+% \href{http://en.wikibooks.org/wiki/TeX/includeonly}{the \TeX\ Wikibook}).
+% Usage would be something like
+% \begin{example}
+% \documentclass{drexel-thesis}
+% ...
+% \includeonly{chapter2.tex,chapter3.tex}
+% \begin{document}
+% ...
+% \begin{thesis}
+% \include{chapter1.tex}
+% \include{chapter2.tex}
+% \include{chapter3.tex}
+% \include{chapter4.tex}
+% \end{thesis}
+% ...
+% \end{document}
+% \end{example}
+% which would only compile chapters two and three.  Don't confuse the
+% similar commands |\include| and |\input|.  The more fundamental
+% |\input| just inserts the file contents at that point, while
+% |\include|
+% \begin{itemize}
+%   \item may only be used after |\begin{document}|
+%   \item acts like |\clearpage \input{} \clearpage|
+%   \item will not crash on nonexistent files
+% \end{itemize}
+%
+%
 % \StopEventually{\pagebreak\PrintChanges}
 %
 %
@@ -2842,6 +2895,8 @@ parenthetical citation\citep{rief97}.
 \chapter{A Long Title Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla
 Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla}
 \blabla{30}{20}
+\section{Section in long-titled chapter}
+\blabla{30}{20}
 %</example-part>
 %    \end{macrocode}
 %
@@ -2967,7 +3022,26 @@ Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla}
 % \begin{itemize}
 %   \item Different space between chapter heading and section heading,
 %     vs.\ chapter heading and text.  Compare \emph{A Chapter Heading}
-%     and \emph{Another Chapter} in \file{example.pdf}.
+%     and \emph{Another Chapter} in \file{example.pdf}.  This is a
+%     problem (although with opposite order) in the \cls{book} class
+%     itself.  For example, compile
+%     \begin{example}
+%\documentclass{book}
+%\begin{document}
+%\chapter{Chapter with text}
+%Bla bla bla.
+%\chapter{Chapter with section}
+%\section{Section}
+%Bla bla bla.
+%\end{document}
+%     \end{example}
+%   \item Footer overlap if chapter/section names are particularly long.
+%     See \emph{Section in long-titled chapter} in \file{example.pdf}.
+%     Workaround: turn off either chapters or sections in the footer.
+%     \begin{example}
+%       \fancyfoot[RE,LO]{\scshape\leftmark}
+%       \fancyfoot[LE,RO]{}
+%     \end{example}
 % \end{itemize}
 %
 %