wiki:ThesisDocumentation

This implementation of TTU thesis/dissertation style is based off Peter Wilson's excellent memoir class. A copy of memoir.cls and other related files is included in this repository.

For the purposes of this document, JOBNAME is the base filename of your thesis or dissertation. That is, if your main thesis file is thesis.tex, JOBNAME is thesis. This value is also used to set the internal LaTeX macro \jobname.

JOBNAME.tex

\documentclass Settings

Font size
10pt, 11pt, 12pt are all valid options for a thesis or dissertation. Which you use is largely decided by how large your committee is (larger committees require a smaller font size to fit all their names on the approval sheet), the length of the title (titles longer than three lines will probably require smaller font sizes to fit everything on the title page and approval sheet), and your chairperson's and committee's ability to read smaller type.
Duplexing
Use the oneside option to format margins for one-sided printing, or the twoside option to format them for two-sided printing. Two-sided printing will obviously save paper.
Draft copies
Use the draft option to compress down the front matter pages (abstract, acknowledgments, etc.) and single-space the body text. This will reduce the number of pages required to print a preliminary copy by approximately 50%.
Copyrighting
Use the copyrighted option to include a copyright page with your thesis or dissertation.
One-sided or two-sided printing
Use the oneside option for one-sided printing and margins. The graduate school requires this format for their PDFs. Use the twoside option for two-sided printing. Two-sided printing is useful for draft copies or unofficial prints.

\title and \author Usage

Set the \title and \author commands to your thesis' title and your name as registered at TTU, respectively. If your thesis title is too long to print on a single line, add double backslashes \\ to force line breaks. TTU style guidelines require that a multi-line title be printed in inverted pyramid format, that is, with each line no longer than any previous line.

If your title contains Greek characters or other symbols not allowed in regular PDF strings, you may need to format the title command as \title{\texorpdfstring{TeX title}{PDF title}} instead. Put the full title as it should be printed in the first argument (here labeled "TeX title") and a more plain-text version of it in the second argument (here labeled "PDF title").

Example:

\title{\texorpdfstring{Further Developments to Einstein's $E=m c^2$ Notes}{Further Developments on Einstein's E=mc2 Notes}}

\usepackage Entries

ttuthesis.cls includes the following packages by default, so there is no need to include them yourself: ifthen, indentfirst, rotating, listings, hyperref, and hypcap.

The memoir class that ttuthesis.cls is based on includes code equivalent to, or extensions of the following packages: abstract, appendix, array, booktabs, ccaption, chngcntr, chngpage, dcolumn, delarray, enumerate, epigraph, framed, ifmtarg, ifpdf, index, makeidx, moreverb, needspace, newfile, [http://ctan.org/pkg/nextpage nextpage, parskip, patchcmd, setspace, shortvrb, showidx, tabularx, titleref, titling, tocbibind, tocloft, verbatim, verse. Normally, there is no need to add your own \usepackage lines for these. See the memoir manual if you need to override the loading of those packages (search for \DisemulatePackage).

Should you need to include any other packages not already included in ttuthesis.cls, add them either to a file JOBNAME-packages-loaded-before-hyperref.sty or to a file JOBNAME-packages-loaded-after-hyperref.sty, depending on whether or not the package needs to be loaded before or after hyperref. See any of the following references for which packages have a specific load order: hyperref README, TeX StackExchange: What's the right order when loading packages?, TeX StackExchange: Which packages should be loaded after hyperref instead of before?, TeX StackExchange: Packages that need to be included in a specific order, LaTeX package conflicts.

\hypersetup Usage

This class and associated files were designed to produce high-quality hyperlinked PDF files. It would be helpful to properly define the author, title, subject, and keywords of your thesis or dissertation for literature searches. The default settings of

\hypersetup{
  pdfsubject={Format and style rules for theses and dissertations at Tennessee Technological University},
  pdfkeywords={thesis, dissertation, style guide}
}

should obviously be adjusted to match your subject and keywords. The ttuthesis.cls code automatically sets the commonly-added pdfauthor and pdftitle fields to the argument of the \author command and a single-line version of the argument of the \title command, respectively.

\abstract Usage

Use the \abstract{} command to define your abstract text. Any valid LaTeX markup is acceptable here, including citations. Separate paragraphs of the abstract with blank lines, just like in regular LaTeX body text. Ensure that the percent sign after the opening brace remains. Removing it would cause an undesired space to be included in the abstract text.

\doctype , \degree , \department , \graduationmonth , \graduationyear Usage

Use the \doctype{Thesis} or \doctype{Dissertation} command to set the type of paper you're writing, either a Thesis or a Dissertation. Use the \degree{} command to set the degree you'll receive, normally Master of Science, Master of Arts, or Doctor of Philosophy. Use the \graduationmonth{} and \graduationyear{} commands to define the month and year of your graduation with this degree.

Dedication and Acknowledgments Pages

Use the \dedication{} and \acknowledgments{} commands to define your dedication and acknowledgments pages, respectively. These pages follow the same markup and syntax rules as the abstract page.

Committee Settings

The certificate of approval for your thesis is automatically generated. Use the \committeechair, \committeecochair, and \committeemembers commands to define your committee's membership and structure as follows:

\committeechair
Your chair's name
\committeecochair
Your co-chair's name, if applicable.
\committeemembers{Firstname1 Lastname1, Firstname1 Lastname2, ...}
The names of the regular members on your committee, separated by commas.

Front Matter Contents

Most of the front matter of your thesis or dissertation is automatically included as needed. Mandatory pages (such as the abstract and title pages) are always included, optional pages (such as the dedication) are only included if you made changes to the default content.

Table of Contents, List of Tables, List of Figures, and Nomenclature

Just above the \mainmatter command in JOBNAME.tex are commands to print the table of contents, lists of tables and/or figures, and a nomenclature or list of symbols. Any of these items not present in your thesis can be commented out, and any missing lists (such as a list of theorems, a list of source code listings, etc.) can be added. For example, if your thesis contains no tables, comment out the \listoftables command. No other format-related changes should be made to this block of code.

Your Chapters and Bibliography

Below the {{\mainmatter}}} command in the JOBNAME.tex, add each chapter to your thesis with an include command, such as \include{\jobname-content/chapter1} to include a file named chapter1.tex from the subfolder JOBNAME-content. At the end of the chapters, include a bibliography or list of references with another include command, for example, \include{\jobname-content/bibliography} .

