Substituted instructor and course for professor and classname
authorTim Pope <code@tpope.net>
Thu, 13 Nov 2003 07:25:52 +0000 (07:25 +0000)
committerTim Pope <code@tpope.net>
Thu, 13 Nov 2003 07:25:52 +0000 (07:25 +0000)
mlastyle.dtx

index d38f36c..fbb8c27 100644 (file)
 %\usepackage{mlastyle}
 %
 %\author{John Doe}
-%\professor{Professor Smith}
-%\classname{English 101}
+%\instructor{Professor Smith}
+%\course{English 101}
 %\date{1~Jan.\ 1970}
 %\title{The Futility of Compulsory English Classes}
 %
 %\end{document}\end{verbatim}
 % \subsection{Initiation Macros}
 % \DescribeMacro{\maketitle}
-% \DescribeMacro{\professor}
-% \DescribeMacro{\classname}
+% \DescribeMacro{\instuctor}
+% \DescribeMacro{\course}
 % The mandatory heading\index{heading|usage} is generated with
 % |\maketitle|.  Use the standard macros |\author|, |\title|, and |\date|
-% to specify the relevant information.  To define the professor and name
-% of the class, use the aptly named |\professor|\marg{name} and
-% |\classname|\marg{class} macros.
+% to specify the relevant information.  To define the instructor and name
+% of the course, use the aptly named |\instructor|\marg{instructor} and
+% |\instructor|\marg{course} macros.
 %
-% \DescribeMacro{\lastname}
+% \DescribeMacro{\surname}
 % The last name for use in the header\index{header|usage} is derived from
 % |\author|.  If this does not produce the desired result, use
-% |\lastname|\marg{last name} to override it.
+% |\surname|\marg{last name} to override it.
 %
 % \DescribeMacro{\date}
 % \DescribeMacro{\today}
 % \subsection{Documentating Sources}
 %
 % Coupled with \BibTeX, \package{mlastyle} provides a experimental
-% implementation of MLA documentation style.  Load the bibliography style
-% by putting |\bibliographystyle{mlastyle}| in the document preamble.
+% implementation of MLA documentation style.  Put |\bibstyle{mlastyle}| in
+% the document preamble to load the bibliography style.
 %
 % \StopEventually{\PrintChanges\PrintIndex}
+%
+% \section{Implementation}
 % \iffalse
 %<*package>
 % \fi
-% \section{Implementation}
-%
 % \subsection{Options}
 %
-% First, the options.
+% Most options are implemented by modifying a |\newif| declared for this
+% purpose.
 %    \begin{macrocode}
 \newif\ifmlastyle@bibstyle
 \DeclareOption{bibstyle}{\mlastyle@bibstyletrue}
 \DeclareOption{nobibstyle}{\mlastyle@bibstylefalse}
-%    \end{macrocode}
-%    \begin{macrocode}
 \newif\ifmlastyle@papersize
 \DeclareOption{papersize}{\mlastyle@papersizetrue}
 \DeclareOption{nopapersize}{\mlastyle@papersizefalse}
 \fi % \ifmlastyle@times
 %    \end{macrocode}
 % \subsection{Macros}
-% \begin{macro}{\professor}
-% Define the professor.
+% \begin{macro}{\instructor}
+% Define the instructor, along with an obsolete synonym.
 %    \begin{macrocode}
-\def\professor#1{\gdef\theprofessor{#1}}
+\def\instructor#1{\gdef\mlastyle@instructor{#1}}
+\let\professor\instructor
 %    \end{macrocode}
 % \end{macro}
-% \begin{macro}{\classname}
-% Define the class.
+% \begin{macro}{\course}
+% Define the course, along with an obsolete synonym.
 %    \begin{macrocode}
-\def\classname#1{\gdef\theclassname{#1}}
+\def\course#1{\gdef\mlastyle@course{#1}}
+\let\classname\course
 %    \end{macrocode}
 % \end{macro}
-% \begin{macro}{\lastname}
-% Define the last name.
+% \begin{macro}{\surname}
+% Define the surname, along with an obsolete synonym.
 %    \begin{macrocode}
-\def\lastname#1{\gdef\thelastname{#1}}
+\def\surname#1{\gdef\mlastyle@surname{#1}}
+\let\lastname\surname
 %    \end{macrocode}
 % \end{macro}
 % \subsection{Formatting}
 %    \begin{macrocode}
   \renewcommand{\maketitle}{\begin{flushleft}
     \@author\par
-    \@ifundefined{theprofessor}{}{\theprofessor}\par
-    \@ifundefined{theclassname}{}{\theclassname}\par
+    \@ifundefined{mlastyle@instructor}{}{\mlastyle@instructor}\par
+    \@ifundefined{mlastyle@course}{}{\mlastyle@course}\par
     \@date\end{flushleft}
     \begin{center}\@title\end{center}\par
   }
   \fancypagestyle{mlastyle}{
     \fancyhf{}
     \def\sw@llow##1 {}
-    \rhead{\@ifundefined{thelastname}%
-      {\expandafter\sw@llow\@author}{\thelastname} \thepage}
+    \rhead{\@ifundefined{mlastyle@surname}%
+      {\expandafter\sw@llow\@author}{\mlastyle@surname} \thepage}
     \renewcommand{\headrulewidth}{0pt}
     \renewcommand{\footrulewidth}{0pt}
   }
 %
 % \Finale
 \endinput
+% vim:tw=74