phdstyle.sty

\NeedsTeXFormat{LaTeX2e}

\ProvidesPackage{phdstyle}[2020/05/11 Custom LaTeX style]


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% PACKAGES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


%% Silence warning
\RequirePackage{silence}
\WarningFilter{filehook}{Macro}


%% Standalone
\RequirePackage{standalone}


%% Encoding
\RequirePackage[utf8]{inputenx}
\RequirePackage[T1]{fontenc}


%% Fonts and typography
\RequirePackage{lmodern}           % Latin Modern
%\renewcommand{\sfdefault}{phv}     % Helvetica
\RequirePackage[scaled]{beramono}  % Bera Mono (Bitstream Vera Sans Mono)
\RequirePackage[final]{microtype}  % Improved typography
\pretolerance = 1000               % Relaxes parameters for line breaks
\tolerance    = 2000               % Relaxes parameters for line breaks
\setlength{\emergencystretch}{1em} % Relaxes parameters for line breaks
\RequirePackage{siunitx}           % Typesetting units
\RequirePackage{listings}          % Typesetting code
\lstset
{
    basicstyle       = \ttfamily\footnotesize,
    keywordstyle     = \color{uiored},
    commentstyle     = \color{uiogrey},
    stringstyle      = \itshape,
    showstringspaces = false
}


%% Mathematics
\RequirePackage{amssymb}    % Extra symbols
\RequirePackage{amsthm}     % Theorem-like environments
\RequirePackage{thmtools}   % Theorem-like environments, extends amsthm
\RequirePackage{mathtools}  % Fonts and environments for mathematical formulae
\RequirePackage{mathrsfs}   % Script font with \mathscr{}
\RequirePackage{dsfont}     % Double stroke font with \mathds{}
\RequirePackage{cancel}     % Cancel terms with \cancel, \bcancel or \xcancel
\RequirePackage{stmaryrd}   % Brackets
\everymath
{
    \ifodd\value{page}          % Allow multiline equations
        \allowdisplaybreaks[1]  % to break across two pages:
        \else                   % - Breaks from odd to even pages are allowed,
        \allowdisplaybreaks[4]  %   but discouraged.
    \fi                         % - Breaks from even to odd pages are allowed.
}


%% Language
\RequirePackage{babel}
\RequirePackage{csquotes}


%% Tables
\RequirePackage{multirow}      % Rows spanning multiple lines in tables
\RequirePackage{tablefootnote} % Footnotes for tables


%% Lists
\RequirePackage{enumitem}
\setlist[itemize]    {font = \upshape,           before = \leavevmode}
\setlist[enumerate]  {font = \upshape,           before = \leavevmode}
\setlist[description]{font = \bfseries\sffamily, before = \leavevmode}
\foreach \env in {theorem, corollary, lemma, proposition, observation,
                  conjecture, definition, example, notation, remark}
{
    \AtBeginEnvironment{\env}
    {
        \setlist[enumerate, 1]{wide,
                               label = \thetheorem.\arabic{*}.,
                               ref   = \thetheorem.\arabic{*}}
    }
}


%% Drawing
\usetikzlibrary{intersections}
\usetikzlibrary{decorations.markings}


%% Organising tools
\RequirePackage{comment}                                 % Multiline comments


\RequirePackage[obeyFinal,
                color       = LightGray,
                bordercolor = LightGray,
                textsize    = tiny,
                textwidth   = 25mm,
                figwidth    = 0.99\linewidth]{todonotes} % Marginal notes


%% Miscellaneous
\RequirePackage{etoolbox} % Hooks
\RequirePackage{pgffor}   % For-loops
\RequirePackage{xspace}   % Clever space
\RequirePackage{titletoc} % Partial table of contents


%% Cross references and links
\RequirePackage[obeyspaces, spaces, hyphens]{url}             % Format URLs
\urlstyle{sf}
\RequirePackage{varioref}                                     % \vref
\RequirePackage[pdfusetitle]{hyperref}                        % Clickable links
\RequirePackage[nameinlink, capitalize, noabbrev]{cleveref}   % \cref
\RequirePackage{doi}           % Ignore LaTeX syntax in DOI links
\renewcommand{\doitext}{DOI:\space}


