Custom Commands
\abbrvcaption{short}{long}
Adds a caption for a figure where only part of the caption appears in the table of contents.
- short: The short caption, this caption will appear in both the table of contents AND the text.
- long: The long caption that will ONLY appear in the text. Appears after the short caption.
\addabbreviation{explanation}{abbreviation}
Adds an abbreviation for a phase that then appears in the \listofabbreviations table.
- explanation: What the abbreviation represents.
- abbreviation: The abbreviation you wish to list with the \listofabbreviations command.
\addpocketcontents{title}
Adds a "pocket appendix item" to the table of contents.
- title: The title of the item to add to the table of contents.
\addsymbol{explanation}{$symbol$}
Adds a symbol for a concept that then appears in the \listofsymbols table
- explanation: The concept that the symbol represents.
- $symbol$: The symbol you wish to list with the \listofsymbols command. It is recommended that you print the symbol in math mode by placing dollar signs on either side. For some symbols this is absolutely necessary (such as \mu) and it is best to keep the style of the symbol table consistent.
\appendix{title}
Adds a chapter-style appendix section.
- title: The title of the appendix section.
\atom{mass number}{proton number}{symbol}{ionization}{# atoms}
Inserts a chemical symbol for an atom in a way that does not conflict with the PDF index.
- mass number: The mass number of the atom, displayed as: massAtom. Not displayed in the PDF index.
- proton number: The proton number of the atom, displayed as: protonsAtom. Not displayed in the PDF index.
- symbol: The symbol for the atom.
- ionization: The ionization of the atom, displayed as: Atomion. Not displayed in the PDF index.
- # atoms: The number of atoms (for creating molecules), displayed as: Atomnumber.
\csmfigure[position]{label}{filename}{width}{caption}
Inserts a figure in a fairly automatic fashion (no need to manually resize or create a float).
- position: Figure placement flags (optional), "ht" is recommended for most situations.
- label: Label for use with the the \ref{fig:label} command.
- filename: The filename of the figure to insert.
- width: The width of the figure, the height will scale automatically.
- caption: The caption for the figure.
\csmlongfigure[position]{label}{filename}{width}{short_caption}{long_caption}
Similar to
\csmfigure, with an added option for a long caption (which does not appear in the table of contents).
- position: Figure placement flags (optional), "ht" is recommended for most situations.
- label: Label for use with the the \ref{fig:label} command.
- filename: The filename of the figure to insert.
- width: The width of the figure, the height will scale automatically.
- short_caption: The short caption for the figure (see \abbrvcaption).
- long_caption: The long caption for the figure (see \abbrvcaption).
\listofabbreviations
Outputs a list of all of the abbreviations used in the document (see
\addabbreviation).
\listoffiguresandtables
Outputs a list of all of the figures and tables used in the document.
\listofsymbols[title]
Outputs a list of all of the symbols used in the document (see
\addsymbol).
- title: The title to give the List of Symbols (optional), for example: Nomenclature. Defaults to "List of Symbols".
\makecopyright{year}
Adds a copyright page with the indicated year/years.
- year: The copyright year or list of years, use \the\year for the current year.
Custom Environments
\begin{abstract} ... nd{abstract}
A special environment for the abstract. This environment automatically detects abstracts that exceed 350 words and displays a warning for PhD candidates that the abstract may require revision.
\begin{acknowledgements} ... nd{acknowledgements}
A special environment for the acknowledgements section.
\begin{dedication} ... nd{dedication}
A special environment for the dedication page. This page is typeset vertically and horizontally centered without a title.
\begin{selected-bibliography} ... nd{selected-bibliography}
A special environment for the "Selected Bibliography" section.