Fixed typos and some index entries
[latex-mlastyle.git] / mlastyle.dtx
index 537c8477616b5d7dec63b3d8f73bbc36e0633aad..d6566af6307128bfa527d2948651cabd3362ce72 100644 (file)
 %
 %<*driver>
 \documentclass[draft]{ltxdoc}
-\iftrue
-  \usepackage[compat]{mlastyle}
-  \addtolength{\headsep}{-25pt}
-  \addtolength{\headheight}{-12pt}
-  \addtolength{\topmargin}{-17pt}
-  \addtolength{\textheight}{58pt}
-  \IfFileExists{ulem.sty}{\usepackage[normalem]{ulem}}{\let\uline\emph}
-\else
+\iffalse
   \usepackage[mla]{mlastyle}
+  \bibliographystyle{mlastyle}
   \addtolength{\marginparwidth}{1in}
   \addtolength{\textwidth}{-1in}
   \addtolength{\headwidth}{-1in}
+\else
+  \usepackage[compat]{mlastyle}
+  \bibliographystyle{plain}
+  \addtolength{\headsep}{-5pt}
+  %\addtolength{\headheight}{-12pt}
+  \addtolength{\topmargin}{-17pt}
+  \addtolength{\textheight}{22pt}
+  \IfFileExists{ulem.sty}{\usepackage[normalem]{ulem}}{\let\uline\emph}
 \fi
 \IfFileExists{times.sty}%
 {\newcommand{\examp}[2][]{{\let\emph\uline\fontfamily{ptm}\selectfont##2}##1}}%
 % \DoNotIndex{\def}
 % \DoNotIndex{\do}
 % \DoNotIndex{\edef}
+% \DoNotIndex{\egroup}
 % \DoNotIndex{\else}
 % \DoNotIndex{\end}
 % \DoNotIndex{\endcsname}
 % \surname{Pope}
 %
 % \maketitle
+%
 % \tableofcontents
 %
 % \section{Introduction}
 %
-% MLA style, consisting of a set of documentation conventions, has
-% gained widespread acceptance in the humanities.  \LaTeX{} is a
+% ^^A MLA style, consisting of a set of documentation conventions, has
+% ^^A gained widespread acceptance in the humanities.
+% According to the {\em MLA Handbook for Writers of Research
+% Papers}\citeC{handbook}, MLA style is a set of ``commonly agreed-on
+% rules for documenting quotations, facts, opinions and paraphrases'' that
+% ``is preferred by a substantial majority of scholarly journals in
+% language and literature{\makeatletter\ifmlastyle@style
+% .''\citeM[xvi]{handbook}\else.''\fi} \LaTeX{} is a
 % document preparation system enjoying popularity in the scientific field.
 % It should come as no surprise that complete, up-to-date implementations
 % of MLA style for \LaTeX{} are in short supply.  The \LaTeX{} package
 % \package{mlastyle}.
 %
 % \subsubsection{Italics vs.\ Underlining} \index{underlining|usage}
-% \index{italics|usage}
-% MLA format dictates that emphasis should be indicated by underlining the
-% text.  Thus, the \package{ulem} package, which underlines all emphasized
+% \index{italics|usage}\label{sec:italics}
+% The {\em MLA Handbook\/}\citeC{handbook} dictates that emphasis should
+% be indicated by underlining the text\citeM[94]{handbook}.  Thus, the
+% \package{ulem} package, which underlines all emphasized
 % text, is loaded by default in \Lopt{mla} and \Lopt{format} modes.  To
 % disable this, use the \OptionIndex{italics}\Lopt{italics} option.
 % Conversely, if underlining is desired in \Lopt{style} or \Lopt{compat}
 % Three additional citation commands are provided, all of which take the
 % same arguments as |\cite|.  To omit the author information from the
 % citation, use \DescribeMacro{\citepage}|\citepage|.  Indirect
-% citations---those of the format \examp{(qtd. in Brown 6)}---can be
+% citations---those of the format \examp{(qtd. in Pope
+% \pageref{sec:italics})}---can be
 % created with \DescribeMacro{\citeindirect}|\citeindirect|.  Finally, the
 % parentheses are omitted by \DescribeMacro{\citeN}|\citeN|.  This was
 % intended for use in cross references, but it can also help in citing
 % multiple works.  The result of
-% |(\citeN[42]{knuth}|\texttt{; }|\citeN[69]{lamport})|
+% |(\citeN[42]{texbook}|\texttt{; }|\citeN[69]{latex})|
 % would be something like \examp[.]{(Knuth 42; Lamport 69)}
 %
 % \subsubsection{Using {\rm \BibTeX}} \label{sec:bibtex}
 % \emph{\LaTeX\/})} instead of \examp[.]{(Lamport, \emph{\LaTeX: A Document
 % Preparation System\/})}
 %
-% \StopEventually{\PrintChanges\PrintIndex}
+% \StopEventually{\PrintChanges\bibliography{mlastyle}\PrintIndex}
 %
 % \section{Implementation}
 %    \begin{macrocode}
   \fi
 \fi % \ifmlastyle@bibstyle
 %    \end{macrocode}
+% \begin{macro}{\UL@onin}
 % Load the \package{ulem} package if the \Lopt{underline} option is set.
+% By default, \package{ulem} does multiple underlining for nested
+% emphasis.  This is changed to MLA-style behavior with the redefinition
+% of |\UL@onin|.
 %    \begin{macrocode}
 \ifmlastyle@underline
   \RequirePackage{ulem}
+  \def\UL@onin#1{\egroup\UL@stop#1\UL@start}
 \fi % \ifmlastyle@underline
 %    \end{macrocode}
+% \end{macro}
 % Load the \package{times} package if the \Lopt{times} option is set.
 %    \begin{macrocode}
 \ifmlastyle@times
 % \end{macro}
 % \begin{macro}{\section}
 % \begin{macro}{\subsection}
+% \begin{macro}{\subsubsection}
 % Sections are formatted by centering the section name and beginning a new
 % page.  Subsections simply center the section name.
 %    \begin{macrocode}
 % ^^A\def\verbatim@font{\mlastyle@qspread\mlastyle@vfont}
 % \end{macro}
 % \end{macro}
+% \end{macro}
 % \subsubsection{Environments}
 % ^^A%\newenvironment{blocks}{\begin{quote} \linespread{1} \selectfont}{\end{quote} \linespread{2} \small \selectfont}
 % ^^A%\newenvironment{blockm}{\begin{quotation} \linespread{1} \selectfont}{\end{quotation} \linespread{2} \selectfont}
 %    \end{macrocode}
 % \end{macro}
 % \subsubsection{MLA Style}
+% \begin{macro}{\@cite}
 % \begin{macro}{\citeM}
 % If the \Lopt{mla} or \Lopt{style} options are used, the following is
 % executed.
   \let\citeC\mlastyle@relax
 %    \end{macrocode}
 % \end{macro}
+% \end{macro}
 % \iffalse
 % Place commas in-between citations in the same |\citeyear|, |\citeyearNP|,
 % |\citeN|, or |\shortciteN| command.
   \let\cite\mlastyle@cite
   \let\citepage\mlastyle@cite
   \let\citeindirect\mlastyle@cite
-  \newcommand{\citeC}[2][]{ \@tempswafalse\@citex[]{#2}}
+  \newcommand{\citeC}[2][]{~\@tempswafalse\@citex[]{#2}}
   \let\citeM\mlastyle@relax
   \let\citepageM\mlastyle@relax
   \let\citeindirectM\mlastyle@relax