Changed package description and subtly modified documentation
authorTim Pope <code@tpope.net>
Sat, 15 Nov 2003 08:59:35 +0000 (08:59 +0000)
committerTim Pope <code@tpope.net>
Sat, 15 Nov 2003 08:59:35 +0000 (08:59 +0000)
mlastyle.dtx

index 9294498..f3cb935 100644 (file)
@@ -18,7 +18,7 @@
 % \iffalse
 %<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
 %<package>\ProvidesPackage{mlastyle}
-%<package>   [2003/11/09 v0.9 .dtx mlastyle file] 
+%<package>   [2003/11/09 v0.9 MLA format and documentation style]
 %
 %<*driver>
 \documentclass[draft]{ltxdoc}
@@ -36,8 +36,8 @@
   \addtolength{\headwidth}{-1in}
 \fi
 \IfFileExists{times.sty}%
-  {\newcommand{\examp}[2][]{{\let\emph\uline\fontfamily{ptm}\selectfont##2}##1}}%
-  {\newcommand{\examp}[2][]{``##2##1''}}
+{\newcommand{\examp}[2][]{{\let\emph\uline\fontfamily{ptm}\selectfont##2}##1}}%
+{\newcommand{\examp}[2][]{``##2##1''}}
 
 \EnableCrossrefs
 \CodelineIndex
 % \DoNotIndex{\string}
 % \DoNotIndex{\sw@llow}
 % \DoNotIndex{\the}
+% \DoNotIndex{\thebibliography}
 % \DoNotIndex{\thepage}
 % \DoNotIndex{\topsep}
 % \DoNotIndex{\usecounter}
 % \DoNotIndex{\pdfpagewidth}
 % \DoNotIndex{\special}
 %
-% \hyphenation{pre-am-ble pro-fess-ors}
+% \hyphenation{pre-am-ble wide-spread}
 %
 % \newcommand{\Lopt}[1]{\textsf {#1}}
 % \newcommand{\file}[1]{\texttt {#1}}
 %
 % \section{Introduction}
 %
-% MLA style consists of a set of documentation conventions that has gained
-% widespread acceptance in the humanites.  \LaTeX{} is a
-% document preparation system enjoying populatity in the scientific field.
+% MLA style, consisting of a set of documentation conventions, has
+% gained widespread acceptance in the humanities.  \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} aims to fill this void.
 %\instructor{Professor Smith}
 %\course{English 101}
 %\date{1~Jan.\ 1970}
-%\title{The Futility of Compulsory English Classes}
+%\title{The Inherent Sadism of Compulsory English Classes}
 %
 %\begin{document}
 %\maketitle
 % MLA style recommends the DD~Mon.~YYYY format for specifying dates;
 % \DescribeMacro{\today}|\today| has been conveniently redefined to this.
 % However, other formats can be used as long as done so consistently
-% throughout the document.  Also note that the date in the header should
-% be the due date of the assignment; students who finish assignments early
-% would be wise to call |\date|\marg{due date}.
+% throughout the document.  Also note that the date in the
+% heading\index{heading|usage} should be the due date of the assignment;
+% students who finish assignments early would be wise to call
+% |\date|\marg{due date}.
 %
 % \subsection{Environments}
-% \DescribeEnv{verse}
-% \DescribeEnv{quote}
-% \DescribeEnv{quotation}
 % Three environments have been modified from standard \LaTeX to better
-% suit MLA format.  To typeset poetry\index{poetry|usage} and
-% drama\index{drama|usage}, use the |verse| environment.
-% Quotations\index{quotations|usage} of a single paragraph or less always
-% use the |quote| environment.  For longer passages, use the |quotation|
-% environment if the beginning of the passage marks the beginning of a
-% paragraph.  Otherwise, use the |quote| environment.
+% suit MLA format.  To typeset \index{poetry|usage}poetry and
+% \index{drama|usage}drama, use the \DescribeEnv{verse}|verse|
+% environment.  Quotations\index{quotations|usage} of a single paragraph
+% or less always use the \DescribeEnv{quote}|quote| environment.  For
+% longer passages, use the \DescribeEnv{quotation}|quotation| environment
+% if the beginning of the passage marks the beginning of a paragraph.
+% Otherwise, use the |quote| environment.
 %
 % Be sure to follow MLA guidelines when using these environments.  Short
 % quotes should be enclosed in quotation marks and included directly in
 % \OptionIndex{format}\Lopt{format}
 % option tells \package{mlastyle} to use MLA format (i.e., 1 inch margins,
 % double-spaced, etc.).  The \OptionIndex{style}\Lopt{style} option tells
-% \package{mlastyle} to use MLA style (i.e., parenthetical documentation
-% includes the author and page number, etc).  Each of these options
+% \package{mlastyle} to use MLA style (i.e., the format of parenthetical
+% documentation, etc).  Each of these options
 % disables the other; to use both MLA format and MLA style, specify the
 % \OptionIndex{mla}\Lopt{mla} option, or nothing at all.
 %
 % \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 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} mode, the
-% \OptionIndex{underline}\Lopt{underline} option can be used.
+% text.  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}
+% mode, the \OptionIndex{underline}\Lopt{underline} option can be used.
 %
 % \subsubsection{Fonts}
 % By default, \package{mlastyle} uses \TeX's standard Computer Modern
-% font.  Some professors\penalty\exhyphenpenalty---particularly those
-% concerned with document length---mandate that assignments be set in
-% \examp[.]{Times}  This can be achieved with the
+% font.  Some profess\-ors\penalty500---particularly those
+% concerned with document length---require assignments to be set in
+% \examp[.]{Times New Roman}  This can be achieved with the
 % \OptionIndex{times}\Lopt{times} option, which simply loads the
-% \package{times} package.  This option can be cancelled with
-% the \OptionIndex{cm}\Lopt{cm} option, which reverts to Computer Modern.
+% \package{times} package.  This opposite of this option is
+% \OptionIndex{cm}\Lopt{cm}, which reverts to Computer Modern.
 %
 % \index{works cited|usage}
 % \subsection{Documenting Sources} \label{sec:documentation}
 %
-% The \package{mlastyle} package reimpliments the
+% The \package{mlastyle} package reimplements the
 % \DescribeEnv{thebibliography}|thebibliography| environment to generate
-% the list of works cited in MLA style.  Use of \LaTeX's bibliography
-% features is beyond the scope of this document; however, the following
-% example, which should be included just before |\end{document}|, might
-% prove to be a useful starting point:
+% the list of works cited in MLA style.  Instruction in the basic use of
+% \LaTeX's bibliography features is beyond the scope of this document;
+% however, the following example, which should be included just before
+% |\end{document}|, might prove to be a useful starting point:
 %\begin{verbatim}
 %\begin{thebibliography}{}
 %
 %    \end{macrocode}
 % \end{environment}
 % \begin{environment}{workscited}
-% Works Cited environment, for compatibility with \package{mla-paper}.
+% Works cited environment, for compatibility with \package{mla-paper}.
 %    \begin{macrocode}
   \newenvironment{workscited}%
     {\newpage{\centerline{Works Cited}}}{\newpage}
   \fi
 %    \end{macrocode}
 % \subsubsection{Bibliography}
+% \begin{environment}{thebibliography}
 % The definition of |\thebibliography| varies depending on the document
 % class.
 %    \begin{macrocode}
       \sloppy%\sfcode`\.=1000\relax
       \catcode`/=13\let/=\mlastyle@slash}}
 %    \end{macrocode}
+% \end{environment}
 %    \begin{macrocode}
 \fi % \ifmlastyle@format
 %    \end{macrocode}
 % ^^A                \item #1 \end{list}}
 % \subsubsection{Plain Style}
 % \begin{macro}{\citeC}
-% This next block is used only if the \Lopt{compat} option is set.
+% This next block is used if the \Lopt{compat} or \Lopt{format} option is
+% set.
 %    \begin{macrocode}
 \else
   \newcommand{\mlastyle@cite}[2][]{\@tempswafalse\@citex[]{#2}}