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

Contents of /trunk/doc/esysdoc.cls

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3305 - (show annotations)
Mon Oct 25 05:04:22 2010 UTC (9 years ago) by jfenwick
File size: 3970 byte(s)
Fancy shuffling

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{listings}
12 \usepackage{ifpdf}
13
14 %\usepackage{avant}
15 %\renewcommand{\familydefault}{\sfdefault} % Switch to san seriff
16 \usepackage{url}
17 \usepackage{xspace}
18 \usepackage{graphicx,color}
19 \usepackage{amsmath} %For equation*
20 \usepackage{amsfonts,amssymb} % see http://www.ams.org/tex/amslatex.html
21 \usepackage[nohyphen, strings]{underscore}
22
23 %Blue was chosen here because it looks ok when printed
24 \usepackage[pdfborder={0 0 0},pdfdisplaydoctitle=true,linktocpage=false, colorlinks=true,linkcolor=blue,citecolor=blue,urlcolor=blue]{hyperref}
25
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 \ChTitleAsIs
46
47 %Ensures that latex doesn't have an error if we don't specify the version
48 \providecommand{\RepVersion}{Unknown\xspace}
49
50 \DeclareUrlCommand\email{}
51
52 \newcommand{\module}[1]{\mbox{\texttt{#1}}}
53
54 \newcommand*{\optional}[1]{[ #1 ]}
55 %This should be converted into a two arg form so we can have different fonts for different parts
56 \newcommand*{\programopt}[1]{#1}
57
58 \newenvironment{bigdef}[1]{%
59
60 \noindent
61 \setlength{\hangindent}{2cm}
62 \textbf{#1}
63
64 \setlength{\hangindent}{1cm}%
65 \setlength{\hangafter}{0}%
66 \noindent%
67 }%
68 {%
69
70 \vspace{0.5cm}
71 }
72
73 \newenvironment{classdesc}[2]{%
74 \begin{bigdef}{class #1}}{\end{bigdef}}
75
76 \newenvironment{methoddesc}[3][{}]{%
77 \begin{bigdef}{#2(#3)}}{\end{bigdef}}
78 \newenvironment{funcdesc}[2]{%
79 \begin{bigdef}{#1(#2)}%
80 }
81 {%
82 \end{bigdef}
83 }
84
85 % {
86 % \begin{bigdef}[#1(#2)]
87 % \noindent
88 % \setlength{\hangindent}{2cm}
89 % \textbf{#1(#2)}
90 %
91 % }
92 % \setlength{\hangindent}{1cm}
93 % \setlength{\hangafter}{0}
94 % \noindent
95 % }%
96 % {%
97 %
98 % \mbox{}\\
99 % }
100
101 \setlength{\itemindent}{-1cm}\setlength{\leftmargin}{1cm}
102
103 \newenvironment{memberdesc}[2][{}]{\begin{description}\item[\textbf{#2}]\mbox{}\\}{\end{description}}
104 \newenvironment{datadesc}[1]{\begin{description}\item[\textbf{#1}]\mbox{}\\}{\end{description}}
105
106 \newcommand{\file}[1]{\texttt{#1}\xspace}
107 \newcommand{\program}[1]{\textbf{\texttt{#1}}\xspace}
108 % \newcommand{\env}[1]{\texttt{#1}\xspace}
109 \newcommand{\var}[1]{\texttt{#1}\xspace}
110 \newcommand{\kbd}[1]{\texttt{#1}}
111 \newcommand{\function}[1]{\texttt{#1}}
112 \newcommand{\class}[1]{\texttt{#1}}
113 \newcommand{\constant}[1]{\textsl{#1}}
114 \newcommand{\method}[1]{\texttt{#1}}
115 \newcommand{\member}[1]{\texttt{#1}}
116 \newcommand{\code}[1]{%
117 \ifmmode%
118 \mbox{\texttt{#1}}%
119 \else%
120 \texttt{#1}%
121 \fi % Because people try to put code in maths mode
122 }
123
124 \newenvironment{abstract}{\newpage\mbox{}\vfill\begin{center}\textbf{Abstract}\end{center}}{\vfill\newpage}
125
126 \newcommand{\authoraddress}[1]{\gdef \@authoraddress {#1}}
127
128 \newcommand{\release}[1]{\gdef \@ESreleasename {#1}}
129 \release{nightly} %Just so we have a default
130
131 \newcommand*{\subtitleLineOne}{\textsl{Release - \@ESreleasename}}
132 \newcommand*{\subtitleLineTwo}{\textsl{(r\RepVersion)}}
133
134 \renewcommand{\maketitle}{
135 \begin{titlepage}
136 \textsf{
137 \begin{raggedleft}
138 \Huge
139 \hrule
140 \mbox{}\\
141 \mbox{}\\
142 \@title
143 \mbox{}\\
144 \LARGE
145 \mbox{}\\
146 \subtitleLineOne\\
147 \subtitleLineTwo\\
148 \vfill
149 \@author
150 \vfill
151 \vfill
152 \large
153 \@date\\
154 \vfill
155 \@authoraddress\mbox{}\\
156 \end{raggedleft}
157 }
158 \end{titlepage}}
159
160 \newcommand{\esysappendix}{%
161 \appendix%
162 \renewcommand*{\theHchapter}{\Alph{chapter}} %How latex generates chapters
163 \renewcommand*{\thechapter}{\Alph{chapter}} %How hyperref generates chapters
164 }
165
166
167

Properties

Name Value
svn:mergeinfo /branches/lapack2681/doc/user/esysdoc.cls:2682-2741 /branches/restext/doc/user/esysdoc.cls:2610-2624 /branches/stage3.0/doc/user/esysdoc.cls:2569-2590 /release/3.0/doc/user/esysdoc.cls:2591-2601

  ViewVC Help
Powered by ViewVC 1.1.26