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

Annotation of /trunk/doc/esysdoc.cls

Parent Directory Parent Directory | Revision Log Revision Log


Revision 4131 - (hide annotations)
Fri Jan 11 03:54:16 2013 UTC (6 years, 9 months ago) by gross
File size: 4321 byte(s)
documentaion of inversion driver API added.
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 3310 \usepackage{makeidx}
14 jfenwick 3292
15     %\usepackage{avant}
16 jfenwick 3294 %\renewcommand{\familydefault}{\sfdefault} % Switch to san seriff
17 jfenwick 3292 \usepackage{url}
18     \usepackage{xspace}
19 caltinay 3306 \usepackage{graphicx}
20 jfenwick 3292 \usepackage{amsmath} %For equation*
21     \usepackage{amsfonts,amssymb} % see http://www.ams.org/tex/amslatex.html
22     \usepackage[nohyphen, strings]{underscore}
23    
24 jfenwick 3294 %Blue was chosen here because it looks ok when printed
25 caltinay 4057 \usepackage[pdfborder={0 0 0},pdfdisplaydoctitle=true,linktocpage=false, colorlinks=true,linkcolor=blue,citecolor=blue,urlcolor=blue,pdfusetitle]{hyperref}
26 jfenwick 3292
27 jfenwick 3310 %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 jfenwick 3302
32 jfenwick 3310
33 jfenwick 3294 \usepackage{fancyhdr}
34     \renewcommand{\footrulewidth}{0.4pt}
35     \renewcommand{\headrulewidth}{0pt}
36 jfenwick 3292
37 jfenwick 3294 \fancypagestyle{plain}{%
38     \fancyhead{}
39     \cfoot{}
40     \fancyfoot[LE,RO]{\thepage} %left on even pages right on odd pages
41     \fancyfoot[RE]{\nouppercase{\rightmark}}
42     \fancyfoot[LO]{\nouppercase{\leftmark}}
43     }
44     \pagestyle{plain}
45 jfenwick 3292
46 jfenwick 3294 \usepackage[Bjarne]{fncychap}
47     % \ChRuleWidth{1pt}
48     \ChNameVar{\raggedleft\large\sffamily} % The word chapter
49     \ChNumVar{\raggedleft\bfseries\Large} % The number of the chapter
50     \ChTitleVar{\raggedleft \Huge\sffamily} % title of the chapter
51 jfenwick 3295 \ChTitleAsIs
52 jfenwick 3292
53 jfenwick 3294 %Ensures that latex doesn't have an error if we don't specify the version
54     \providecommand{\RepVersion}{Unknown\xspace}
55 jfenwick 3292
56     \DeclareUrlCommand\email{}
57    
58     \newcommand{\module}[1]{\mbox{\texttt{#1}}}
59    
60     \newcommand*{\optional}[1]{[ #1 ]}
61     %This should be converted into a two arg form so we can have different fonts for different parts
62     \newcommand*{\programopt}[1]{#1}
63    
64 jfenwick 3301 \newenvironment{bigdef}[1]{%
65 jfenwick 3305
66 caltinay 4095 \vspace{1em}
67     \setlength{\hangindent}{2cm}%
68     \raggedright\textbf{#1}
69 jfenwick 3301
70     \setlength{\hangindent}{1cm}%
71     \setlength{\hangafter}{0}%
72 jfenwick 3300 }%
73     {%
74 jfenwick 3301
75 jfenwick 3300 }
76    
77 jfenwick 3301 \newenvironment{classdesc}[2]{%
78 caltinay 3306 \begin{bigdef}{class #1(#2)}}{\end{bigdef}}
79 gross 4131 \newenvironment{classdesc*}[1]{%
80     \begin{bigdef}{class #1}}{\end{bigdef}}
81 jfenwick 3301
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 jfenwick 3300 \setlength{\itemindent}{-1cm}\setlength{\leftmargin}{1cm}
108    
109 jfenwick 3292 \newenvironment{memberdesc}[2][{}]{\begin{description}\item[\textbf{#2}]\mbox{}\\}{\end{description}}
110     \newenvironment{datadesc}[1]{\begin{description}\item[\textbf{#1}]\mbox{}\\}{\end{description}}
111    
112     \newcommand{\file}[1]{\texttt{#1}\xspace}
113     \newcommand{\program}[1]{\textbf{\texttt{#1}}\xspace}
114     % \newcommand{\env}[1]{\texttt{#1}\xspace}
115     \newcommand{\var}[1]{\texttt{#1}\xspace}
116     \newcommand{\kbd}[1]{\texttt{#1}}
117     \newcommand{\function}[1]{\texttt{#1}}
118     \newcommand{\class}[1]{\texttt{#1}}
119 gross 4131 \newcommand{\exception}[1]{\texttt{#1}}
120 jfenwick 3292 \newcommand{\constant}[1]{\textsl{#1}}
121     \newcommand{\method}[1]{\texttt{#1}}
122     \newcommand{\member}[1]{\texttt{#1}}
123 jfenwick 3295 \newcommand{\code}[1]{%
124     \ifmmode%
125     \mbox{\texttt{#1}}%
126     \else%
127     \texttt{#1}%
128     \fi % Because people try to put code in maths mode
129     }
130 jfenwick 3292
131     \newenvironment{abstract}{\newpage\mbox{}\vfill\begin{center}\textbf{Abstract}\end{center}}{\vfill\newpage}
132    
133     \newcommand{\authoraddress}[1]{\gdef \@authoraddress {#1}}
134    
135     \newcommand{\release}[1]{\gdef \@ESreleasename {#1}}
136     \release{nightly} %Just so we have a default
137    
138     \newcommand*{\subtitleLineOne}{\textsl{Release - \@ESreleasename}}
139     \newcommand*{\subtitleLineTwo}{\textsl{(r\RepVersion)}}
140    
141     \renewcommand{\maketitle}{
142     \begin{titlepage}
143 jfenwick 3310 \pdfbookmark[0]{Title page}{title}
144 jfenwick 3294 \textsf{
145 jfenwick 3292 \begin{raggedleft}
146     \Huge
147     \hrule
148     \mbox{}\\
149     \mbox{}\\
150     \@title
151     \mbox{}\\
152     \LARGE
153     \mbox{}\\
154     \subtitleLineOne\\
155     \subtitleLineTwo\\
156     \vfill
157     \@author
158     \vfill
159     \vfill
160     \large
161     \@date\\
162     \vfill
163     \@authoraddress\mbox{}\\
164     \end{raggedleft}
165 jfenwick 3294 }
166 jfenwick 3292 \end{titlepage}}
167    
168 jfenwick 3302 \newcommand{\esysappendix}{%
169     \appendix%
170     \renewcommand*{\theHchapter}{\Alph{chapter}} %How latex generates chapters
171     \renewcommand*{\thechapter}{\Alph{chapter}} %How hyperref generates chapters
172     }
173 jfenwick 3292

Properties

Name Value
svn:mergeinfo /branches/lapack2681/doc/user/esysdoc.cls:2682-2741 /branches/pasowrap/doc/esysdoc.cls:3661-3674 /branches/py3_attempt2/doc/esysdoc.cls:3871-3891 /branches/restext/doc/user/esysdoc.cls:2610-2624 /branches/ripleygmg_from_3668/doc/esysdoc.cls:3669-3791 /branches/stage3.0/doc/user/esysdoc.cls:2569-2590 /branches/symbolic_from_3470/doc/esysdoc.cls:3471-3974 /branches/symbolic_from_3470/ripley/test/python/doc/esysdoc.cls:3517-3974 /release/3.0/doc/user/esysdoc.cls:2591-2601 /trunk/ripley/test/python/doc/esysdoc.cls:3480-3515

  ViewVC Help
Powered by ViewVC 1.1.26