X-Git-Url: http://git.tpope.net/?p=latex-mlastyle.git;a=blobdiff_plain;f=mlastyle.dtx;h=252e96ac7a64a5f3777130c1f79d20a37501be74;hp=f3cb9355382248f43390707ddc80a9657f88890a;hb=83bae224ee37b9f4c40f596dac6a9bb3ba962a5c;hpb=637e1f360a5c026c575fc6ce46d630c2d31e2eb1 diff --git a/mlastyle.dtx b/mlastyle.dtx index f3cb935..252e96a 100644 --- a/mlastyle.dtx +++ b/mlastyle.dtx @@ -21,19 +21,61 @@ % [2003/11/09 v0.9 MLA format and documentation style] % %<*driver> +\begin{filecontents}{mlastyle.bib} +@PREAMBLE{"\def\BibTex{\rmfamily B\kern -.05em\textsc {i\kern -.025emb}\kern -.08emT\kern -.1667em\lower .7ex\hbox {E}\kern -.125emX}"} + +@BOOK{handbook, + AUTHOR = "Joseph Gibaldi", + TITLE = "MLA Handbook for Writers of Research Papers", + KEY = "MLA Handbook", + EDITION = "Sixth", + ADDRESS = "New York", + PUBLISHER = "MLA", + YEAR = "2003"} + +@BOOK{latexdps, + AUTHOR = "Leslie Lamport", + TITLE = "{\LaTeX}: A Document Preparation System", + KEY = "{\LaTeX}", + EDITION = "Second", + ADDRESS = "Reading", + PUBLISHER = "Addison-Wesley", + YEAR = "1994"} + +@MANUAL{lshort, + AUTHOR = "Tobias Oetker and Hubert Partl and Irene Hyna and Elisabeth +Schlegl", + TITLE = "The Not So Short Introduction to {\LaTeXe}", + KEY = "Not So Short", + YEAR = "2000", + MONTH = dec, + VERSION = "4.0", + ACCESSDATE = "1~"#nov#"~2003", + URL = "CTAN://info/lshort/"} + +@MANUAL{btxdoc, + AUTHOR = "Oren Patashnik", + TITLE = "{\BibTex ing}", + YEAR = "1988", + MONTH = feb, + ACCESSDATE = "1~"#nov#"~2003", + URL = "CTAN://biblio/bibtex/distribs/doc/btxdoc.tex"} +\end{filecontents} \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}}% @@ -95,6 +137,7 @@ % \DoNotIndex{\@listiv} % \DoNotIndex{\@listv} % \DoNotIndex{\@listvi} +% \DoNotIndex{\@m} % \DoNotIndex{\@startsection} % \DoNotIndex{\@tempswafalse} % \DoNotIndex{\@title} @@ -104,6 +147,7 @@ % \DoNotIndex{\G@refundefinedtrue} % \DoNotIndex{\ProcessOptions} % \DoNotIndex{\RequirePackage} +% \DoNotIndex{\UL@start,\UL@stop} % \DoNotIndex{\addtolength} % \DoNotIndex{\advance} % \DoNotIndex{\baselineskip} @@ -115,12 +159,14 @@ % \DoNotIndex{\centerline} % \DoNotIndex{\chapter} % \DoNotIndex{\citation} +% \DoNotIndex{\citet,\citep} % \DoNotIndex{\clearpage} % \DoNotIndex{\csname} % \DoNotIndex{\day} % \DoNotIndex{\def} % \DoNotIndex{\do} % \DoNotIndex{\edef} +% \DoNotIndex{\egroup} % \DoNotIndex{\else} % \DoNotIndex{\end} % \DoNotIndex{\endcsname} @@ -133,6 +179,7 @@ % \DoNotIndex{\fi} % \DoNotIndex{\futurelet} % \DoNotIndex{\gdef} +% \DoNotIndex{\global} % \DoNotIndex{\hangindent} % \DoNotIndex{\headrulewidth} % \DoNotIndex{\if@filesw} @@ -186,6 +233,7 @@ % \DoNotIndex{\month} % \DoNotIndex{\newblock} % \DoNotIndex{\newcommand} +% \DoNotIndex{\newdimen} % \DoNotIndex{\newenvironment} % \DoNotIndex{\newif} % \DoNotIndex{\newpage} @@ -205,6 +253,7 @@ % \DoNotIndex{\renewenvironment} % \DoNotIndex{\reset@font} % \DoNotIndex{\rhead} +% \DoNotIndex{\selectfont} % \DoNotIndex{\setlength} % \DoNotIndex{\settowidth} % \DoNotIndex{\sfcode} @@ -222,6 +271,7 @@ % \DoNotIndex{\write} % \DoNotIndex{\year} % \DoNotIndex{\z@} +% \DoNotIndex{\bibhang} % \DoNotIndex{\evensidemargin} % \DoNotIndex{\headheight} % \DoNotIndex{\headsep} @@ -256,12 +306,19 @@ % \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 @@ -278,7 +335,7 @@ %\instructor{Professor Smith} %\course{English 101} %\date{1~Jan.\ 1970} -%\title{The Inherent Sadism of Compulsory English Classes} +%\title{The Sadism Inherent in Compulsory English Classes} % %\begin{document} %\maketitle @@ -339,9 +396,10 @@ % \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} @@ -368,16 +426,15 @@ %\begin{verbatim} %\begin{thebibliography}{} % -%\bibitem[Lamport]{latex} +%\bibitem[Lamport]{latexdps} %Lamport, Leslie. -%\newblock {\em \LaTeX: A Document Preparation System}. +%\newblock \emph{\LaTeX: A Document Preparation System}. %\newblock 2nd.~ed. %\newblock Reading: Addison-Wesley, 1994. % %\end{thebibliography}\end{verbatim} -% % In this example, |Lamport| is the author's last name (for use in -% citations) and |latex| is the marker used to reference it (see +% citations) and |latexdps| is the marker used to reference it (see % section~\ref{sec:parenthetical}). % % For information on automatically generating the list of works cited with @@ -394,17 +451,18 @@ % |\cite|\oarg{pages}|{|\meta{marker % 1}\texttt{,}\penalty\exhyphenpenalty\meta{marker 2}\ldots|}|; however, page % numbers can currently be specified only for the last referenced source. -% To work around this limitation |\citeN|, explained below, can be used. +% To work around this limitation, use |\citealt|, explained below. % % 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 +% parentheses are omitted by \DescribeMacro{\citealt}|\citealt|. 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})| +% |(\citealt[42]{texbook}|\texttt{; }|\citealt[69]{latexdps})| % would be something like \examp[.]{(Knuth 42; Lamport 69)} % % \subsubsection{Using {\rm \BibTeX}} \label{sec:bibtex} @@ -418,41 +476,47 @@ % and \Lopt{style} modes and a bibliography style of |plain| in % \Lopt{format} and \Lopt{compat} modes. % -% Use of \BibTeX{} is also beyond the scope of this document; instead, -% another example is provided. To use it, substitute +% Use of \BibTeX{} is also beyond the scope of this document; consult +% Patashnik\citeC{btxdoc} for an introduction. +% Briefly, to use the following example, substitute % |\bibliography|\marg{filename} for the |thebibliography| environment. % Then create \meta{filename}\file{.bib} with the contents below. % Generating the document entails running \file{latex} on the \file{.tex} % file, \file{bibtex} on the resulting \file{.aux} file, then \file{latex} % twice more. %\begin{verbatim} -%@BOOK{latex, +%@BOOK{latexdps, % AUTHOR = "Leslie Lamport", -% TITLE = "\LaTeX: A Document Preparation System", -% KEY = "\LaTeX", +% TITLE = "{\LaTeX}: A Document Preparation System", +% KEY = "{\LaTeX}", % EDITION = "Second", % ADDRESS = "Reading", % PUBLISHER = "Addison-Wesley", % YEAR = "1994"}\end{verbatim} +% % In \package{mlastyle}, The |KEY| field serves the additional purpose of % specifying an abbreviated title. This is unnecessary in the above % example. If an additional book by Leslie Lamport was included, however, -% the |KEY| field would allow |\cite{lamport}| to yield \examp{(Lamport, -% \emph{\LaTeX\/})} instead of \examp[.]{(Lamport, \emph{\LaTeX: A Document -% Preparation System\/})} +% the |KEY| field would allow |\cite{latexdps}| to yield \examp{(Lamport, +% \emph{\LaTeX\/})} instead of \examp[.]{(Lamport, \emph{\LaTeX: A +% Doc\-um\-ent Pre\-pa\-ra\-tion Sys\-tem\/})} % -% \StopEventually{\PrintChanges\PrintIndex} +% Note that only entries referenced by a citation are included in the list +% of works cited; to force the inclusion of an entry or all entries, use +% |\nocite|\marg{marker} and |\nocite{*}|, respectively. +% +% \StopEventually{\PrintChanges\bibliography{mlastyle}\PrintIndex} % % \section{Implementation} -% \iffalse +% \begin{macrocode} %<*package> -% \fi -% \subsection{Options} +% \end{macrocode} % +% \subsection{Options} % \begin{macro}{\ifmlastyle@*} % \begin{macro}{\mlastyle@*true} % \begin{macro}{\mlastyle@*false} -% Most options are implemented by modifying a |\newif| declared for this +% Most options are implemented by modifying a |\newif| declared for that % purpose. % \begin{macrocode} \newif\ifmlastyle@bibstyle @@ -482,7 +546,7 @@ \mlastyle@formatfalse \mlastyle@underlinefalse} \DeclareOption{singlespacequotes}{ - \def\mlastyle@qspread{\linespread{1}\normalsize\vskip\baselineskip}} + \def\mlastyle@qspread{\linespread{1}\selectfont\vskip\baselineskip}} \DeclareOption{doublespacequotes}{\let\mlastyle@qspread\relax} \ExecuteOptions{nobibstyle,nopapersize,mla,cm,doublespacequotes} \ProcessOptions @@ -513,12 +577,18 @@ \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 @@ -550,6 +620,11 @@ % \end{macro} % \subsection{Formatting} % Formatting is done if the \Lopt{mla} or \Lopt{format} option is set. +% \begin{macro}{\mlastyle@i} +% \begin{macrocode} + \newdimen\mlastyle@i \mlastyle@i=.5in +% \end{macrocode} +% \end{macro} % \begin{macrocode} \ifmlastyle@format % \end{macrocode} @@ -586,6 +661,7 @@ % \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} @@ -600,14 +676,15 @@ % ^^A\def\verbatim@font{\mlastyle@qspread\mlastyle@vfont} % \end{macro} % \end{macro} +% \end{macro} % \subsubsection{Environments} -% ^^A%\newenvironment{blocks}{\begin{quote} \linespread{1} \small \normalsize}{\end{quote} \linespread{2} \small \normalsize} -% ^^A%\newenvironment{blockm}{\begin{quotation} \linespread{1} \small \normalsize}{\end{quotation} \linespread{2} \small \normalsize} +% ^^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} % \begin{environment}{verse} % Indented 1 inch, with an additional .25 inch hanging indent. % \begin{macrocode} \renewenvironment{verse}{\list{}{\mlastyle@qspread - \advance\leftmargin.75in\itemindent-.25in + \advance\leftmargin1.5\mlastyle@i\itemindent-.5\mlastyle@i \listparindent\itemindent}\item\relax}{\endlist} % \end{macrocode} % \end{environment} @@ -615,7 +692,7 @@ % Indented 1 inch, with a paragraph indent of an additional .25 inches. % \begin{macrocode} \renewenvironment{quotation}{\list{}{\mlastyle@qspread - \advance\leftmargin.5in\itemindent.25in + \advance\leftmargin\mlastyle@i\itemindent.5\mlastyle@i \listparindent\itemindent}\item\relax}{\endlist} % \end{macrocode} % \end{environment} @@ -624,8 +701,8 @@ % indented. % \begin{macrocode} \renewenvironment{quote}{\list{}{\mlastyle@qspread - \advance\leftmargin.5in - \listparindent.25in}\item\relax}{\endlist} + \advance\leftmargin\mlastyle@i + \listparindent.5\mlastyle@i}\item\relax}{\endlist} % \end{macrocode} % \end{environment} % \begin{environment}{workscited} @@ -633,7 +710,7 @@ % \begin{macrocode} \newenvironment{workscited}% {\newpage{\centerline{Works Cited}}}{\newpage} - \newcommand{\bibent}{\noindent \hangindent .5in} + \newcommand{\bibent}{\noindent \hangindent\mlastyle@i} % \end{macrocode} % \end{environment} % \subsubsection{Margins} @@ -642,31 +719,31 @@ % ^^A\addtolength{\headheight}{-1pt} % ^^A\setlength{\headheight}{1.4\headheight}% kludge % \begin{macrocode} - \addtolength{\voffset}{-0.5in} + \addtolength{\voffset}{-.5in} \setlength{\textheight}{\paperheight} \addtolength{\textheight}{-2in} \setlength{\topmargin}{0in} \setlength\headheight\f@baselineskip - \setlength{\headsep}{0.5in} + \setlength{\headsep}{.5in} \addtolength{\headsep}{-\headheight} \setlength{\footskip}{0.25in} \raggedbottom % \end{macrocode} % Left and right margins in MLA format are each 1 inch wide. % \begin{macrocode} - \addtolength{\hoffset}{-0.5in} + \addtolength{\hoffset}{-.5in} \setlength{\textwidth}{\paperwidth} \addtolength{\textwidth}{-2in} - \setlength{\oddsidemargin}{0.5in} - \setlength{\evensidemargin}{0.5in} - \setlength{\marginparwidth}{0.5in} + \setlength{\oddsidemargin}{.5in} + \setlength{\evensidemargin}{.5in} + \setlength{\marginparwidth}{.5in} % \end{macrocode} % \subsubsection{Paragraphs} % Paragraphs should be left justified, with the first line indented .5 % inches. % \begin{macrocode} \raggedright - \setlength{\parindent}{.5in} + \setlength\parindent\mlastyle@i % \end{macrocode} % MLA format specifies that all paragraphs should be indented, even those % beginning a new section. This snippet from \package{indentfirst} changes @@ -716,7 +793,8 @@ % \begin{macrocode} \RequirePackage[ragged,norule]{footmisc} \def\footnotelayout{\linespread{1}\footnotesize\raggedright{} } - \footnotemargin .56in + \footnotemargin\mlastyle@i + \advance\footnotemargin .35em \skip\footins=2\baselineskip \footnotesep 1.2\footnotesep \addtolength\footnotesep{\baselineskip} @@ -737,46 +815,65 @@ % The definition of |\thebibliography| varies depending on the document % class. % \begin{macrocode} +\ifx\@undefined\citet \@ifundefined{chapter} % \end{macrocode} % Article class. % \begin{macrocode} { \def\thebibliography#1{\newpage\section*{\refname} \list{\@biblabel{\@arabic\c@enumiv}}% - {\settowidth\labelwidth{\@biblabel{#1}}} - \leftmargin\labelwidth - \advance\leftmargin\labelsep - \itemindent-\leftmargin - \def\newblock{} - \usecounter{enumiv} - \sloppy%\sfcode`\.=1000\relax - \catcode`/=13\let/=\mlastyle@slash}} + {\settowidth\labelwidth{\@biblabel{#1}}} + \leftmargin\labelwidth + \advance\leftmargin\labelsep + \itemindent-\leftmargin + \def\newblock{} + \usecounter{enumiv} + %\catcode`/=13\global\let/=\mlastyle@slash + \sloppy%\sfcode`\.=\@m + }} % \end{macrocode} % Report/book class. % \begin{macrocode} { \def\thebibliography#1{\chapter*{\bibname} \list{\@biblabel{\@arabic\c@enumiv}}% - {\settowidth\labelwidth{\@biblabel{#1}}} - \leftmargin\labelwidth - \advance\leftmargin\labelsep - \itemindent-\leftmargin - \def\newblock{} - \usecounter{enumiv} - \sloppy%\sfcode`\.=1000\relax - \catcode`/=13\let/=\mlastyle@slash}} + {\settowidth\labelwidth{\@biblabel{#1}}} + \leftmargin\labelwidth + \advance\leftmargin\labelsep + \itemindent-\leftmargin + \def\newblock{} + \usecounter{enumiv} + %\catcode`/=13\let/=\mlastyle@slash + \sloppy%\sfcode`\.=\@m + }} % \end{macrocode} % \end{environment} +% \subsubsection{Experimental \package{natbib} Implementation} +% \begin{macrocode} +\else + \newcommand\bibpreamble{% + \@ifundefined{citet}{}% + {\bibhang\mlastyle@i\bibsep\z@}} +\fi +% \end{macrocode} % \begin{macrocode} \fi % \ifmlastyle@format % \end{macrocode} % \subsection{Style} +% This first block is the beginnings of an implementation for +% \package{natbib}. +% \begin{macrocode} +\newcommand{\bibstyle@mlastyle}{\bibpunct[ ]{(}{)}{;}{a}{,}{;} +\@ifundefined{chapter} +{\gdef\refname{Works Cited}} +{\gdef\bibname{Works Cited}}} +% \end{macrocode} % \begin{macro}{\cite} -% \begin{macro}{\citeN} +% \begin{macro}{\citealt} % ^^A\begin{macro}{\citepage} % ^^A\begin{macro}{\citequote} % The following macros, combined with \file{mlastyle.bst}, provide % for a bibliography in MLA style. Note that the definition of |\cite|, -% |\citeN|, etc.\ vary depending on the options passed to +% |\citealt|, etc.\ vary depending on the options passed to % \package{mlastyle}. % % \begin{macro}{\mlastyle@intcite} @@ -794,16 +891,19 @@ % \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. % \begin{macrocode} \ifmlastyle@style +\ifx\@undefined\citet \def\@cite#1#2{(#1\if@tempswa{} #2\fi)} \def\cite{\def\@cite##1##2{(##1\if@tempswa{} ##2\fi)}\mlastyle@intcite} - \def\citeN{\def\@cite##1##2{##1\if@tempswa{} + \def\citealt{\def\@cite##1##2{##1\if@tempswa{} ##2\fi}\mlastyle@intcite} + \let\citeN\citealt \def\citeM{\def\@cite##1##2{ (##1\if@tempswa{} ##2\fi)}\mlastyle@intcite} \def\citepage{\def\@cite##1##2{\if@tempswa(##2)\fi}\mlastyle@intcite} @@ -816,6 +916,7 @@ \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. @@ -867,6 +968,14 @@ \@ifundefined{chapter} {\renewcommand\refname{Works Cited}} {\renewcommand\bibname{Works Cited}} +\else + \let\cite\citep + \newcommand\citepage[2][]{\citetext{#2}} + \newcommand\citepageM[2][]{ \citetext{#2}} + \newcommand\citeindirect[2][]{\citep[#1][qtd. in]{#2}} + \newcommand\citeindirectM[2][]{ \citep[#1][qtd. in]{#2}} + \let\citeC\mlastyle@relax +\fi % \end{macrocode} % % ^^A% Define the command \workscited{bib}{style}{nocite} @@ -893,7 +1002,7 @@ \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 @@ -905,9 +1014,9 @@ % ^^A\end{macro} % \end{macro} % \end{macro} -% \iffalse +% \begin{macrocode} % -% \fi +% \end{macrocode} % % \Finale \endinput