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

Diff of /trunk/doc/user/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 3300 by jfenwick, Mon Oct 25 00:22:14 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    
26    \usepackage{fancyhdr}
27    \renewcommand{\footrulewidth}{0.4pt}
28    \renewcommand{\headrulewidth}{0pt}
29    
30  %This is FAR from perfect for one thing it doesn't allow underscores to be used in filenames  \fancypagestyle{plain}{%
31    \fancyhead{}
32  %Now we mess with the underscore char  \cfoot{}
33  % {  \fancyfoot[LE,RO]{\thepage} %left on even pages right on odd pages
34  % \catcode`|=8   % Since we will be redefining _ we need another way to indicate subscript in math mode  \fancyfoot[RE]{\nouppercase{\rightmark}}
35  %                % This change only holds for the definition since it disappears at the close brace  \fancyfoot[LO]{\nouppercase{\leftmark}}
36  % \catcode`_=\active    % define _ as a char which triggers a macro (which is what active means)  }
37  % \gdef\_{%     % A global definition (persists after } ) for _ when it is a macro  \pagestyle{plain}
 % \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  
   
   
 % \newcommand*{\module}[1]{\texttt{#1}}  
 % \newcommand*{\class}[1]{\texttt{#1}}  
 % \newcommand*{\var}[1]{\textsl{#1}}  
 % \newcommand*{\method}[1]{\texttt{#1}}  
   
   
 %Use the \Var form if you need to include % in the URL  
 %Please note that the \Var form does not work in maths mode  
 % \DeclareUrlCommand\Var{}  
 %Same here with \function except \Function is already in use for a FunctionSpace  
 % \DeclareUrlCommand\FunctionName{}  
   
 % \DeclareUrlCommand\umodule{}  
 % \DeclareUrlCommand\class{}  
 % \DeclareUrlCommand\method{}  
 \DeclareUrlCommand\email{}  
 % \DeclareUrlCommand\program{}  
 % \DeclareUrlCommand\env{}  
   
   
 % \DeclareUrlCommand\member{}  
 % \DeclareUrlCommand\file{}  
38    
39  % \DeclareUrlCommand\kbd{}  \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    \ChTitleAsIs
45    
46  % \DeclareUrlCommand\usafe{}    %intended as a wrapper to make stuff underscrore safe  %Ensures that latex doesn't have an error if we don't specify the version
47  % \DeclareUrlCommand\constant{}  \providecommand{\RepVersion}{Unknown\xspace}
48    
49  %To safely deal with a module that has _ in its name do this:  \DeclareUrlCommand\email{}
 % \urldef{\rMATPLOTLIB}\umodule{matplotlib}  
 % \newcommand{\MATPLOTLIB}{\rMATPLOTLIB\index{visualization!matplotlib}\index{matplotlib}\xspace}  
50    
51  \newcommand{\module}[1]{\mbox{\texttt{#1}}}  \newcommand{\module}[1]{\mbox{\texttt{#1}}}
52    
# Line 81  Line 54 
54  %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
55  \newcommand*{\programopt}[1]{#1}  \newcommand*{\programopt}[1]{#1}
56    
57  \newenvironment{classdesc}[3]{\begin{description}\item[class #1]\mbox{}\\}{\end{description}}  \newenvironment{classdesc}[2]{\begin{description}\item[class #1]\mbox{}\\}{\end{description}}
58  \newenvironment{methoddesc}[3][{}]{\begin{description}\item[\textbf{#2}(#3)]\mbox{}\\}{\end{description}}  \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}}  \newenvironment{funcdesc}[2]{%
60    \noindent
61    \begin{list}{}{\setlength{\labelwidth}{0cm}}
62    \item \textbf{#1(#2)}
63    \end{list}
64    \begin{list}{}{}
65    \item
66    }%
67    {%
68    \end{list}%
69    }
70    
71    \setlength{\itemindent}{-1cm}\setlength{\leftmargin}{1cm}
72    
73  \newenvironment{memberdesc}[2][{}]{\begin{description}\item[\textbf{#2}]\mbox{}\\}{\end{description}}  \newenvironment{memberdesc}[2][{}]{\begin{description}\item[\textbf{#2}]\mbox{}\\}{\end{description}}
74  \newenvironment{datadesc}[1]{\begin{description}\item[\textbf{#1}]\mbox{}\\}{\end{description}}  \newenvironment{datadesc}[1]{\begin{description}\item[\textbf{#1}]\mbox{}\\}{\end{description}}
75    
# Line 97  Line 83 
83  \newcommand{\constant}[1]{\textsl{#1}}  \newcommand{\constant}[1]{\textsl{#1}}
84  \newcommand{\method}[1]{\texttt{#1}}  \newcommand{\method}[1]{\texttt{#1}}
85  \newcommand{\member}[1]{\texttt{#1}}  \newcommand{\member}[1]{\texttt{#1}}
86  \newcommand{\code}[1]{\mbox{\texttt{#1}}}   % Because people try to put code in maths mode  \newcommand{\code}[1]{%
87    \ifmmode%
88    \mbox{\texttt{#1}}%
89    \else%
90    \texttt{#1}%
91    \fi    % Because people try to put code in maths mode
92    }
93    
94  \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}
95    
# Line 112  Line 103 
103    
104  \renewcommand{\maketitle}{  \renewcommand{\maketitle}{
105  \begin{titlepage}  \begin{titlepage}
106    \textsf{
107  \begin{raggedleft}  \begin{raggedleft}
108  \Huge  \Huge
109  \hrule  \hrule
# Line 132  Line 124 
124  \vfill  \vfill
125  \@authoraddress\mbox{}\\  \@authoraddress\mbox{}\\
126  \end{raggedleft}  \end{raggedleft}
127    }
128  \end{titlepage}}  \end{titlepage}}
129    
130    
131  %Please do not use this one  %Please do not use this one
132  \newcommand*{\strong}{}  \newcommand*{\strong}{}
133    
 \usepackage{fancyhdr}  
 \renewcommand{\footrulewidth}{0.4pt}  
 \renewcommand{\headrulewidth}{0pt}  
134    
 \fancypagestyle{plain}{%  
 \fancyhead{}  
 \cfoot{}  
 \fancyfoot[LE,RO]{\thepage} %left on even pages right on odd pages  
 \fancyfoot[RE]{\nouppercase{\rightmark}}  
 \fancyfoot[LO]{\nouppercase{\leftmark}}  
 }  
 \pagestyle{plain}  
   
 \usepackage[Bjarne]{fncychap}  
135    

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

  ViewVC Help
Powered by ViewVC 1.1.26