%% Bibliography
\usepackage[giveninits=true, sorting=none, alldates=iso, maxnames=8]{biblatex}
\addbibresource{bibliography.bib}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%% USER-DEFINED MACROS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%


%% Environments
\declaretheoremstyle[headfont   = \bfseries\sffamily,
                     notefont   = \normalfont,
                     bodyfont   = \itshape,
                     spaceabove = 6pt,
                     spacebelow = 6pt]{plain}
\declaretheoremstyle[headfont   = \bfseries\sffamily,
                     notefont   = \normalfont,
                     spaceabove = 6pt,
                     spacebelow = 6pt]{definition}
\declaretheorem[style = plain,  numberwithin = section]{theorem}
\declaretheorem[style = plain,       sibling = theorem]{corollary}
\declaretheorem[style = plain,       sibling = theorem]{lemma}
\declaretheorem[style = plain,       sibling = theorem]{proposition}
\declaretheorem[style = plain,       sibling = theorem]{observation}
\declaretheorem[style = plain,       sibling = theorem]{conjecture}
\declaretheorem[style = definition,  sibling = theorem]{definition}
\declaretheorem[style = definition,  sibling = theorem]{example}
\declaretheorem[style = definition,  sibling = theorem]{notation}
\declaretheorem[style = remark,      sibling = theorem]{remark}
\declaretheorem[style = definition, numbered = no]{acknowledgements}
\crefname{observation}{Observation}{Observations}
\Crefname{observation}{Observation}{Observations}
\crefname{conjecture}{Conjecture}{Conjectures}
\Crefname{conjecture}{Conjecture}{Conjectures}
\crefname{notation}{Notation}{Notations}
\Crefname{notation}{Notation}{Notations}
\crefname{paper}{Paper}{Papers}
\Crefname{paper}{Paper}{Papers}


%% Operators
\newcommand{\diff}{\mathop{}\!\mathrm{d}}
\DeclareMathOperator{\im}{im}
%\DeclareMathOperator{\rank}{rank}


%% Delimiters
\DeclarePairedDelimiter{\p}{\lparen}{\rparen}          % Parenthesis
\DeclarePairedDelimiter{\set}{\lbrace}{\rbrace}        % Set
%\DeclarePairedDelimiter{\abs}{\lvert}{\rvert}          % Absolute value
%\DeclarePairedDelimiter{\norm}{\lVert}{\rVert}         % Norm
%\DeclarePairedDelimiter{\ip}{\langle}{\rangle}         % Inner product, ideal
\DeclarePairedDelimiter{\sqb}{\lbrack}{\rbrack}        % Square brackets
\DeclarePairedDelimiter{\ssqb}{\llbracket}{\rrbracket} % Double brackets
\DeclarePairedDelimiter{\ceil}{\lceil}{\rceil}         % Ceiling
\DeclarePairedDelimiter{\floor}{\lfloor}{\rfloor}      % Floor


%% Blackboard bold
\newcommand{\N}{\mathbb{N}}    % Natural numbers
\newcommand{\Z}{\mathbb{Z}}    % Integers
\newcommand{\Q}{\mathbb{Q}}    % Rational numbers
\newcommand{\R}{\mathbb{R}}    % Real numbers
\newcommand{\C}{\mathbb{C}}    % Complex numbers
\newcommand{\A}{\mathbb{A}}    % Affine space
\renewcommand{\P}{\mathbb{P}}  % Projective space


%% Bold face
\renewcommand{\a}{\mathbf{a}}
\renewcommand{\b}{\mathbf{b}}
\newcommand{\x}{\mathbf{x}}
\newcommand{\y}{\mathbf{y}}
\newcommand{\0}{\mathbf{0}}
\newcommand{\1}{\mathbf{1}}


%% Miscellaneous
\renewcommand{\qedsymbol}{\(\blacksquare\)}
\newcommand{\arxiv}[1]{arXiv:\space\href{http://arxiv.org/abs/#1}{#1}\xspace}
\newcommand{\ie}{\leavevmode\unskip, i.e.,\xspace}
\newcommand{\eg}{\leavevmode\unskip, e.g.,\xspace}
\newcommand{\dash}{\textthreequartersemdash\xspace}
\newcommand{\TikZ}{Ti\textit{k}Z\xspace}
\newcommand{\matlab}{\textsc{Matlab}\xspace}


\endinput