Created Getting Started (markdown)

Getting-Started.md

@@ -0,0 +1,160 @@
+### Class Options
+
+The class file, `PhDThesisPSnPDF`, is based on the standard `book` class
+
+It supports the following custom options:
+
+*   `a4paper` (default as per the University guidelines) or `a5paper`: Paper size
+
+*   `11pt` or `12pt`: The University of Cambridge guidelines recommend using a minimum font size of 11pt (12pt is preferred) and 10pt for footnotes. This template also supports `10pt`.
+
+*   `oneside` or `twoside` (default): This is especially useful for printing double side (twoside) or single side.
+
+*   `print`: Supports Print and Online Version with different page margins and hyperlink styles.
+    Use `print` in the options to activate Print Version with appropriate margins and page layout and view styles. 
+    Leaving the options field blank will activate Online version.
+
+*   `custommargin`: You can alter the margin dimension for both print and online version by using the keyword `custommargin` in the options. Then you can define the dimensions of the margin in the `preamble.tex` file: 
+
+        \ifsetMargin
+        \else
+        \RequirePackage[left=37mm,right=30mm,top=35mm,bottom=30mm]{geometry} 
+        \setFancyHdr
+        \fi
+    `\setFancyHdr` should be called when using custom margins for proper header/footer dimensions
+
+
+*   `index`: Including this option builds the index, which is placed at the end of the thesis.
+
+    Instructions on how to use the index can be found [here](http://en.wikibooks.org/wiki/LaTeX/Indexing#Using_makeidx).
+
+    _Note_: the package `makeidx` is used to create the index.
+    
+*   `abstract`: This option enables only the thesis title page and the abstract with title and author to be printed. 
+
+### Abstract separate
+
+*  A separate abstract with the title of the PhD and the candidate name has to be submitted to the Student Registry. This can be generated using `abstract` option in the document class. Ignore subsequent warnings about skipping sections (if any).
+
+*  To generate the separate abstract and the title page, make sure the following commands are in the `preamble.tex` file: 
+
+        \ifdefineAbstract
+        \includeonly{Abstract/abstract}
+        \else
+        \fi
+
+
+### Choosing the Fonts
+
+`PhDThesisPSnPDF` currently supports two fonts `Times` and `Latin Modern (default)`.
+
+*   `times`: (The University of Cambridge guidelines recommend using Times). Specifying times option in the document class will use `mathptpx` or `Times` font with Math Support.
+*   `fourier`: fourier font with math support
+*   `default (empty)`: When no font is specified, `Latin Modern` is used as the default font with Math Support. 
+*   `customfont`: Any custom font can be set in preamble by using `customfont` option in the document class. Then the custom font can be loaded in preamble.tex in the line:
+
+		\ifsetFont
+		\else 
+		\RequirePackage{Your_Custom_Font}
+		\fi
+
+### Choosing the Bibliography style
+
+`PhDThesisPSnPDF` currently supports two styles `authoryear` and `numbered (default)`. Citation style has to be set. You can also specify `custombib` style
+
+* `authoryear`: For author-year citation eg., Krishna (2013)
+
+* `numbered`: (Default Option) For numbered and sorted citation e.g., [1,5,2]
+
+* `custombib`: Define your own bibliography style in the `preamble.tex` file.
+
+		\RequirePackage[square, sort, numbers, authoryear]{natbib}
+
+* (Overview of Bibtex-Styles with preview)[http://nodonn.tipido.net/bibstyle.php?]
+
+### Choosing the Page Style
+
+`PhDThesisPSnPDF` defines 3 different page styles (header and footer). The following definition is for `twoside` layout.
+
+* `default (leave empty)`: For Page Numbers in Header (Left Even, Right Odd) and Chapter Name in Header (Right Even) and Section #. Section Name (Left Odd). Blank Footer.
+
+        Header (Even)   : 4                                                 Introduction 
+
+        Header (Odd)    : 1.2 Section Name 		   			                5
+
+        Footer 		    : Empty
+
+* `PageStyleI`: For Page Numbers in Header (Left Even, Right Odd) and Chapter Name next to the Page Number on Even Side (Left Even). Section Number and Section Name and Page Number in Header on Odd Side (Right Odd). Footer is empty. Layout:
+
+        Header (Even)   : 4 | Introduction 
+
+        Header (Odd)    :                         			                1.2 Section Name | 5
+
+        Footer 		    :                               Empty
+
+* `PageStyleII`: Chapter Name on Even Side (Left Even) in Header. Section Number and Section Name in Header on Odd Side (Right Odd). Page numbering in footer. Layout:
+
+        Header (Even)   : Introduction
+        
+        Header (Odd)    : 			   				                        1.2 Section Name
+        
+        Footer[centered]:                           	3
+
+### Changing the visual style of chapter headings
+
+The visual style of chapter headings can be modified using the `titlesec` package. Edit the following lines in the `preamble.tex` file.
+
+        \RequirePackage{titlesec}
+        \newcommand{\PreContentTitleFormat}{\titleformat{\chapter}[display]{\scshape\Large}
+        {\Large\filleft{\chaptertitlename} \Huge\thechapter}
+        {1ex}{}
+        [\vspace{1ex}\titlerule]}
+        \newcommand{\ContentTitleFormat}{\titleformat{\chapter}[display]{\scshape\huge}
+        {\Large\filleft{\chaptertitlename} \Huge\thechapter}{1ex}
+        {\titlerule\vspace{1ex}\filright}
+        [\vspace{1ex}\titlerule]}
+        \newcommand{\PostContentTitleFormat}{\PreContentTitleFormat}
+        \PreContentTitleFormat
+
+### Custom Settings
+
+*   The depth for the table of contents can be set using: 
+
+        \setcounter{secnumdepth}{3}
+	    \setcounter{tocdepth}{3}
+    A depth of [3] indicates to a level of `\subsubsection` or #.#.#.#. Default set as 2.
+
+*   To hide sections from appearing in TOC use: `\tochide\section{Section name}` in your TeX files
+
+*   Define custom caption style for figure and table caption in `preamble.tex` using:
+
+        \RequirePackage[small,bf,figurename=Fig.,labelsep=space,tableposition=top]{caption}
+
+*   Bibliography with Author-Year Citation in `preamble.tex`:
+	
+        \RequirePackage[round, sort, numbers, authoryear]{natbib}
+
+
+### Nomenclature Definition
+
+* To use nomenclature in your chapters:
+
+        \nomenclature[g-pi]{$\pi$}{ $\simeq 3.14\ldots$}
+	        
+    The sort keys have prefix. In this case a prefix of `g` is used to denote Greek Symbols, followed by `-pi` or `-sort_key`. Use a `-` to separate sort key from the prefixes. The standard prefixes defined in this class are:
+
+    * `A` or `a`: Roman Symbols
+
+    * `G` or `g`: Greek Symbols
+
+    * `Z` or `z`: Acronyms/Abbreviations
+
+    * `R` or `r`: Superscripts
+
+    * `S` or `s`: Subscripts
+
+    * `X` or `x`: Other Symbols
+
+*   You can change the Title of Nomenclature to Notations or Symbols in the `preamble.tex` using:
+
+        \renewcommand\nomname{Symbols}