summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-07-13 22:32:19 +0000
committerKarl Berry <karl@freefriends.org>2016-07-13 22:32:19 +0000
commit181a4a5a58861a070a09b75a414d129a9a005f5f (patch)
tree381ded523f3b15e9cad82737f116fbdae39dd0dc /Master/texmf-dist/doc
parent588acb7430d398501af794108005cd9d326a3769 (diff)
turabian-formatting (13jul16)
git-svn-id: svn://tug.org/texlive/trunk@41685 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/turabian-formatting/README2
-rw-r--r--Master/texmf-dist/doc/latex/turabian-formatting/turabian-formatting-doc.pdfbin99988 -> 108838 bytes
-rw-r--r--Master/texmf-dist/doc/latex/turabian-formatting/turabian-formatting-doc.tex286
3 files changed, 186 insertions, 102 deletions
diff --git a/Master/texmf-dist/doc/latex/turabian-formatting/README b/Master/texmf-dist/doc/latex/turabian-formatting/README
index ee8de424292..5183e86de93 100644
--- a/Master/texmf-dist/doc/latex/turabian-formatting/README
+++ b/Master/texmf-dist/doc/latex/turabian-formatting/README
@@ -1,4 +1,4 @@
-Turabian Formatting for LaTeX (2016/03/18)
+Turabian Formatting for LaTeX (2016/07/12)
INTRODUCTION
diff --git a/Master/texmf-dist/doc/latex/turabian-formatting/turabian-formatting-doc.pdf b/Master/texmf-dist/doc/latex/turabian-formatting/turabian-formatting-doc.pdf
index 76b5012db77..095e75c5d27 100644
--- a/Master/texmf-dist/doc/latex/turabian-formatting/turabian-formatting-doc.pdf
+++ b/Master/texmf-dist/doc/latex/turabian-formatting/turabian-formatting-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/turabian-formatting/turabian-formatting-doc.tex b/Master/texmf-dist/doc/latex/turabian-formatting/turabian-formatting-doc.tex
index 0dd98a1cd8c..439f872b5d5 100644
--- a/Master/texmf-dist/doc/latex/turabian-formatting/turabian-formatting-doc.tex
+++ b/Master/texmf-dist/doc/latex/turabian-formatting/turabian-formatting-doc.tex
@@ -19,7 +19,7 @@
% and turabian-formatting-doc.pdf (in addition to the README file).
%
% ==============================
-% Last updated: 2016/03/18
+% Last updated: 2016/07/12
%
%
@@ -31,7 +31,7 @@
\defaultfontfeatures{Ligatures=TeX}
\usepackage{filecontents}
-\begin{filecontents}{references.bib}
+\begin{filecontents}{\jobname.bib}
@book{turabian_manual_2013,
author = {Turabian, Kate L.},
edition = {8th edition},
@@ -42,7 +42,7 @@
\end{filecontents}
\usepackage[authordate,backend=biber]{biblatex-chicago}
-\addbibresource{references.bib}
+\addbibresource{\jobname.bib}
\usepackage{units, metalogo, setspace}
@@ -64,6 +64,8 @@
\usepackage{ellipsis}
+\usepackage{shortvrb}
+
\usepackage{listings}
\lstset{%
language=TeX,
@@ -75,7 +77,12 @@
numbers=none,
breaklines=true,
breakatwhitespace=true,
- breakindent=0pt}
+ breakindent=0pt,
+ escapeinside={(*}{*)}}
+
+\newcommand{\codecomment}[1]{\textrm{$\langle$\emph{#1}$\rangle$}}
+
+\newcommand{\textcmd}[1]{\texttt{\textbackslash #1}}
\title{Turabian Formatting for \LaTeX{}}
@@ -111,6 +118,7 @@
\section*{Introduction}
\label{sec:introduction}
+
This package provides Chicago-style formatting based on Kate L. Turabian's \emph{A Manual for Writers of Research Papers, Theses, and Dissertations: Chicago Style for Students and Researchers}, 8th edition. In doing so, this package adheres closely to the formatting guidelines described in Turabian's work while, also, being readily adaptable to additional formatting requirements (e.g. formatting requirements specific to an institution and/or department).
It is hoped that authors will find this package relatively easy to implement. There are few (if any) new commands to learn, as the package builds upon (and makes adjustments to) already-existing \LaTeX{} commands. As such, formatting research papers, theses, and dissertations should require a minimum amount of changes to a standard \LaTeX{} source file (your \texttt{.tex} file).
@@ -118,91 +126,85 @@ It is hoped that authors will find this package relatively easy to implement. Th
For citations, this package is designed to work well with David Fussner's outstanding (and highly-recommended) \texttt{biblatex-chicago}.
-
-\section{Using the Document Classes and Package}
+\clearpage
+\section{Getting Started: Document Classes}
\label{sec:implementation}
-A document may be formatted using \texttt{turabian-formatting} in one of three ways: either (1) specifying the document class as a turabian-formatted research paper (\texttt{turabian-researchpaper}), (2) specifying the document class as a thesis/dissertation with turabian-style formatting (\texttt{turabian-thesis}), or (3) loading the package in the \LaTeX{} source-file preamble.
+A document may be formatted using \texttt{turabian-formatting} in one of two ways: either (1) specifying the document class as a turabian-formatted research paper (\texttt{turabian-researchpaper}), or (2) specifying the document class as a thesis/dissertation with turabian-style formatting (\texttt{turabian-thesis}).\footnote{%
+ The \texttt{turabian-formatting} package can be used with different document classes by loading it through the \textcmd{usepackage} command. This method is not recommended and has only been tested with the standard \texttt{article}, \texttt{report}, and \texttt{book} \LaTeX{} document classes. If the document class is either \texttt{turabian-researchpaper} or \texttt{turabian-thesis}, do not load the \texttt{turabian-formatting} package again. Loading \texttt{turabian-formatting} as a package should always be done \emph{before} using the \texttt{biblatex-chicago} package.}
-\subsection{Document Class for Research Papers}
+\subsection{Research Papers}
\marginnote{turabian-\newline researchpaper}%
-The \texttt{turabian-researchpaper} document class provides formatting specific to research papers. The requisite code:
+The \texttt{turabian-researchpaper} document class provides formatting specific to research papers and is based upon the \texttt{article} document class.
+
+When placed in the source document preamble (your \texttt{.tex} file), the following specifies the document class as \texttt{turabian-researchpaper}:
\begin{lstlisting}
\documentclass{turabian-researchpaper}
\end{lstlisting}
-This document class builds on the \texttt{turabian-formatting} package and is based on the \texttt{article} document class.
-
-\clearpage
-\subsection{Document Class for Theses and Dissertations}
+\subsection{Theses/Dissertations}
\marginnote{turabian-thesis}%
-The \texttt{turabian-thesis} document class offers formatting specific to theses and dissertations. The requisite code:
-\begin{lstlisting}
- \documentclass{turabian-thesis}
-\end{lstlisting}
-
-This document class builds on the \texttt{turabian-formatting} package and is based on the \texttt{book} document class. As such, support for chapter headings (\texttt{\textbackslash chapter} and \texttt{\textbackslash chapter*}), title pages specific to theses/dissertations (refer to subsection~\ref{subsec:titlepage}), table of contents, and formatting commands to structure the document into front matter, main matter, and back matter (refer to subsection~\ref{subsec:td_structure}), are also included.
-
-
-\subsection{Package for Turabian-Style Formatting}
+The \texttt{turabian-thesis} document class offers formatting specific to theses and dissertations. It is based upon the \texttt{book} document class.
-\marginnote{turabian-\newline formatting}%
-The \texttt{turabian-formatting} package can be loaded in the preamble of the source file as follows:\footnote{%
- The \texttt{turabian-formatting} package has been tested with the standard \texttt{article}, \texttt{report}, and \texttt{book} \LaTeX{} document classes. If the document class is either \texttt{turabian-researchpaper} or \texttt{turabian-thesis}, however, do not load the \texttt{turabian-formatting} package again.}
+This document class provides additional support for chapter headings as well as formatting commands to structure the document into front matter, main matter, and back matter (refer to subsections~\ref{subsec:chapters} and~\ref{subsec:td_structure}).
+When placed in the source document preamble, the following specifies the document class as \texttt{turabian-thesis}:
\begin{lstlisting}
- \usepackage{turabian-formatting}
+ \documentclass{turabian-thesis}
\end{lstlisting}
-This package should always be loaded \emph{before} using the \texttt{biblatex-chicago} package.
-
+\clearpage
\section{Formatting Options}
\label{sec:formatting_options}
+
The \texttt{turabian-formatting} package adheres to the manual's guidelines on the formatting of text. This includes double-spacing all text throughout the document except items that should have single-spacing \autocite[373]{turabian_manual_2013}.\footnote{%
- Double-spaced text is typeset with a \texttt{\textbackslash baselinestretch} of \texttt{2}. This is different than the default values provided by the \texttt{setspace} package.}
+ Double-spaced text is typeset with a \textcmd{baselinestretch} of \texttt{2} using the \texttt{setspace} package.}
Paragraph indentation is set to 0.5 inches.
Page margins, by default, are 1 inch from the edges of the paper.
The \texttt{turabian-thesis} document class has an additional binding offset of 0.5 inches, effectively creating a left/inside margin of 1\nicefrac{1}{2} inches.\footnote{%
- This is accomplished by \texttt{turabian-thesis} making changes to the following lengths: (1) setting \texttt{\textbackslash oddsidemargin} to \texttt{0.5in}; (2) setting \texttt{\textbackslash evensidemargin} to \texttt{0}; and (3) adding \texttt{-0.5in} to \texttt{\textbackslash textwidth}.}
+ This is accomplished by \texttt{turabian-thesis} making changes to the following lengths: (1) setting \textcmd{oddsidemargin} to \texttt{0.5in}; (2) setting \textcmd{evensidemargin} to \texttt{0}; and (3) adding \texttt{-0.5in} to \textcmd{textwidth}.}
\subsection{Standard Options for Document Classes}
+
Both \texttt{turabian-thesis} and \texttt{turabian-researchpaper} document classes support most of the standard document class options.
-The default \texttt{normal} font size is twelve-point type (\texttt{12pt})---the preferred font type size for the body of the text \autocite[373]{turabian_manual_2013}. This package also supports \texttt{normal} font type sizes of \texttt{10pt} and \texttt{11pt}.
+The default \texttt{normal} font size is twelve-point type (\texttt{12pt})---the preferred font type size for the body of the text \autocite[373]{turabian_manual_2013}. This package also supports \texttt{normal} font sizes of \texttt{10pt} and \texttt{11pt}.
-The default page size, for both document classes, is 8\nicefrac{1}{2} × 11 inches (US Letter size). And as with other standard \LaTeX{} document classes, different paper sizes and can be specified as class options, including \texttt{letterpaper} (the default), \texttt{a4paper}, and \texttt{legalpaper}.
+The default page size, for both document classes, is 8\nicefrac{1}{2} × 11 inches (US Letter size, specified as \texttt{letterpaper}). Other paper size options can be specified instead, including \texttt{a4paper} and \texttt{legalpaper}.
The \texttt{twocolumn} option, however, is not supported. More so, the \texttt{turabian-thesis} document class does not support the \texttt{notitlepage} option either.
-Both documents classes, by default, are set to \texttt{oneside}.
-
+Both documents classes, by default, are set to \texttt{oneside}. The \texttt{twoside} option is also supported.
+\clearpage
\subsection{Ragged Right (Left Align) Text}
+\label{subsec:raggedright}
\marginnote{raggedright}%
-By default, text consisting of more than one line is justified on both sides of the document with the last line flush left. Turabian, however, recommends setting ``your word processor to align text flush left with a ragged right margin" while also not using its ``automated hyphenation feature" \autocite[404]{turabian_manual_2013}. For ragged right formatting without hyphenations throughout the work, use the \texttt{raggedright} formatting option.
+By default, text consisting of more than one line is justified on both sides of the document with the last line flush left. Turabian, however, recommends setting ``your word processor to align text flush left with a ragged right margin" while also not using its ``automated hyphenation feature" \autocite[404]{turabian_manual_2013}. For ragged right formatting without hyphenations throughout the work, use the \texttt{raggedright} formatting option.\footnote{%
+ Alternatively, placing the \textcmd{raggedright} command in the document preamble will have the same effect as using the \texttt{raggedright} option. The \textcmd{raggedright} command, however, does not pass a \texttt{raggedright} option to other loaded packages.}
\subsection{Notes-Bibliography and Author-Date Styles}
This package is designed to work well with the \texttt{biblatex-chicago} package. This includes support for both notes-bibliography and author-date citation styles (the former being the default style).
-If the \texttt{biblatex-chicago} package is loaded by the user, the following options are passed to \texttt{biblatex-chicago}: \texttt{isbn=false}, \texttt{autolang=other}, \texttt{footmarkoff}, and \texttt{backend=biber}. The \texttt{\textbackslash printbibliography} command will provide a bibliography with \emph{Bibliography} as the default heading, irrespective of the document class.
+If the \texttt{biblatex-chicago} package is loaded by the user, the following options are passed to \texttt{biblatex-chicago}: \texttt{isbn=false}, \texttt{autolang=other}, \texttt{footmarkoff}, and \texttt{backend=biber}. The \textcmd{printbibliography} command will provide a bibliography with \emph{Bibliography} as the default heading, irrespective of the document class.
\marginnote{authordate}%
-Support for the author-date style is enabled by specifying the \texttt{authordate} formatting option. This option passes an \texttt{authordate} option to \texttt{biblatex-chicago} as well as redefines the default heading for the references list (also typeset using the \texttt{\textbackslash printbibliography} command) to that of \emph{References}.
+Support for the author-date style is enabled by specifying the \texttt{authordate} formatting option. This option passes an \texttt{authordate} option to \texttt{biblatex-chicago} as well as redefines the default heading for the references list (also typeset using the \textcmd{printbibliography} command) to that of \emph{References}.
\marginnote{noadjustbib}%
-Adjustments made to \texttt{\textbackslash printbibliography} can be disabled using the \texttt{noadjustbib} formatting option. The following code, loaded at the end of the preamble, is affected by this option:
+Adjustments made by \texttt{turabian-formatting} to the \textcmd{printbibliography} command can be disabled using the \texttt{noadjustbib} formatting option. The following code, loaded at the end of the preamble, is affected by this option:
\begin{lstlisting}
\if@authordateformat
\DefineBibliographyStrings{english}{%
@@ -219,53 +221,59 @@ Adjustments made to \texttt{\textbackslash printbibliography} can be disabled us
\subsection{Endnotes}
-Although footnotes are used by default, endnotes can also be enabled. This is accomplished through the use of the \texttt{endnotes} package.
-
\marginnote{endnotes}%
-Endnotes can be used by specifying the \texttt{endnotes} formatting option. Through this option, the \texttt{endnotes} package is loaded. More so, the \texttt{endnotes} option causes footnotes to be restarted on each page and labelled using symbols in the sequence of: * $\dagger$ $\ddagger$ $\S$ \autocite[156]{turabian_manual_2013}. The \texttt{notetype=endonly} option is also passed to the \texttt{biblatex-chicago} package.
+Although footnotes are used by default, endnotes can be used by specifying the \texttt{endnotes} formatting option. Through this option, the \texttt{endnotes} package is loaded.
+
+With the \texttt{endnotes} option, footnotes are restarted on each page and labelled using symbols in the sequence of: * $\dagger$ $\ddagger$ $\S$ \autocite[156]{turabian_manual_2013}. The \texttt{notetype=endonly} option is also passed to the \texttt{biblatex-chicago} package.
-To produce a list of endnotes, use the \texttt{\textbackslash theendnotes} command provided by the \texttt{endnotes} package. Through the \texttt{endnotes} option, each endnote is single-spaced with a ``blank line between notes." The default heading for this list of endnotes is typeset as \emph{Notes}.\footnote{%
- The \emph{Notes} heading is typeset using either \texttt{\textbackslash section*} or, if \texttt{\textbackslash chapter} has been defined by the document class, \texttt{\textbackslash chapter*}. If there are no endnotes preceding \texttt{\textbackslash theendnotes}, this command will generate a \emph{Notes} heading with an empty endnotes list.}
-If the document class supports chapters, the numbering of endnotes is also restarted for each chapter. The endnotes list will then have subheadings that divide endnotes by each chapter \autocite[157]{turabian_manual_2013}.
+To produce a list of endnotes, use the \textcmd{theendnotes} command provided by the \texttt{endnotes} package. Through the \texttt{endnotes} option, each endnote is single-spaced with a ``blank line between notes." The default heading for this list of endnotes is typeset as \emph{Notes}.\footnote{%
+ The \emph{Notes} heading is typeset using either \textcmd{section*} or, if \textcmd{chapter} has been defined by the document class (i.e. \texttt{turabian-thesis}), \textcmd{chapter*}. If there are no endnotes preceding \textcmd{theendnotes}, this command will generate a \emph{Notes} heading with an empty endnotes list.}
+When used with \texttt{turabian-thesis}, the numbering of endnotes is restarted at the beginning of each chapter. In this case, the endnotes list then uses subheadings that divide endnotes by each chapter \autocite[157]{turabian_manual_2013}.
+
+\clearpage
\section{Formatting Commands}
\label{sec:formatting_commands}
-\subsection{Headings: Chapters, Sections, and Subsections}
+\subsection{Chapters}
+\label{subsec:chapters}
+
+\marginnote{\textbackslash chapter\{\}}
+A thesis or dissertation can be divided into chapters using the \textcmd{chapter} command.
+
+The \textcmd{chapter} command starts a new page with a ``descriptive title" of the chapter separated from the first line of following text by ``two blank lines." If located in the main matter (refer to subsection~\ref{subsec:td_structure}), the ``descriptive title" will be preceded by a \emph{Chapter} label ``followed by the chapter number at the top of the page" in arabic numerals; separated by a blank line \autocite[391]{turabian_manual_2013}.
-The \texttt{turabian-formatting} package provides support for document classes that allow text to be divided into sections and subsections. This package also provides support for document classes that define \texttt{\textbackslash chapter} and \texttt{\textbackslash chapter*}, including the \texttt{report}, \texttt{book}, and \texttt{turabian-thesis} document classes.
+If the \textcmd{chapter} command is placed inside the \texttt{appendixes} environment, chapter numbering is restarted and an \emph{Appendix} label followed by single capitalized letters of the alphabet is used instead (refer to subsection~\ref{subsec:appendixes}).
-\subsubsection*{Chapters}
+\marginnote{\textbackslash chapter*\{\}}
+\textcmd{chapter*}, unlike \textcmd{chapter}, does not provide a line with a \emph{Chapter} label and numbering nor is it included in the table of contents.\footnote{%
+ To add a numberless ``chapter" to the table of contents, use the \textcmd{addcontentsline} command immediately following the \textcmd{chapter*} command. For the \emph{Bibliography} or \emph{References} heading from \textcmd{printbibliography} (from the \texttt{biblatex-chicago} package), place this command immediately \emph{after} the use of the \textcmd{clearpage} and \textcmd{addcontentsline} commands.}
-\marginnote{\textbackslash chapter}
-The \texttt{\textbackslash chapter} command starts a new page and creates a \emph{Chapter} label ``followed by the chapter number at the top of the page" in arabic numerals. The ``descriptive title" of the chapter is placed ``two lines down, following a blank line" and is separated from the first line of following text by ``two blank lines" \autocite[391]{turabian_manual_2013}.
-\marginnote{\textbackslash chapter*}
-\texttt{\textbackslash chapter*}, unlike \texttt{\textbackslash chapter}, does not provide a line with a \emph{Chapter} label and numbering nor is it included in the Table of Contents.\footnote{%
- To add a numberless ``chapter" to the Table of Contents, use the \texttt{\textbackslash addcontentsline} command immediately following the \texttt{\textbackslash chapter*} command. For the \emph{Bibliography} or \emph{References} heading from \texttt{\textbackslash printbibliography} (from the \texttt{biblatex-chicago} package), place this command immediately \emph{after} the use of the \texttt{\textbackslash clearpage} and \texttt{\textbackslash addcontentsline} commands. Using the \texttt{endnotes} option will place the \emph{Notes} heading in the table of contents.}
-This is useful for the titles/headings of specific elements, including \emph{Introduction} \autocite[390]{turabian_manual_2013}, \emph{Abstract} \autocite[389]{turabian_manual_2013}, \emph{Conclusion} \autocite[398]{turabian_manual_2013}, \emph{Appendixes} \autocite[398]{turabian_manual_2013}, \emph{Notes} \autocite[399]{turabian_manual_2013}, and \emph{Bibliography} \autocite[401]{turabian_manual_2013}.
+\subsection{Sections and Subsections}
-\subsubsection*{Sections and Subsections}
+\marginnote{\textbackslash section\{\}\newline \textbackslash subsection\{\}\newline \textbackslash subsubsection\{\}}
+This package provides support for three levels of sections and subsections: \textcmd{section}, \textcmd{subsection}, and \textcmd{subsubsection} (including their asterisked versions). These section and subsection commands do not provide any label or numbering.
-\marginnote{\textbackslash section\newline \textbackslash subsection\newline \textbackslash subsubsection}
-This package provides support for three levels of sections and subsections: \texttt{\textbackslash section}, \texttt{\textbackslash subsection}, and \texttt{\textbackslash subsubsection} (including their asterisked versions). These section and subsection commands do not provide any label or numbering.
+\textcmd{section} places ``more space before a subhead than after (up to two blank lines before and one line, or double line spacing, after)" \autocite[393]{turabian_manual_2013}.
-\texttt{\textbackslash section} places ``more space before a subhead than after (up to two blank lines before and one line, or double line spacing, after)" \autocite[393]{turabian_manual_2013}.
+If the \textcmd{section} command is placed inside the \texttt{appendixes} environment, section numbering is restarted and an \emph{Appendix} label followed by single capitalized letters of the alphabet is used instead (refer to subsection~\ref{subsec:appendixes}).
-\marginnote{\textbackslash section*\newline \textbackslash noadjustssect}
-If the document class does not define chapter headings, \texttt{\textbackslash section*} will instead provide two blank lines between the title/subheading and the first line of text. This is particularly useful for the subheadings of specific elements, including \emph{Introduction} \autocite[390]{turabian_manual_2013}, \emph{Notes} \autocite[399]{turabian_manual_2013}, and \emph{Bibliography} \autocite[401]{turabian_manual_2013}. Inserting the \texttt{\textbackslash noadjustssect} command in the document preamble will disable this behaviour.
+\marginnote{\textbackslash section*\{\}\newline \textbackslash noadjustssect}
+When used with \texttt{turabian-researchpaper}, the \textcmd{section*} command places two blank lines between the title/subheading and the first line of text. This is particularly useful for the subheadings of specific elements, including \emph{Introduction}, \emph{Notes}, and \emph{Bibliography} \autocite[390--401]{turabian_manual_2013}. Inserting the \textcmd{noadjustssect} command in the document preamble will disable this behaviour.
\subsection{Page Styles: Headers and Footers}
-\label{sec:page_styles}
+\label{subsec:page_styles}
-Headers and footers, by default, are placed within the margins. The top of the header is 0.5 inches from the top edge of the page. The baseline of the footer is 0.5 inches from the bottom edge of the page \autocite[372, 374]{turabian_manual_2013}.
+Headers and footers are placed within the margins. The top of the header is 0.5 inches from the top edge of the page. The baseline of the footer is 0.5 inches from the bottom edge of the page \autocite[372, 374]{turabian_manual_2013}.
-\marginnote{\textbackslash pagestyle\newline \textbackslash thispagestyle}
-The layout of the headers and footers are determined by the specific page styles. They are used with the \texttt{\textbackslash pagestyle} and \texttt{\textbackslash thispagestyle} commands.\footnote{%
+\marginnote{\textbackslash pagestyle\{\}\newline \textbackslash thispagestyle\{\}}
+The layout of the headers and footers are determined by the page styles specified using the \textcmd{pagestyle} and \textcmd{thispagestyle} commands.\footnote{%
The \texttt{fancyhdr} package can be used to typset (and adjust) these page styles. This includes placing optional text (such as a page identifier) in the header and/or footer \autocite[374]{turabian_manual_2013}.}
+This package provides the following page styles:
\textbf{\texttt{empty}}: An empty page style with no header or footer.
@@ -274,67 +282,148 @@ The layout of the headers and footers are determined by the specific page styles
\textbf{\texttt{headings}}: The default page style places a page number in the right-hand corner of the header.
-\subsection{Document Structure for Thesis/Dissertation}
+\subsection{Front Matter, Main Matter, and Back Matter}
\label{subsec:td_structure}
-A thesis/dissertation is divided into three, distinct components: (1) front matter, (2) main matter or text of the paper, and (3) back matter \autocite[375]{turabian_manual_2013}. As such, this package provides support for document classes that use the \texttt{\textbackslash frontmatter}, \texttt{\textbackslash mainmatter}, and \texttt{\textbackslash backmatter} commands (such as the \texttt{book} and \texttt{turabian-thesis} document classes).
+
+A thesis/dissertation can be divided into three, distinct components: (1) front matter, (2) main matter or text of the paper, and (3) back matter \autocite[375]{turabian_manual_2013}. As such, the \textcmd{frontmatter}, \textcmd{mainmatter}, and \textcmd{backmatter} commands are supported by the \texttt{turabian-thesis} document class.
\subsubsection*{Front Matter}
\marginnote{\textbackslash frontmatter}
-The front matter is declared with the \texttt{\textbackslash frontmatter} command. By default, the \texttt{\textbackslash pagestyle} is set to \texttt{empty} (refer to section~\ref{sec:page_styles}). The numbering of pages in the front matter begins with the title page, although page numbers are not placed on pages until the Table of Contents \autocite[373--374, 376, 380]{turabian_manual_2013}.
+The front matter begins with the \textcmd{frontmatter} command. Page numbering starts with the title page. Page numbers do not appear in the headers or footers of pages in the front matter, as the \textcmd{frontmatter} command sets \textcmd{pagestyle} to \texttt{empty} \autocite[373--374, 376]{turabian_manual_2013}.
-\clearpage
-\marginnote{\texttt{\textbackslash tableofcontents}}
-Placing the \texttt{\textbackslash tableofcontents} command in the front matter will cause page numbers to appear on pages with the Table of Contents and subsequent pages of the front matter. These page numbers use roman numerals and are placed in centre of the footer \autocite[373--374]{turabian_manual_2013} using the \texttt{plain} page style (refer to section~\ref{sec:page_styles}).
+Page numbers, however, do appear on pages that follow the \textcmd{tableofcontents} command when typesetting the table of contents (refer to subsection~\ref{subsec:toc}).
+\clearpage
\subsubsection*{Main Matter}
\marginnote{\textbackslash mainmatter}
-The main matter (or text of the paper) begins with the \texttt{\textbackslash mainmatter} command. Page numbering restarts with arabic numerals, starting with page 1. Page numbers are placed on the right-side of the header, using the \texttt{headings} page style (with the exception of the first page of each chapter, which instead use the \texttt{plain} page style) \autocite[373--374]{turabian_manual_2013}.
+The main matter (or text of the paper) begins with the \textcmd{mainmatter} command. Page numbering restarts with arabic numerals, starting with page 1. Page numbers are placed on the right-side of the header, using the \texttt{headings} page style (with the exception of the first page of each chapter which, instead, use the \texttt{plain} page style) \autocite[373--374]{turabian_manual_2013}.
\subsubsection*{Back Matter}
\marginnote{\textbackslash backmatter}
-The back matter is declared using the \texttt{\textbackslash backmatter} command. Page numbering and page styles are continued from the main matter \autocite[373--374]{turabian_manual_2013}.
+The back matter is declared using the \textcmd{backmatter} command. Page numbering and page styles are continued from the main matter \autocite[373--374]{turabian_manual_2013}.
\subsection{Title Page}
\label{subsec:titlepage}
-The \texttt{turabian-researchpaper} document class provides a title page intended for research papers.\footnote{%
- The \texttt{turabian-formatting} package provides a title page for research papers.}
-Page numbering begins immediately following the title page. The \texttt{turabian-thesis} document class, however, provides a ``model" title page intended for a thesis or dissertation. The title page of a thesis/dissertation is included in the page numbering of the front matter \autocite[376, 378]{turabian_manual_2013}.
+The \texttt{turabian-researchpaper} document class provides a title page intended for research papers. Page numbering begins immediately following the title page. The \texttt{turabian-thesis} document class, however, provides a ``model" title page intended for a thesis or dissertation. The title page of a thesis/dissertation is included in the page numbering of the front matter \autocite[376, 378]{turabian_manual_2013}.
\marginnote{\textbackslash maketitle}%
-The \texttt{\textbackslash maketitle} command will create a separate title page if the document class specifies (or has as default) the \texttt{titlepage} option---the default option for both \texttt{turabian-researchpaper} and \texttt{turabian-thesis}.
+The \textcmd{maketitle} command will create a separate title page if the document class specifies (or has as default) the \texttt{titlepage} option---the default option for both \texttt{turabian-researchpaper} and \texttt{turabian-thesis}.
-\marginnote{\textbackslash title\newline \textbackslash subtitle\newline \textbackslash author\newline \textbackslash date\newline}
-\texttt{\textbackslash maketitle} uses information specified in the source document preamble, through the following commands (each of which is self-evident): \texttt{\textbackslash title}, \texttt{\textbackslash author}, \texttt{\textbackslash date}, and \texttt{\textbackslash subtitle}. For research paper title pages, footnotes (as well as \texttt{\textbackslash thanks}) can also be used.
+\marginnote{\textbackslash title\{\}\newline \textbackslash subtitle\{\}\newline \textbackslash author\{\}\newline \textbackslash date\{\}\newline}
+\textcmd{maketitle} uses information specified in the source document preamble, through the following commands (each of which is self-evident): \textcmd{title}, \textcmd{author}, \textcmd{date}, and \textcmd{subtitle}. For research paper title pages, footnotes (as well as the \textcmd{thanks} command) can also be used.
-\marginnote{\textbackslash submissioninfo}
-For a research paper, \texttt{\textbackslash submissioninfo} is used for typesetting ``any information requested by your instructor," between the name of the course and the date \autocite[376]{turabian_manual_2013}. For a thesis or dissertation title page, however, this command is used to typeset requested information between the title/subtitle and the name of the department.
+\marginnote{\textbackslash submissioninfo\{\}}
+For a research paper, \textcmd{submissioninfo} is used for typesetting ``any information requested by your instructor," between the name of the course and the date \autocite[376]{turabian_manual_2013}. For a thesis or dissertation title page, however, this command is used to typeset requested information between the title/subtitle and the name of the department.
-\marginnote{\textbackslash course}
-\texttt{turabian-researchpaper} provides the optional \texttt{\textbackslash course} command for typesetting course information (such as the name of the course).
+\marginnote{\textbackslash course\{\}}
+\texttt{turabian-researchpaper} provides the optional \textcmd{course} command for typesetting course information (such as the name of the course).
-\marginnote{\textbackslash institution\newline \textbackslash department\newline \textbackslash location}
-\texttt{turabian-thesis} also provides: (1) \texttt{\textbackslash institution} for typesetting the institution at the top of the page, (2) for typesetting the name of the department, and (3) \texttt{\textbackslash location} for typesetting a location just above the date.
+\marginnote{\textbackslash institution\{\}\newline \textbackslash department\{\}\newline \textbackslash location\{\}}
+\texttt{turabian-thesis} also provides: (1) \textcmd{institution} for typesetting the institution at the top of the page, (2) for typesetting the name of the department, and (3) \textcmd{location} for typesetting a location just above the date.
To create a custom title page, use the \texttt{titlepage} environment.
+\subsection{Table of Contents}
+\label{subsec:toc}
+
+\marginnote{\textcmd{tableofcontents}}
+The \textcmd{tableofcontents} command creates a table of contents with the first page labelled \emph{Contents}. Items within the table of contents are single-spaced with ``a blank line after each item." The front matter and back matter are each separated from the main matter by two blank lines. By default, subheadings are not included in the table of contents \autocite[380]{turabian_manual_2013}.\footnote{%
+ To add subheadings to the table of contents, increase the \texttt{tocdepth} counter.}
+
+Placing the \textcmd{tableofcontents} command in the front matter of a thesis/dissertation will cause page numbers to appear on pages within the table of contents and subsequent pages of the front matter. These page numbers use roman numerals and are placed in the centre of the footer using the \texttt{plain} page style \autocite[373--374; refer to subsection~\ref{subsec:page_styles}]{turabian_manual_2013}.
+
+
+\subsection{List of Figures, Tables, or Illustrations}
+\label{subsec:toft}
+
+The \texttt{turabian-formatting} package provides support for the \texttt{figure} and \texttt{table} environments. Figures are numbered separately from tables and, both, in the order in which they are mentioned in the text \autocite[363, 369]{turabian_manual_2013}.
+
+With \texttt{turabian-researchpaper}, both figures and tables are numbered consecutively, throughout the paper (e.g. ``Figure 6"). The \texttt{turabian-thesis} document class, however, uses double numeration for both figures and tables: the chapter number followed by a period and a figure/table number that restarts with each chapter (e.g. ``Figure 3.2").\footnote{%
+ Within the \texttt{appendixes} environment, figures and tables are both numbered with an ``A" prefix followed by a period and a figure/table number that does \emph{not} restart with each appendix (e.g. ``Table A.4").}
+
+\marginnote{\textbackslash listoffigures\newline \textbackslash listoftables}
+Support is provided for both the \textcmd{listoffigures} and \textcmd{listoftables} commands. The list of figures is labelled \emph{Figures}; the list of tables is labelled \emph{Tables}. Individual items listed are single-spaced with a blank line between each item \autocite[383]{turabian_manual_2013}.
+
+\marginnote{\textcmd{listofillustrations}}
+The \textcmd{listofillustrations} command creates a combined list of figures and tables with the first page labelled \emph{Illustrations}. This list, however, is divided into two sections labelled \emph{Figures} and \emph{Tables}. Individual items listed within each section are single-spaced with a blank line between each item \autocite[383]{turabian_manual_2013}.
+
+
+\clearpage
+\section{Formatting Environments}
+\label{sec:formatting_environments}
+
+
+\subsection{Block Quotations}
+\marginnote{quotation}
+Block quotations are typeset using the \texttt{quotation} environment. Each block quotation is single-spaced and leaves a blank line both before and after it. The entire quotation is indented as far as the indentation of the first line of a paragraph \autocite[349]{turabian_manual_2013}.
+
+\begin{lstlisting}
+ \begin{quotation}
+ (*\codecomment{Text being quoted.}*)
+ \end{quotation}
+\end{lstlisting}
+
+By default, the block quotation is also indented by the same amount (\texttt{0.5in}) on the right side. When using the \texttt{raggedright} option (or the \textcmd{raggedright} command), however, the block quotation is not indented on the right side (refer to subsection~\ref{subsec:raggedright}).
+
+
+\subsection{Appendixes}
+\label{subsec:appendixes}
+
+When ``supporting material cannot be easily worked into the body of your paper," the manual recommends putting the material ``in one or more appendixes in the back matter" \autocite[398]{turabian_manual_2013}.
+
+If only one appendix is needed, the first page is to be labelled \emph{Appendix} with ``two blank lines between the title and the first line of text or other material" \autocite[398]{turabian_manual_2013}. This can be accomplished with a regular chapter or section heading (i.e. \textcmd{chapter\{Appendix\}} or \textcmd{section*\{Appendix\}}).
+
+\marginnote{appendixes}
+For more than one appendix, place the material inside the \texttt{appendixes} environment. As an example:
+
+\begin{lstlisting}
+ \begin{appendixes}
+ (*\codecomment{Material belonging to the appendixes.}*)
+ \end{appendixes}
+\end{lstlisting}
+
+The headings of each appendix use an \emph{Appendix} prefix accompanied by a single, capitalized letter from the alphabet (in sequential order, starting with A). The descriptive title is placed on the next line \autocite[399]{turabian_manual_2013}. For \texttt{turabian-thesis}, each chapter (using the \textcmd{chapter} command) within the \texttt{appendixes} environment functions as a separate appendix. Similarly, with \texttt{turabian-researchpaper}, the \textcmd{section} command is used to denote a new appendix.
+
+
+\clearpage
\section{Required and Recommended Packages}
\label{sec:required_packages}
-This package requires \LaTeX{}2e and makes use of the following packages installed as part of a standard \LaTeX{} distribution: \texttt{etoolbox}, \texttt{setspace}, \texttt{nowidow}, \texttt{footmisc}, \texttt{endnotes}, \texttt{xparse}, and \texttt{geometry}.\footnote{%
- The \texttt{geometry} package is only required if using the deprecated \texttt{emptymargins} option.}
-The following packages are highly recommended: \texttt{biblatex-chicago}, \texttt{csquotes}, \texttt{fancyhdr}, \texttt{ellipsis}, and \texttt{threeparttable}.
+This package requires \LaTeX{}2e and makes use of the following packages installed as part of a standard \LaTeX{} distribution: \texttt{etoolbox}, \texttt{setspace}, \texttt{nowidow}, \texttt{footmisc}, \texttt{endnotes}, and \texttt{xparse}.
+The following packages are highly recommended: \texttt{biblatex-chicago}, \texttt{csquotes}, \texttt{fancyhdr}, \texttt{tocloft}, \texttt{ellipsis}, and \texttt{threeparttable}.
+
+\clearpage
\section{Updates}
\label{sec:updates}
+
+\marginnote{\rmfamily{2016/07/12}}%
+
+Re-implementation of the \textcmd{raggedright} command as an alternative to using the \texttt{raggedright} option.
+
+Improvements to the \textcmd{tableofcontents}, \textcmd{listoffigures}, and \textcmd{listoftables} commands with support for the \texttt{tocloft} package.
+
+Added the \textcmd{listofillustrations} command.
+
+Added an \texttt{appendixes} environment to support formatting of appendixes.
+
+Formatting improvements when \textcmd{chapter} is empty.
+
+Support for changes made to the \texttt{biblatex-chicago} package.
+
+Removed commands: \textcmd{tablenote}, \textcmd{tablesource}, \textcmd{faculty}, and \textcmd{mydegree}.
+
+Removed options: \texttt{emptymargins}.
+
\marginnote{\rmfamily{2016/03/18}}%
Support for changes made to the \texttt{biblatex} package (2016/03/03).
@@ -345,7 +434,7 @@ An \texttt{authordate} option has been added, improving support for the author-d
Adjustments to the formatting of both enumerated and itemized lists.
-The \texttt{endnotes} option has (1) added support for endnotes that contain an underscore character (\texttt{\_}), and (2) improved the implementation of the \texttt{\textbackslash theendnotes} command.
+The \texttt{endnotes} option has (1) added support for endnotes that contain an underscore character (\texttt{\_}), and (2) improved the implementation of the \textcmd{theendnotes} command.
\marginnote{\rmfamily{2016/02/27}}%
@@ -353,17 +442,17 @@ This update is a significant rewrite of \texttt{turabian-formatting}. It is desi
Both \texttt{turabian-researchpaper} and \texttt{turabian-thesis} can use the \texttt{noadjustbib} option.
-Significant adjustments made to the \texttt{\textbackslash maketitle} command, including support for footnotes.
+Significant adjustments made to the \textcmd{maketitle} command, including support for footnotes.
-Double-spaced text is typeset with a \texttt{\textbackslash baselinestretch} of \texttt{2} using the \texttt{\textbackslash setstretch} command provided by the \texttt{setspace} package (instead of \texttt{\textbackslash doublespacing}). This is different than previous versions of \texttt{turabian-formatting} and should be more-consistent with expectations for ``double spaced" work.
+Double-spaced text is typeset with a \textcmd{baselinestretch} of \texttt{2} using the \textcmd{setstretch} command provided by the \texttt{setspace} package (instead of \textcmd{doublespacing}). This is different than previous versions of \texttt{turabian-formatting} and should be more-consistent with expectations for ``double spaced" work.
Packages no longer required: \texttt{xifthen}, \texttt{fancyhdr}, \texttt{titlesec}, \texttt{quoting}, \texttt{caption}, \texttt{flafter}, \texttt{url}, and \texttt{chngcntr}.
Deprecated options: \texttt{emptymargins}.
-Deprecated commands: \texttt{\textbackslash tablenote}, \texttt{\textbackslash tablesource}, \texttt{\textbackslash faculty}, and \texttt{\textbackslash mydegree}.
+Deprecated commands: \textcmd{tablenote}, \textcmd{tablesource}, \textcmd{faculty}, and \textcmd{mydegree}.
-Removed commands: \texttt{\textbackslash setpageidentifier}, and \texttt{\textbackslash setwordcount}.
+Removed commands: \textcmd{setpageidentifier}, and \textcmd{setwordcount}.
\marginnote{\rmfamily{2015/11/14}}%
@@ -373,19 +462,19 @@ Improved support for the \texttt{biblatex-chicago} package, including added supp
Footnote lines are no longer forced together, allowing a footnote to run over to the next page.
-Adjustments to the spacing that follow the \texttt{\textbackslash chapter*} and \texttt{\textbackslash section*} commands.
+Adjustments to the spacing that follow the \textcmd{chapter*} and \textcmd{section*} commands.
Updated use of page style options, removing the \texttt{fancy} page style.
-\texttt{\textbackslash frontmatter} and \texttt{\textbackslash tableofcontents} no longer ignore the \texttt{bindingoffset} value and margin sizes specified in the source document preamble, through the \texttt{geometry} package.
+\textcmd{frontmatter} and \textcmd{tableofcontents} no longer ignore the \texttt{bindingoffset} value and margin sizes specified in the source document preamble, through the \texttt{geometry} package.
-Improved implementation of the \texttt{raggedright} formatting option with: (1) table and figure captions; and (2) the \texttt{\textbackslash tablenote} command.
+Improved implementation of the \texttt{raggedright} formatting option with: (1) table and figure captions; and (2) the \textcmd{tablenote} command.
Adjustments to the behaviour of table and figure positioning.
-Deprecated commands: \texttt{\textbackslash setwordcount}, \texttt{\textbackslash setpageidentifier}, and \texttt{\textbackslash tablesource}.
+Deprecated commands: \textcmd{setwordcount}, \textcmd{setpageidentifier}, and \textcmd{tablesource}.
-Removed commands: \texttt{\textbackslash mytitlepage} and \texttt{\textbackslash setdraftindicator}.
+Removed commands: \textcmd{mytitlepage} and \textcmd{setdraftindicator}.
\marginnote{\rmfamily{2014/12/27}}%
Formatting changes to both subsection titles and title page for both research papers and theses/dissertations.
@@ -395,11 +484,6 @@ Adjustments to formatting that more-accurately reflect the 8th edition of Turabi
-%\section{Known Bugs}
-%\label{sec:bugs}
-
-
-
\printbibliography