Mention bugs/hacks in the documentation
authorW. Trevor King <wking@drexel.edu>
Wed, 13 Jan 2010 20:26:45 +0000 (15:26 -0500)
committerW. Trevor King <wking@drexel.edu>
Wed, 13 Jan 2010 20:27:50 +0000 (15:27 -0500)
drexel-thesis.dtx

index 055d1fd6de2a12faa202e922dfa34a4337e286f2..e6a6c5f615e4d766b455701581c9edc7b0c07c08 100644 (file)
 % Adding even a \vspace*{0\p@} here seems to increase the vertical
 % space above the chapter heading by two lines.  I'm not sure why.
 % Workaround is to pass the ``value of blanklines you want minus two''
-% to |\blanklines*|.
+% to |\blanklines*|.  HACK!
 %    \begin{macro}
   \blanklines*{-1}%
   {\parindent \z@ \raggedright \normalfont
 % (\file{classes.dtx}, L2595).
 %    \begin{macrocode}
 \def\@makeschapterhead#1{%
-  \blanklines*{-1}%
+  \blanklines*{-1}% HACK!
   {\parindent \z@ \raggedright \normalfont
     \setstretch{\@ssp}%
     \interlinepenalty\@M
 % \begin{macro}{\afterloftitleskip}
 % Don't add any extra space after the title (the chapter will take
 % care of that).  Actually we make a one-line correction so the first
-% line matches the first line in the TOC.
+% line matches the first line in the TOC.  HACK!
 %    \begin{macrocode}
 \setlength\cftafterloftitleskip{-12pt}
 %    \end{macrocode}
 % \begin{macro}{\afterlottitleskip}
 % Don't add any extra space after the title (the chapter will take
 % care of that).  Actually we make a one-line correction so the first
-% line matches the first line in the TOC.
+% line matches the first line in the TOC.  HACK!
 %    \begin{macrocode}
 \setlength\cftafterlottitleskip{-12pt}
 %    \end{macrocode}
@@ -2948,5 +2948,28 @@ Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla Bla}
 %    \end{macrocode}
 %
 %
+% \section{Known bugs and issues}
+%
+%
+% \subsection{Hacks}
+%
+% \begin{itemize}
+%   \item |\vspace*{0\p@}| space between page top and chapter
+%     headings (|\@makechapterhead| and |\@makeschapterhead|,
+%     Sec.~\ref{sec:implement-chapters}).
+%   \item Extra space under LOT and LOF titles compared to TOC.
+%     (Secs.~\ref{sec:implement-lof} and \ref{sec:implement-lot}).
+% \end{itemize}
+%
+%
+% \subsection{Bugs}
+%
+% \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}.
+% \end{itemize}
+%
+%
 % \Finale
 \endinput