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

Diff of /trunk/doc/esysdoc.cls

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

revision 3293 by caltinay, Thu Oct 21 23:18:32 2010 UTC revision 3302 by jfenwick, Mon Oct 25 01:50:07 2010 UTC
# Line 6  Line 6 
6  \ProvidesClass{esysdoc}  \ProvidesClass{esysdoc}
7  \LoadClass[a4paper, twoside]{book}  \LoadClass[a4paper, twoside]{book}
8    
9  \usepackage[a4paper, left=2.5cm, right=2.5cm]{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}
13    
14  %\usepackage{avant}  %\usepackage{avant}
15  \renewcommand{\familydefault}{\sfdefault}   % Switch to san seriff  %\renewcommand{\familydefault}{\sfdefault}  % Switch to san seriff
16  \usepackage{url}  \usepackage{url}
17  \usepackage{xspace}  \usepackage{xspace}
18  \usepackage{graphicx,color}  \usepackage{graphicx,color}
19  \usepackage{amsmath}    %For equation*  \usepackage{amsmath}    %For equation*
20  \usepackage{amsfonts,amssymb} % see http://www.ams.org/tex/amslatex.html  \usepackage{amsfonts,amssymb} % see http://www.ams.org/tex/amslatex.html
21  \usepackage[nohyphen, strings]{underscore}  \usepackage[nohyphen, strings]{underscore}
 \usepackage[colorlinks=false,pdfborder={0 0 0},pdfdisplaydoctitle=true,linktocpage=true]{hyperref}  
   
 %Ensures that latex doesn't have an error if we don't specify the version  
 \providecommand{\RepVersion}{Unknown\xspace}  
   
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    
 %This is FAR from perfect for one thing it doesn't allow underscores to be used in filenames  
   
 %Now we mess with the underscore char  
 % {  
 % \catcode`|=8   % Since we will be redefining _ we need another way to indicate subscript in math mode  
 %                % This change only holds for the definition since it disappears at the close brace  
 % \catcode`_=\active    % define _ as a char which triggers a macro (which is what active means)  
 % \gdef\_{%     % A global definition (persists after } ) for _ when it is a macro  
 % \ifmmode |        % If we are in math mode, then output subscript char  
 % \else  
 % \textunderscore       % else output underscore symbol  
 % \fi  
 % }  
 % }  
 % \catcode`_=\active    % Set _ to active at the top level  
26    
27    \usepackage{fancyhdr}
28    \renewcommand{\footrulewidth}{0.4pt}
29    \renewcommand{\headrulewidth}{0pt}
30    
31  % \newcommand*{\module}[1]{\texttt{#1}}  \fancypagestyle{plain}{%
32  % \newcommand*{\class}[1]{\texttt{#1}}  \fancyhead{}
33  % \newcommand*{\var}[1]{\textsl{#1}}  \cfoot{}
34  % \newcommand*{\method}[1]{\texttt{#1}}  \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  %Use the \Var form if you need to include % in the URL  %Ensures that latex doesn't have an error if we don't specify the version
48  %Please note that the \Var form does not work in maths mode  \providecommand{\RepVersion}{Unknown\xspace}
 % \DeclareUrlCommand\Var{}  
 %Same here with \function except \Function is already in use for a FunctionSpace  
 % \DeclareUrlCommand\FunctionName{}  
49    
 % \DeclareUrlCommand\umodule{}  
 % \DeclareUrlCommand\class{}  
 % \DeclareUrlCommand\method{}  
50  \DeclareUrlCommand\email{}  \DeclareUrlCommand\email{}
 % \DeclareUrlCommand\program{}  
 % \DeclareUrlCommand\env{}  
51    
52    \newcommand{\module}[1]{\mbox{\texttt{#1}}}
53    
54  % \DeclareUrlCommand\member{}  \newcommand*{\optional}[1]{[ #1 ]}
55  % \DeclareUrlCommand\file{}  %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  % \DeclareUrlCommand\kbd{}  \newenvironment{bigdef}[1]{%
59    \noindent
60    \setlength{\hangindent}{2cm}
61    \textbf{#1}
62    
63    \setlength{\hangindent}{1cm}%
64    \setlength{\hangafter}{0}%
65    \noindent%
66    }%
67    {%
68    
69  % \DeclareUrlCommand\usafe{}    %intended as a wrapper to make stuff underscrore safe  \vspace{0.5cm}
70  % \DeclareUrlCommand\constant{}  }
71    
72  %To safely deal with a module that has _ in its name do this:  \newenvironment{classdesc}[2]{%
73  % \urldef{\rMATPLOTLIB}\umodule{matplotlib}  \begin{bigdef}{class #1}}{\end{bigdef}}
 % \newcommand{\MATPLOTLIB}{\rMATPLOTLIB\index{visualization!matplotlib}\index{matplotlib}\xspace}  
74    
75  \newcommand{\module}[1]{\mbox{\texttt{#1}}}  \newenvironment{methoddesc}[3][{}]{%
76    \begin{bigdef}{#2(#3)}}{\end{bigdef}}
77    \newenvironment{funcdesc}[2]{%
78    \begin{bigdef}{#1(#2)}%
79    }
80    {%
81    \end{bigdef}
82    }
83    
84  \newcommand*{\optional}[1]{[ #1 ]}  % {
85  %This should be converted into a two arg form so we can have different fonts for different parts  % \begin{bigdef}[#1(#2)]
86  \newcommand*{\programopt}[1]{#1}  % \noindent
87    % \setlength{\hangindent}{2cm}
88    % \textbf{#1(#2)}
89    %
90    % }
91    % \setlength{\hangindent}{1cm}
92    % \setlength{\hangafter}{0}
93    % \noindent
94    % }%
95    % {%
96    %
97    % \mbox{}\\
98    % }
99    
100    \setlength{\itemindent}{-1cm}\setlength{\leftmargin}{1cm}
101    
 \newenvironment{classdesc}[3]{\begin{description}\item[class #1]\mbox{}\\}{\end{description}}  
 \newenvironment{methoddesc}[3][{}]{\begin{description}\item[\textbf{#2}(#3)]\mbox{}\\}{\end{description}}  
 \newenvironment{funcdesc}[2]{\begin{description}\item[\textbf{#1}(#2)]\mbox{}\\}{\end{description}}  
102  \newenvironment{memberdesc}[2][{}]{\begin{description}\item[\textbf{#2}]\mbox{}\\}{\end{description}}  \newenvironment{memberdesc}[2][{}]{\begin{description}\item[\textbf{#2}]\mbox{}\\}{\end{description}}
103  \newenvironment{datadesc}[1]{\begin{description}\item[\textbf{#1}]\mbox{}\\}{\end{description}}  \newenvironment{datadesc}[1]{\begin{description}\item[\textbf{#1}]\mbox{}\\}{\end{description}}
104    
# Line 97  Line 112 
112  \newcommand{\constant}[1]{\textsl{#1}}  \newcommand{\constant}[1]{\textsl{#1}}
113  \newcommand{\method}[1]{\texttt{#1}}  \newcommand{\method}[1]{\texttt{#1}}
114  \newcommand{\member}[1]{\texttt{#1}}  \newcommand{\member}[1]{\texttt{#1}}
115  \newcommand{\code}[1]{\mbox{\texttt{#1}}}   % Because people try to put code in maths mode  \newcommand{\code}[1]{%
116    \ifmmode%
117    \mbox{\texttt{#1}}%
118    \else%
119    \texttt{#1}%
120    \fi    % Because people try to put code in maths mode
121    }
122    
123  \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}
124    
# Line 112  Line 132 
132    
133  \renewcommand{\maketitle}{  \renewcommand{\maketitle}{
134  \begin{titlepage}  \begin{titlepage}
135    \textsf{
136  \begin{raggedleft}  \begin{raggedleft}
137  \Huge  \Huge
138  \hrule  \hrule
# Line 132  Line 153 
153  \vfill  \vfill
154  \@authoraddress\mbox{}\\  \@authoraddress\mbox{}\\
155  \end{raggedleft}  \end{raggedleft}
156    }
157  \end{titlepage}}  \end{titlepage}}
158    
159    \newcommand{\esysappendix}{%
160  %Please do not use this one  \appendix%
161  \newcommand*{\strong}{}  \renewcommand*{\theHchapter}{\Alph{chapter}}    %How latex generates chapters
162    \renewcommand*{\thechapter}{\Alph{chapter}} %How hyperref generates chapters
 \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}}  
163  }  }
 \pagestyle{plain}  
164    
165  \usepackage[Bjarne]{fncychap}  
166    

Legend:
Removed from v.3293  
changed lines
  Added in v.3302

  ViewVC Help
Powered by ViewVC 1.1.26