diff options
author | Karl Berry <karl@freefriends.org> | 2019-05-08 21:15:22 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2019-05-08 21:15:22 +0000 |
commit | 6f272323ab4ef903d4e94df73f8f35be51b1f20d (patch) | |
tree | 344bee012f7f2eb897321d300f0a537299563454 /Master/texmf-dist/doc/latex/mlacls | |
parent | 78b1605f1f5a0899ce94e74a533fe20e7a2ae747 (diff) |
mlacls (8may19)
git-svn-id: svn://tug.org/texlive/trunk@51049 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/mlacls')
-rw-r--r-- | Master/texmf-dist/doc/latex/mlacls/BUGS.md | 3 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/mlacls/CHANGELOG.md | 17 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/mlacls/README.md | 31 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/mlacls/example.tex | 66 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/mlacls/mla-example.bib (renamed from Master/texmf-dist/doc/latex/mlacls/example.bib) | 0 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/mlacls/mla-example.pdf | bin | 0 -> 60124 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/mlacls/mla-example.tex | 86 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/mlacls/mla.pdf | bin | 249997 -> 296896 bytes |
8 files changed, 102 insertions, 101 deletions
diff --git a/Master/texmf-dist/doc/latex/mlacls/BUGS.md b/Master/texmf-dist/doc/latex/mlacls/BUGS.md index bf40b4f9395..5eb659f1aa6 100644 --- a/Master/texmf-dist/doc/latex/mlacls/BUGS.md +++ b/Master/texmf-dist/doc/latex/mlacls/BUGS.md @@ -1,7 +1,8 @@ Bugs ==== -None currently known. +* Specifying both options `mla7` and `mla8` doesn't return an error, + but instead falls back to `mla7`. Reporting --------- diff --git a/Master/texmf-dist/doc/latex/mlacls/CHANGELOG.md b/Master/texmf-dist/doc/latex/mlacls/CHANGELOG.md deleted file mode 100644 index 1d391c57844..00000000000 --- a/Master/texmf-dist/doc/latex/mlacls/CHANGELOG.md +++ /dev/null @@ -1,17 +0,0 @@ -Changelog -========= - -0.2 (02 May 2019) ------------------ - -* Greatly improved documentation (incl. README) -* Added `endnotes` environment -* Corrected several minor spacing issues -* Changed section headers to small-caps -* Added support for PDF metadata -* Changed document date format to day-month-year - -0.1 (26 Apr 2019) ------------------ - -* Initial release diff --git a/Master/texmf-dist/doc/latex/mlacls/README.md b/Master/texmf-dist/doc/latex/mlacls/README.md index 1cc67aefc7f..366d2dca3a6 100644 --- a/Master/texmf-dist/doc/latex/mlacls/README.md +++ b/Master/texmf-dist/doc/latex/mlacls/README.md @@ -6,19 +6,19 @@ LaTeX class for MLA papers. Abstract -------- -Whilst the TeX family of programs is widely used in the sciences -and academia overall, there seems to be a lack of support for -the humanities, which commonly adhere to MLA format for -student papers and reports. - -Though there *are* -[MLA-style packages available](https://ctan.org/pkg/mla-paper), -none met the expectations of the author (who was mostly -just nit-picky about elegance in code). -So *voilĂ *, there now exists a proper `mla.cls`: -a simple, straightforward class for composing papers -almost perfectly adherent to the -[MLA style guide](https://style.mla.org/). +In the United States, secondary and undergraduate students +are generally expected to adhere to the format prescribed by +the Modern Language Association (MLA) for typewritten essays, +research papers and writings. +Sadly, the tool of choice is usually Microsoft Word, +even amongst those fluent with TeX. + +Though there *are* some templates and tools to aid in writing +in the MLA format using LaTeX, none fully met the expectations +of the author. +So *voilĂ *, there now exists an `mla.cls` proper: +a simple, straightforward class for composing papers almost +perfectly adherent to the MLA style guide. Documentation ------------- @@ -34,7 +34,7 @@ $ gv mla.dtx (If you're getting this package from [CTAN](https://ctan.org), a file called `mla.pdf` should already be provided.) -For an example file, refer to `example.tex` and `example.bib`, +For an example file, refer to `mla-example.tex` and `mla-example.bib`, or to the appendix in the documentation. Installation @@ -63,9 +63,6 @@ Submit a merge request on the [GitLab repository](https://gitlab.com/ssterling/mlacls/). I rarely look at the GitHub mirror. -If there's something in [`TODO.md`](./TODO.md), it's likely -a high-priority want, right under bug fixes. - Bugs ---- diff --git a/Master/texmf-dist/doc/latex/mlacls/example.tex b/Master/texmf-dist/doc/latex/mlacls/example.tex deleted file mode 100644 index fd65b2ba31f..00000000000 --- a/Master/texmf-dist/doc/latex/mlacls/example.tex +++ /dev/null @@ -1,66 +0,0 @@ -\documentclass[mla7]{mla} - -\title{Sample MLA Document} -\author{John Doe} -\professor{Dr Suzie Que} -\course{\LaTeX\ 101} -\date{\today} - -% This will be explained later! -\addbibresource{example.bib} - -\begin{document} - -\begin{paper} - -This is an example document using ``mla.cls''. -The header is automatically printed for you when calling the -``paper'' environment, which is why we jumped straight into -writing our body. - -\section{A section} - -Our professor prefers we section our paper since it's -\emph{really} long: -\begin{blockquote} -I really hope you do this right, John. -I got tired of reading that twenty-page paper with no logical breaks! -Just divide it into sections already, even though the MLA style guide -doesn't tell you to. -It's technically not \emph{prohibited}, I guess. \cite{que2019} -\end{blockquote} -That's when the ``\textbackslash{}section'' commands come in handy. -You can even create a subsection!\endnote{It's just like in the -normal ``article'' class.} - -\subsection{Subsection} - -Notice we cited something above in the blockquote. -That's where ``workscited'' comes in handy with perfect MLA format! -(The ``example.bib'' file follows this whole example.) -But, before that\ldots didn't we specify an endnote somewhere? - -\end{paper} - -\begin{notes} - -% It's also important you use the MLA template -% provided with the class, lest it look wrong. - -\printendnotes[mla] - -\end{notes} - -\begin{workscited} - -% It's important to use ``heading=none'' here, since the -% ``workscited'' environment already prints it out for us. - -% Also, notice we had to include the bibliography file -% in the preamble. That's important! - -\printbibliography[heading=none] - -\end{workscited} - -\end{document} diff --git a/Master/texmf-dist/doc/latex/mlacls/example.bib b/Master/texmf-dist/doc/latex/mlacls/mla-example.bib index e53fca0b8c7..e53fca0b8c7 100644 --- a/Master/texmf-dist/doc/latex/mlacls/example.bib +++ b/Master/texmf-dist/doc/latex/mlacls/mla-example.bib diff --git a/Master/texmf-dist/doc/latex/mlacls/mla-example.pdf b/Master/texmf-dist/doc/latex/mlacls/mla-example.pdf Binary files differnew file mode 100644 index 00000000000..690425a18d5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/mlacls/mla-example.pdf diff --git a/Master/texmf-dist/doc/latex/mlacls/mla-example.tex b/Master/texmf-dist/doc/latex/mlacls/mla-example.tex new file mode 100644 index 00000000000..24a032ad332 --- /dev/null +++ b/Master/texmf-dist/doc/latex/mlacls/mla-example.tex @@ -0,0 +1,86 @@ +\documentclass[mla8]{mla} + +\title{Sample MLA Document} +\author{John Doe} +\professor{Dr. Suzie Que} +\course{\LaTeX\ 101} +\date{\today} + +% The .bib file (explained later) must be included in the preamble +\addbibresource{mla-example.bib} + +\begin{document} + +\begin{paper} + +This is an example document using ``mla.cls''. +The header is automatically printed upon using the ``paper'' class, +which is why there is no ``\textbackslash{}maketitle''. + +\section{Professors who prefer sections} + +Sometimes, research papers can become unmanageably lengthy. +In that case, section headings can help divide up the ideas +to make it more accessible to the reader. +Though this paper is short, section headings are employed +as an example of the ``mla'' class' capabilities. + +Some professors may explicitly require or denounce use of headings. +Dr. Suzie Que of Anytown, PA requires they be used for anything +longer than five pages: +\begin{blockquote} +John---so help me God---if you turn in another twenty-page research +paper with no logical breaks I will hang you at the stake. +Even though the MLA style guide doesn't say anything about +section headings, they're not actually prohibited. +So, if you turn in \emph{anything} longer than five pages to me +and there isn't a \emph{single} break or section heading, +I will dock your grade to an F. +Capisce? \cite{que2019} +\end{blockquote} +Despite her language, she does have a point to say. + +\subsection{Subsections} + +Alongside regular top-level sections, one can use +``\textbackslash{}subsection'' commands too\endnote{Section commands +in ``mla.cls'' work identical to those of the ``article'' class.}. + +\section{Using endnotes} + +As one may notice, the above subsection used an endnote. +These can simply be cited with +``Yada yada text\textbackslash{}endnote\{more info\ldots\}.'' +Endnotes can be easily printed in correct format by calling +``\textbackslash{}printendnotes[mla]'' within the +``notes'' environment. + +\section{Using bibliographies} + +Dr. Suzie Que was cited in the above blockquote. +The ins-and-outs of ``biblatex'' will not be explained in this +document, so please refer to online documentation such as the +``BibLaTeX Cheat Sheet''. + +Just as with the endnotes, +the bibliography can be easily printed in correct format by calling +``\textbackslash{}printbibliography[heading=none]'' within the +``workscited'' environment. +(The ``heading=none'' part is important; the ``workscited'' environment +already prints one.) + +\end{paper} + +\begin{notes} + +\printendnotes[mla] + +\end{notes} + +\begin{workscited} + +\printbibliography[heading=none] + +\end{workscited} + +\end{document} diff --git a/Master/texmf-dist/doc/latex/mlacls/mla.pdf b/Master/texmf-dist/doc/latex/mlacls/mla.pdf Binary files differindex 3e1b9ae8ee9..683af471675 100644 --- a/Master/texmf-dist/doc/latex/mlacls/mla.pdf +++ b/Master/texmf-dist/doc/latex/mlacls/mla.pdf |