1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
|
%
% A class for ESSCC documentation
%
\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{esysdoc}
\LoadClass[a4paper, twoside]{book}
\usepackage[a4paper, left=2.5cm, right=2.5cm, nohead, vcentering, scale=0.8]{geometry}
\usepackage{times}
\usepackage{listings}
\usepackage{ifpdf}
\usepackage{makeidx}
%\usepackage{avant}
%\renewcommand{\familydefault}{\sfdefault} % Switch to san seriff
\usepackage{url}
\usepackage{xspace}
\usepackage{graphicx}
\usepackage{amsmath} %For equation*
\usepackage{amsfonts,amssymb} % see http://www.ams.org/tex/amslatex.html
\usepackage[nohyphen, strings]{underscore}
%Blue was chosen here because it looks ok when printed
\usepackage[pdfborder={0 0 0},pdfdisplaydoctitle=true,linktocpage=false, colorlinks=true,linkcolor=blue,citecolor=blue,urlcolor=blue,pdfusetitle]{hyperref}
% links to figures point to captions without this:
\usepackage[all]{hypcap}
%Dummy commands for if we ever need to switch off hyperref
% \providecommand{\pdfbookmark}[3][0]{}
% \providecommand{\currentpdfbookmark}[2]{}
% \providecommand{\subpdfbookmark}[2]{}
\usepackage{fancyhdr}
\renewcommand{\footrulewidth}{0.4pt}
\renewcommand{\headrulewidth}{0pt}
\fancypagestyle{plain}{%
\fancyhead{}
\cfoot{}
\fancyfoot[LE,RO]{\thepage} %left on even pages right on odd pages
\fancyfoot[RE]{\nouppercase{\rightmark}}
\fancyfoot[LO]{\nouppercase{\leftmark}}
}
\pagestyle{plain}
\usepackage[Bjarne]{fncychap}
% \ChRuleWidth{1pt}
\ChNameVar{\raggedleft\large\sffamily} % The word chapter
\ChNumVar{\raggedleft\bfseries\Large} % The number of the chapter
\ChTitleVar{\raggedleft \Huge\sffamily} % title of the chapter
\ChTitleAsIs
%Ensures that latex doesn't have an error if we don't specify the version
\providecommand{\RepVersion}{Unknown\xspace}
\DeclareUrlCommand\email{}
\newcommand{\module}[1]{\mbox{\texttt{#1}}}
\newcommand*{\optional}[1]{[ #1 ]}
%This should be converted into a two arg form so we can have different fonts for different parts
\newcommand*{\programopt}[1]{#1}
\newenvironment{bigdef}[1]{%
\vspace{1em}
\setlength{\hangindent}{2cm}%
\raggedright\textbf{#1}
\setlength{\hangindent}{1cm}%
\setlength{\hangafter}{0}%
}%
{%
}
\newenvironment{classdesc}[2]{%
\begin{bigdef}{class #1(#2)}}{\end{bigdef}}
\newenvironment{classdesc*}[1]{%
\begin{bigdef}{class #1}}{\end{bigdef}}
\newenvironment{methoddesc}[3][{}]{%
\begin{bigdef}{#2(#3)}}{\end{bigdef}}
\newenvironment{funcdesc}[2]{%
\begin{bigdef}{#1(#2)}%
}
{%
\end{bigdef}
}
% {
% \begin{bigdef}[#1(#2)]
% \noindent
% \setlength{\hangindent}{2cm}
% \textbf{#1(#2)}
%
% }
% \setlength{\hangindent}{1cm}
% \setlength{\hangafter}{0}
% \noindent
% }%
% {%
%
% \mbox{}\\
% }
\setlength{\itemindent}{-1cm}\setlength{\leftmargin}{1cm}
\newenvironment{memberdesc}[2][{}]{\begin{description}\item[\textbf{#2}]\mbox{}\\}{\end{description}}
\newenvironment{datadesc}[1]{\begin{description}\item[\textbf{#1}]\mbox{}\\}{\end{description}}
\newcommand{\file}[1]{\texttt{#1}\xspace}
\newcommand{\program}[1]{\textbf{\texttt{#1}}\xspace}
% \newcommand{\env}[1]{\texttt{#1}\xspace}
\newcommand{\var}[1]{\texttt{#1}\xspace}
\newcommand{\kbd}[1]{\texttt{#1}\xspace}
\newcommand{\function}[1]{\texttt{#1}}
\newcommand{\class}[1]{\texttt{#1}}
\newcommand{\exception}[1]{\texttt{#1}}
\newcommand{\constant}[1]{\textsl{#1}}
\newcommand{\method}[1]{\texttt{#1}}
\newcommand{\member}[1]{\texttt{#1}}
\newcommand{\code}[1]{%
\ifmmode%
\mbox{\texttt{#1}}%
\else%
\texttt{#1}%
\fi % Because people try to put code in maths mode
}
\newenvironment{abstract}{\newpage\mbox{}\vfill\begin{center}\textbf{Abstract}\end{center}}{\vfill\newpage}
\newcommand{\authoraddress}[1]{\gdef \@authoraddress {#1}}
\newcommand{\release}[1]{\gdef \@ESreleasename {#1}}
\release{nightly} %Just so we have a default
\newcommand*{\subtitleLineOne}{\textsl{Release - \@ESreleasename}}
\newcommand*{\subtitleLineTwo}{\textsl{(r\RepVersion)}}
\renewcommand{\maketitle}{
\begin{titlepage}
\pdfbookmark[0]{Title page}{title}
\textsf{
\begin{raggedleft}
\Huge
\hrule
\mbox{}\\
\mbox{}\\
\@title
\mbox{}\\
\LARGE
\mbox{}\\
\subtitleLineOne\\
\subtitleLineTwo\\
\vfill
\@author
\vfill
\vfill
\large
\@date\\
\vfill
\@authoraddress\mbox{}\\
\end{raggedleft}
}
\end{titlepage}}
\newcommand{\esysappendix}{%
\appendix%
\renewcommand*{\theHchapter}{\Alph{chapter}} %How latex generates chapters
\renewcommand*{\thechapter}{\Alph{chapter}} %How hyperref generates chapters
}
|