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

Diff of /trunk/doc/esysdoc.cls

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

trunk/doc/user/esysdoc.cls revision 3294 by jfenwick, Fri Oct 22 01:15:56 2010 UTC trunk/doc/esysdoc.cls revision 3310 by jfenwick, Tue Oct 26 03:58:17 2010 UTC
# Line 8  Line 8 
8    
9  \usepackage[a4paper, left=2.5cm, right=2.5cm, nohead, vcentering, scale=0.8]{geometry}  \usepackage[a4paper, left=2.5cm, right=2.5cm, nohead, vcentering, scale=0.8]{geometry}
10  \usepackage{times}  \usepackage{times}
 % \usepackage{fancyvrb} % Hopefully this will give us our code environments  
11  \usepackage{listings}  \usepackage{listings}
12  \usepackage{ifpdf}  \usepackage{ifpdf}
13    \usepackage{makeidx}
14    
15  %\usepackage{avant}  %\usepackage{avant}
16  %\renewcommand{\familydefault}{\sfdefault}  % Switch to san seriff  %\renewcommand{\familydefault}{\sfdefault}  % Switch to san seriff
17  \usepackage{url}  \usepackage{url}
18  \usepackage{xspace}  \usepackage{xspace}
19  \usepackage{graphicx,color}  \usepackage{graphicx}
20  \usepackage{amsmath}    %For equation*  \usepackage{amsmath}    %For equation*
21  \usepackage{amsfonts,amssymb} % see http://www.ams.org/tex/amslatex.html  \usepackage{amsfonts,amssymb} % see http://www.ams.org/tex/amslatex.html
22  \usepackage[nohyphen, strings]{underscore}  \usepackage[nohyphen, strings]{underscore}
# Line 24  Line 24 
24  %Blue was chosen here because it looks ok when printed  %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}  \usepackage[pdfborder={0 0 0},pdfdisplaydoctitle=true,linktocpage=false, colorlinks=true,linkcolor=blue,citecolor=blue,urlcolor=blue]{hyperref}
26    
27    %Dummy commands for if we ever need to switch off hyperref
28    % \providecommand{\pdfbookmark}[3][0]{}
29    % \providecommand{\currentpdfbookmark}[2]{}
30    % \providecommand{\subpdfbookmark}[2]{}
31    
32    
33  \usepackage{fancyhdr}  \usepackage{fancyhdr}
34  \renewcommand{\footrulewidth}{0.4pt}  \renewcommand{\footrulewidth}{0.4pt}
35  \renewcommand{\headrulewidth}{0pt}  \renewcommand{\headrulewidth}{0pt}
# Line 42  Line 48 
48  \ChNameVar{\raggedleft\large\sffamily}  % The word chapter  \ChNameVar{\raggedleft\large\sffamily}  % The word chapter
49  \ChNumVar{\raggedleft\bfseries\Large}   % The number of the chapter  \ChNumVar{\raggedleft\bfseries\Large}   % The number of the chapter
50  \ChTitleVar{\raggedleft \Huge\sffamily} % title of the chapter  \ChTitleVar{\raggedleft \Huge\sffamily} % title of the chapter
51    \ChTitleAsIs
52    
53  %Ensures that latex doesn't have an error if we don't specify the version  %Ensures that latex doesn't have an error if we don't specify the version
54  \providecommand{\RepVersion}{Unknown\xspace}  \providecommand{\RepVersion}{Unknown\xspace}
# Line 54  Line 61 
61  %This should be converted into a two arg form so we can have different fonts for different parts  %This should be converted into a two arg form so we can have different fonts for different parts
62  \newcommand*{\programopt}[1]{#1}  \newcommand*{\programopt}[1]{#1}
63    
64  \newenvironment{classdesc}[3]{\begin{description}\item[class #1]\mbox{}\\}{\end{description}}  \newenvironment{bigdef}[1]{%
65  \newenvironment{methoddesc}[3][{}]{\begin{description}\item[\textbf{#2}(#3)]\mbox{}\\}{\end{description}}  
66  \newenvironment{funcdesc}[2]{\begin{description}\item[\textbf{#1}(#2)]\mbox{}\\}{\end{description}}  \noindent
67    \setlength{\hangindent}{2cm}
68    \textbf{#1}
69    
70    \setlength{\hangindent}{1cm}%
71    \setlength{\hangafter}{0}%
72    \noindent%
73    }%
74    {%
75    
76    \vspace{0.5cm}
77    }
78    
79    \newenvironment{classdesc}[2]{%
80    \begin{bigdef}{class #1(#2)}}{\end{bigdef}}
81    
82    \newenvironment{methoddesc}[3][{}]{%
83    \begin{bigdef}{#2(#3)}}{\end{bigdef}}
84    \newenvironment{funcdesc}[2]{%
85    \begin{bigdef}{#1(#2)}%
86    }
87    {%
88    \end{bigdef}
89    }
90    
91    % {
92    % \begin{bigdef}[#1(#2)]
93    % \noindent
94    % \setlength{\hangindent}{2cm}
95    % \textbf{#1(#2)}
96    %
97    % }
98    % \setlength{\hangindent}{1cm}
99    % \setlength{\hangafter}{0}
100    % \noindent
101    % }%
102    % {%
103    %
104    % \mbox{}\\
105    % }
106    
107    \setlength{\itemindent}{-1cm}\setlength{\leftmargin}{1cm}
108    
109  \newenvironment{memberdesc}[2][{}]{\begin{description}\item[\textbf{#2}]\mbox{}\\}{\end{description}}  \newenvironment{memberdesc}[2][{}]{\begin{description}\item[\textbf{#2}]\mbox{}\\}{\end{description}}
110  \newenvironment{datadesc}[1]{\begin{description}\item[\textbf{#1}]\mbox{}\\}{\end{description}}  \newenvironment{datadesc}[1]{\begin{description}\item[\textbf{#1}]\mbox{}\\}{\end{description}}
111    
# Line 70  Line 119 
119  \newcommand{\constant}[1]{\textsl{#1}}  \newcommand{\constant}[1]{\textsl{#1}}
120  \newcommand{\method}[1]{\texttt{#1}}  \newcommand{\method}[1]{\texttt{#1}}
121  \newcommand{\member}[1]{\texttt{#1}}  \newcommand{\member}[1]{\texttt{#1}}
122  \newcommand{\code}[1]{\mbox{\texttt{#1}}}   % Because people try to put code in maths mode  \newcommand{\code}[1]{%
123    \ifmmode%
124    \mbox{\texttt{#1}}%
125    \else%
126    \texttt{#1}%
127    \fi    % Because people try to put code in maths mode
128    }
129    
130  \newenvironment{abstract}{\newpage\mbox{}\vfill\begin{center}\textbf{Abstract}\end{center}}{\vfill\newpage}  \newenvironment{abstract}{\newpage\mbox{}\vfill\begin{center}\textbf{Abstract}\end{center}}{\vfill\newpage}
131    
# Line 85  Line 139 
139    
140  \renewcommand{\maketitle}{  \renewcommand{\maketitle}{
141  \begin{titlepage}  \begin{titlepage}
142    \pdfbookmark[0]{Title page}{title}
143  \textsf{  \textsf{
144  \begin{raggedleft}  \begin{raggedleft}
145  \Huge  \Huge
# Line 109  Line 164 
164  }  }
165  \end{titlepage}}  \end{titlepage}}
166    
167    \newcommand{\esysappendix}{%
168    \appendix%
169    \renewcommand*{\theHchapter}{\Alph{chapter}}    %How latex generates chapters
170    \renewcommand*{\thechapter}{\Alph{chapter}} %How hyperref generates chapters
171    }
172    
173  %Please do not use this one  \newcommand{\etableofcontents}{\pdfbookmark[0]{Contents}{cont}\tableofcontents}
 \newcommand*{\strong}{}  
174    
175    
176    

Legend:
Removed from v.3294  
changed lines
  Added in v.3310

  ViewVC Help
Powered by ViewVC 1.1.26