If you can keep all your chapters, figures, and other content in a separate folder, this will make it easier to get updates to ttuthesis.cls without running the risk of overwriting your files.

Your Appendices

If you have only one appendix in your thesis, uncomment the \renewcommand{\appendixtocname}{Appendix} line in JOBNAME.tex. If you have two or more appendices, uncomment the \renewcommand{\appendixtocname}{Appendices} line. Leave the \appendix line uncommented if you have any number of appendices. Add each appendix to your thesis with an include command, such as \include{\jobname-content/appendix-a} to include a file named appendix-a.tex from the subfolder JOBNAME-content.

Final Edits on Table of Contents, List of Figures, List of Tables, etc. Pages

TTU has some exacting standards for how the Table of Contents, Lists of Figures and/or Tables, and other such pages should be formatted. These requirements should be handled automatically in all cases, but you may have to rerun LaTeX on your main file a few times.

Vita

Add your vita to your thesis (required on final copies) with an \vita command, such as \vita{\jobname-content/vita} to include a file named vita.tex from the JOBNAME-content folder.

chapter1.tex, chapter2.tex, etc.

Each chapter of your thesis should probably be a separate file for easier editing. The content of each chapter file should follow the following pattern:

\chapter{The Essentials}
\label{chap:TheEssentials}

\section{Purpose of the Guide}
\label{sec:PurposeOfTheGuide}

This guide is designed to be a basic source of information for
the\-sis/dis\-ser\-ta\-tion preparation. It establishes the technical
parameters within which you should work, such as quality of paper,
number of copies to be submitted, margins, and the sequence of pages
within the manuscript.

Each chapter, section, and lower heading should have a corresponding \label command for easier cross-referencing. Each paragraph is separated with one or more blank lines. LaTeX will automatically hyphenate words it finds in its dictionary, but can be informed of where it can hyphenate combined or technical words with the \- characters.

appendix-a.tex, appendix-b.tex, etc.

Appendices are syntactically identical to regular chapters.

vita.tex

The vita is a slightly odd chapter, so it needs some special treatment. It's basically the *contents* of a chapter, since its name and its entry in the Table of Contents can only be in one format. So its first few lines are something like:

John W. Buck was born in Orlando, Florida, on July 21, 1961. He
attended elementary schools in the Orange County School District and
...
Last modified 5 months ago Last modified on May 9, 2017, 3:18:36 PM