/[escript]/trunk/doc/esysdoc.cls
ViewVC logotype

Contents of /trunk/doc/esysdoc.cls

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3294 - (show annotations)
Fri Oct 22 01:15:56 2010 UTC (9 years ago) by jfenwick
Original Path: trunk/doc/user/esysdoc.cls
File size: 3497 byte(s)
Tweaks

1 %
2 % A class for ESSCC documentation
3 %
4
5 \NeedsTeXFormat{LaTeX2e}
6 \ProvidesClass{esysdoc}
7 \LoadClass[a4paper, twoside]{book}
8
9 \usepackage[a4paper, left=2.5cm, right=2.5cm, nohead, vcentering, scale=0.8]{geometry}
10 \usepackage{times}
11 % \usepackage{fancyvrb} % Hopefully this will give us our code environments
12 \usepackage{listings}
13 \usepackage{ifpdf}
14
15 %\usepackage{avant}
16 %\renewcommand{\familydefault}{\sfdefault} % Switch to san seriff
17 \usepackage{url}
18 \usepackage{xspace}
19 \usepackage{graphicx,color}
20 \usepackage{amsmath} %For equation*
21 \usepackage{amsfonts,amssymb} % see http://www.ams.org/tex/amslatex.html
22 \usepackage[nohyphen, strings]{underscore}
23
24 %Blue was chosen here because it looks ok when printed
25 \usepackage[pdfborder={0 0 0},pdfdisplaydoctitle=true,linktocpage=false, colorlinks=true,linkcolor=blue,citecolor=blue,urlcolor=blue]{hyperref}
26
27 \usepackage{fancyhdr}
28 \renewcommand{\footrulewidth}{0.4pt}
29 \renewcommand{\headrulewidth}{0pt}
30
31 \fancypagestyle{plain}{%
32 \fancyhead{}
33 \cfoot{}
34 \fancyfoot[LE,RO]{\thepage} %left on even pages right on odd pages
35 \fancyfoot[RE]{\nouppercase{\rightmark}}
36 \fancyfoot[LO]{\nouppercase{\leftmark}}
37 }
38 \pagestyle{plain}
39
40 \usepackage[Bjarne]{fncychap}
41 % \ChRuleWidth{1pt}
42 \ChNameVar{\raggedleft\large\sffamily} % The word chapter
43 \ChNumVar{\raggedleft\bfseries\Large} % The number of the chapter
44 \ChTitleVar{\raggedleft \Huge\sffamily} % title of the chapter
45
46 %Ensures that latex doesn't have an error if we don't specify the version
47 \providecommand{\RepVersion}{Unknown\xspace}
48
49 \DeclareUrlCommand\email{}
50
51 \newcommand{\module}[1]{\mbox{\texttt{#1}}}
52
53 \newcommand*{\optional}[1]{[ #1 ]}
54 %This should be converted into a two arg form so we can have different fonts for different parts
55 \newcommand*{\programopt}[1]{#1}
56
57 \newenvironment{classdesc}[3]{\begin{description}\item[class #1]\mbox{}\\}{\end{description}}
58 \newenvironment{methoddesc}[3][{}]{\begin{description}\item[\textbf{#2}(#3)]\mbox{}\\}{\end{description}}
59 \newenvironment{funcdesc}[2]{\begin{description}\item[\textbf{#1}(#2)]\mbox{}\\}{\end{description}}
60 \newenvironment{memberdesc}[2][{}]{\begin{description}\item[\textbf{#2}]\mbox{}\\}{\end{description}}
61 \newenvironment{datadesc}[1]{\begin{description}\item[\textbf{#1}]\mbox{}\\}{\end{description}}
62
63 \newcommand{\file}[1]{\texttt{#1}\xspace}
64 \newcommand{\program}[1]{\textbf{\texttt{#1}}\xspace}
65 % \newcommand{\env}[1]{\texttt{#1}\xspace}
66 \newcommand{\var}[1]{\texttt{#1}\xspace}
67 \newcommand{\kbd}[1]{\texttt{#1}}
68 \newcommand{\function}[1]{\texttt{#1}}
69 \newcommand{\class}[1]{\texttt{#1}}
70 \newcommand{\constant}[1]{\textsl{#1}}
71 \newcommand{\method}[1]{\texttt{#1}}
72 \newcommand{\member}[1]{\texttt{#1}}
73 \newcommand{\code}[1]{\mbox{\texttt{#1}}} % Because people try to put code in maths mode
74
75
76 \newenvironment{abstract}{\newpage\mbox{}\vfill\begin{center}\textbf{Abstract}\end{center}}{\vfill\newpage}
77
78 \newcommand{\authoraddress}[1]{\gdef \@authoraddress {#1}}
79
80 \newcommand{\release}[1]{\gdef \@ESreleasename {#1}}
81 \release{nightly} %Just so we have a default
82
83 \newcommand*{\subtitleLineOne}{\textsl{Release - \@ESreleasename}}
84 \newcommand*{\subtitleLineTwo}{\textsl{(r\RepVersion)}}
85
86 \renewcommand{\maketitle}{
87 \begin{titlepage}
88 \textsf{
89 \begin{raggedleft}
90 \Huge
91 \hrule
92 \mbox{}\\
93 \mbox{}\\
94 \@title
95 \mbox{}\\
96 \LARGE
97 \mbox{}\\
98 \subtitleLineOne\\
99 \subtitleLineTwo\\
100 \vfill
101 \@author
102 \vfill
103 \vfill
104 \large
105 \@date\\
106 \vfill
107 \@authoraddress\mbox{}\\
108 \end{raggedleft}
109 }
110 \end{titlepage}}
111
112
113 %Please do not use this one
114 \newcommand*{\strong}{}
115
116
117

  ViewVC Help
Powered by ViewVC 1.1.26