whcs.tex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% WHCS Senior design 1 document
%   Written at UCF in 2015 
%   Typeset by Grant Hernandez
%   For authors, see the title page
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% What type of document are we building here
\ifdefined\enabledraft
  \documentclass[draft,letterpaper,11pt]{article}
\else
  \ifdefined\enablefinal
    \documentclass[final,letterpaper,11pt]{article}
  \else
    \documentclass[letterpaper,11pt]{article}
  \fi
\fi
\usepackage[margin=1in, lmargin=1.5in]{geometry}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Packages
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Common color names
\usepackage[usenames,svgnames]{xcolor}
% For \textsubscript
\usepackage{fixltx2e}
% For meeting senior design specifications
\usepackage{parskip}
% For easy importing of documents
\usepackage{import}
% For the checkbox and other math symbols
\usepackage{amsmath}
\usepackage{amssymb}
% Advanced captions
\usepackage{caption}
% TODO tracking
\usepackage[obeyFinal,colorinlistoftodos,prependcaption,textsize=tiny]{todonotes}
% Fancy section headings
\usepackage{titlesec}
% TikZ madness
\usepackage{tikz}
\usetikzlibrary{shapes.misc}
% Filler text
\usepackage{lipsum}
% Wrapping text around figures
\usepackage{wrapfig}
% For pretty code listings
\usepackage{listings}
% Keep floats in check with [H]
\usepackage{float}
% For including raw PDFs
\usepackage{pdfpages}
% Fancy if statements
\usepackage{ifthen}
\usepackage{array}
%\usepackage{booktabs,adjustbox}
%\usepackage{supertabular}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Hyperref should be last
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Document jumping and linkage
% NEVER use draft mode for hyperref
\ifdefined\enabledraft
  \usepackage[draft=false]{hyperref}
\else
  \usepackage{hyperref}
\fi

% Probably not needed for now
%\usepackage{setspace}
%\usepackage{fancyhdr}
%\usepackage{wrapfig}
%\usepackage[binary-units]{siunitx}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Color Palette
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Code Colors
\definecolor{CommentGreen}{rgb}{0,0.6,0}
\definecolor{numbering}{gray}{0.5}
\definecolor{keywordc}{rgb}{.63,0,.42}

% Title page
\definecolor{whcs-accent}{HTML}{A66AFF}
\definecolor{whcs-accent-dark}{HTML}{6600FF}
\definecolor{whcs-muted}{HTML}{555555}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% LaTeX Configuration & Macros
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Keep our graphics nice and neat
\graphicspath{{img/}}

% Customize hyperref
\urlstyle{same} % remove monospaced links
\ifdefined\printable
\hypersetup{pdfnewwindow=true, % prevent the user from leaving the paper
hidelinks,
% PDF Meta
pdftitle={Wireless Home Control System - UCF Senior Design I},
pdfsubject={University of Central Florida Senior Design 2015},
pdfauthor={Grant Hernandez},
}
\else
\hypersetup{pdfnewwindow=true, % prevent the user from leaving the paper
colorlinks,
linkcolor={whcs-accent-dark},
citecolor={blue!50!black},
urlcolor={blue!80!black},
% PDF Meta
pdftitle={Wireless Home Control System - UCF Senior Design I},
pdfsubject={University of Central Florida Senior Design 2015},
pdfauthor={Grant Hernandez},
}
\fi

% Customize autoref names
% See page 16 of hyperref manual
\renewcommand\sectionautorefname{Section}
\renewcommand\subsubsectionautorefname{Section}
\renewcommand\subsectionautorefname{Section}
\renewcommand\paragraphautorefname{Section}

% Custom figure macro for quick and easy changes across the document
%   \ucffig
%     Param 1: label
%     Param 2: figure content
%     Param 3: caption
\newcommand{\ucffig}[3]{
\begin{figure}[H]
\centering
\makebox[\textwidth][c]{
#2
}
\caption{#3}
\label{#1}
\end{figure}
}

\newcommand{\ucfgfx}[4][scale=1.0]{
\ucffig{#2}{\includegraphics[#1]{#3}}{#4}
}

% TBW macro
\newcommand{\tbw}{\emph{This section is in the process of being written.}}

% Section Heading Customization
\ifdefined\printable
\else
  \ifdefined\enabledraft
  \else
    \newcommand\titlebar{%
      \input{section-heading.tex}
    }
    \titleformat{\section}{\bfseries\Large}{\color{white}\titlebar}{0.1cm}{}
  \fi
\fi

% Disable images on draft mode
\ifdefined\enabledraft
  \renewcommand{\includegraphics}[2][]{}
  \renewcommand{\includepdf}[2][]{}
\else
\fi

\renewcommand*{\thesection}{\arabic{section}}

% A custom listing format
\lstdefinestyle{code}{%
  basicstyle=\ttfamily\small,
  language=php,
  numbers=left,
  numberstyle=\footnotesize\color{numbering},
  fontadjust=true,
  basewidth=0.5em,
  % flexiblecolumns=true,
  keywordstyle={\bfseries\color{magenta}},
  commentstyle=\color{CommentGreen},
  stringstyle=\color{red},
  showstringspaces=false,
  tabsize=4,
  %xleftmargin=\MaxSizeOfLineNumbers
}

%=%=%=%=%=%=%=%=%=%=%=%=%=%=%=%=%=%=%=%
% BEGIN DOCUMENT
%=%=%=%=%=%=%=%=%=%=%=%=%=%=%=%=%=%=%=%
\begin{document}

% We want this depth for our TOC
\setcounter{secnumdepth}{3}
\setcounter{tocdepth}{4}

% Start roman numerals as per the spec
\pagenumbering{roman}

% BEGIN COVER PAGE
\input{title-page.tex}

\todo{Fix footnotes in captions and list of figure hyperlinks}
% BEGIN TOC,LOF,LOT
\tableofcontents% \addcontentsline{toc}{section}{Table of Contents}
%\let\clearpage\relax
\listoffigures% \addcontentsline{toc}{section}{List of Figures}
\listoftables% \addcontentsline{toc}{section}{List of Tables}
\listoftodos
\clearpage
% \endgroup

% Resume usage of arabic numerals
\pagenumbering{arabic}

% BEGIN SECTION LISTING
%\onehalfspacing
\import{./}{toc.tex}

\end{document}