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

Annotation of /trunk/doc/esysdoc.cls

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3295 - (hide annotations)
Fri Oct 22 01:56:02 2010 UTC (9 years ago) by jfenwick
Original Path: trunk/doc/user/esysdoc.cls
File size: 3471 byte(s)


1 jfenwick 3292 %
2     % A class for ESSCC documentation
3     %
4    
5     \NeedsTeXFormat{LaTeX2e}
6     \ProvidesClass{esysdoc}
7     \LoadClass[a4paper, twoside]{book}
8    
9 jfenwick 3294 \usepackage[a4paper, left=2.5cm, right=2.5cm, nohead, vcentering, scale=0.8]{geometry}
10 jfenwick 3292 \usepackage{times}
11     \usepackage{listings}
12 jfenwick 3294 \usepackage{ifpdf}
13 jfenwick 3292
14     %\usepackage{avant}
15 jfenwick 3294 %\renewcommand{\familydefault}{\sfdefault} % Switch to san seriff
16 jfenwick 3292 \usepackage{url}
17     \usepackage{xspace}
18 caltinay 3293 \usepackage{graphicx,color}
19 jfenwick 3292 \usepackage{amsmath} %For equation*
20     \usepackage{amsfonts,amssymb} % see http://www.ams.org/tex/amslatex.html
21     \usepackage[nohyphen, strings]{underscore}
22    
23 jfenwick 3294 %Blue was chosen here because it looks ok when printed
24 jfenwick 3295 \usepackage[pdfborder={0 0 0},pdfdisplaydoctitle=true,linktocpage=true, colorlinks=true,linkcolor=blue,citecolor=blue,urlcolor=blue]{hyperref}
25 jfenwick 3292
26 jfenwick 3294 \usepackage{fancyhdr}
27     \renewcommand{\footrulewidth}{0.4pt}
28     \renewcommand{\headrulewidth}{0pt}
29 jfenwick 3292
30 jfenwick 3294 \fancypagestyle{plain}{%
31     \fancyhead{}
32     \cfoot{}
33     \fancyfoot[LE,RO]{\thepage} %left on even pages right on odd pages
34     \fancyfoot[RE]{\nouppercase{\rightmark}}
35     \fancyfoot[LO]{\nouppercase{\leftmark}}
36     }
37     \pagestyle{plain}
38 jfenwick 3292
39 jfenwick 3294 \usepackage[Bjarne]{fncychap}
40     % \ChRuleWidth{1pt}
41     \ChNameVar{\raggedleft\large\sffamily} % The word chapter
42     \ChNumVar{\raggedleft\bfseries\Large} % The number of the chapter
43     \ChTitleVar{\raggedleft \Huge\sffamily} % title of the chapter
44 jfenwick 3295 \ChTitleAsIs
45 jfenwick 3292
46 jfenwick 3294 %Ensures that latex doesn't have an error if we don't specify the version
47     \providecommand{\RepVersion}{Unknown\xspace}
48 jfenwick 3292
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 jfenwick 3295 \newcommand{\code}[1]{%
74     \ifmmode%
75     \mbox{\texttt{#1}}%
76     \else%
77     \texttt{#1}%
78     \fi % Because people try to put code in maths mode
79     }
80 jfenwick 3292
81     \newenvironment{abstract}{\newpage\mbox{}\vfill\begin{center}\textbf{Abstract}\end{center}}{\vfill\newpage}
82    
83     \newcommand{\authoraddress}[1]{\gdef \@authoraddress {#1}}
84    
85     \newcommand{\release}[1]{\gdef \@ESreleasename {#1}}
86     \release{nightly} %Just so we have a default
87    
88     \newcommand*{\subtitleLineOne}{\textsl{Release - \@ESreleasename}}
89     \newcommand*{\subtitleLineTwo}{\textsl{(r\RepVersion)}}
90    
91     \renewcommand{\maketitle}{
92     \begin{titlepage}
93 jfenwick 3294 \textsf{
94 jfenwick 3292 \begin{raggedleft}
95     \Huge
96     \hrule
97     \mbox{}\\
98     \mbox{}\\
99     \@title
100     \mbox{}\\
101     \LARGE
102     \mbox{}\\
103     \subtitleLineOne\\
104     \subtitleLineTwo\\
105     \vfill
106     \@author
107     \vfill
108     \vfill
109     \large
110     \@date\\
111     \vfill
112     \@authoraddress\mbox{}\\
113     \end{raggedleft}
114 jfenwick 3294 }
115 jfenwick 3292 \end{titlepage}}
116    
117    
118     %Please do not use this one
119     \newcommand*{\strong}{}
120    
121    
122    

  ViewVC Help
Powered by ViewVC 1.1.26