OpenCores
URL https://opencores.org/ocsvn/avs_aes/avs_aes/trunk

Subversion Repositories avs_aes

[/] [avs_aes/] [trunk/] [doc/] [manual/] [src/] [ruschidoc.cls] - Blame information for rev 11

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 11 ruschi
\NeedsTeXFormat{LaTeX2e}
2
\ProvidesClass{ruschidoc}
3
\LoadClass[11pt,a4paper,twoside]{article}
4
\RequirePackage[intlimits,sumlimits]{amsmath}
5
\RequirePackage{amssymb}
6
\RequirePackage{amsfonts}
7
\RequirePackage{fancyhdr}
8
\RequirePackage[T1]{fontenc}
9
\RequirePackage[latin1]{inputenc}
10
\RequirePackage{amsmath}
11
\RequirePackage{helvet}
12
\RequirePackage[amssymb]{SIunits}
13
\RequirePackage[helvet]{sfmath}
14
\RequirePackage{lastpage}
15
\RequirePackage{tabularx}
16
\RequirePackage{multirow}
17
\RequirePackage{listings}
18
\RequirePackage{textcomp}
19
 
20
%% Some packages need special options for PDFtex
21
\RequirePackage{ifpdf}
22
\ifpdf
23
        \RequirePackage[pdftex]{color}
24
        \RequirePackage[pdftex]{graphics}
25
        \DeclareGraphicsExtensions{.pdf, .png, .jpg}
26
\else
27
        \RequirePackage{color}
28
        \RequirePackage{graphics}
29
        \DeclareGraphicsExtensions{.eps, .ps}
30
\fi
31
\graphicspath{{figs/}}
32
\RequirePackage{graphicx}
33
\RequirePackage{subfigure}
34
\RequirePackage{psfrag}
35
\RequirePackage{colortbl}
36
 
37
% ************************ Page layout ************************
38
\topmargin          -20mm
39
\headheight             30mm
40
\headsep                6mm
41
\footskip                       11mm
42
\oddsidemargin  2mm
43
\evensidemargin         2mm
44
\marginparsep           145mm
45
\marginparwidth         8mm
46
\textwidth              162mm
47
\textheight             225mm
48
\parindent              0mm
49
\parskip                        3mm
50
 
51
%Floats (tables, figures)
52
% http://www.eng.cam.ac.uk/help/tpl/textprocessing/squeeze.html
53
\floatsep                       10mm
54
\intextsep                      2ex
55
\textfloatsep           10pt
56
\abovecaptionskip 5pt
57
\belowcaptionskip 5pt
58
% Section and subsection are de-idented (text body is idented)
59
\def\@secindent{8mm}
60
% how wide is the header
61
\def\@htwidth{172mm}
62
 
63
%colors
64
\definecolor{lightgrey}{rgb}{0.95,0.95,0.95}
65
 
66
%% Change the font
67
\renewcommand{\familydefault}{\sfdefault}
68
%% Make Registered Trademark symbol raised
69
\newcommand{\tm}{\textsuperscript{\texttrademark}}
70
\newcommand{\rtm}{\textsuperscript{\textregistered}}
71
\renewcommand{\copyright}{\textcopyright}
72
 
73
 
74
\setcounter{secnumdepth}{4}
75
\setcounter{tocdepth}{3}
76
\newlength\captionwidth
77
\setlength\captionwidth{13cm}
78
 
79
\renewcommand{\paragraph}[1]{\newpar{#1}\ \vspace{0.3cm}\\}
80
 
81
\renewcommand{\section}{\@startsection
82
{section}%                   % the name
83
{1}%                         % the level
84
{-\@secindent}%              % the indent
85
{-18pt}%
86
{6pt}%          % the after skip
87
{\Large\bf}}    % the style
88
 
89
\renewcommand{\subsection}{\@startsection
90
{subsection}%                   % the name
91
{1}%                         % the level
92
{-\@secindent}%                       % the indent
93
{-6pt}%
94
{6pt}%          % the after skip
95
{\large\bf}} % the style
96
 
97
\renewcommand{\subsubsection}{\@startsection
98
{subsubsection}%                   % the name
99
{1}%                         % the level
100
{-\@secindent}%                       % the indent
101
{-6pt}%
102
{6pt}%          % the after skip
103
{\bf}} % the style
104
 
105
 
106
 
107
 
108
% ************************ Date format ************************
109
\def\shorttoday{\ifcase\month\or
110
 Jan\or Feb\or Mar\or Apr\or May\or Jun\or Jul\or Aug\or
111
 Sep\or Oct\or Nov\or Dec\fi~\number\day, \number\year}
112
 
113
\def\shorttoday{\number\day-\ifcase\month\or
114
 Jan\or Feb\or Mar\or Apr\or May\or Jun\or Jul\or Aug\or
115
 Sep\or Oct\or Nov\or Dec\fi-\number\year}
116
 
117
\newcommand{\paddedday}{\ifnum\number\day<10 0\number\day\else \number\day\fi}
118
\newcommand{\paddedmonth}{\ifnum\number\month<10 0\number\month\else \number\month\fi}
119
 
120
\def\shorttoday{\number\year/\paddedmonth/\paddedday}
121
 
122
 
123
% ************************ Document Variables ************************
124
% main author
125
\newcommand*{\authorName}[1]{\def\@authorName{#1}}
126
\authorName{}
127
% Additional Authors
128
\newcommand*{\authorAddress}[1]{\def\@authorAddress{#1}}
129
\authorAddress{}
130
\newcommand*{\authorURL}[1]{\def\@authorURL{#1}}
131
\authorURL{}
132
\newcommand*{\authorEmail}[1]{\def\@authorEmail{#1}}
133
\authorEmail{}
134
% When was the document written/submitted (not compiled)
135
\newcommand*{\docDate}[1]{\def\@docDate{#1}}
136
\docDate{}
137
% unique identifier
138
\newcommand*{\docID}[1]{\def\@docID{#1}}
139
\docID{}
140
% type of document
141
\newcommand*{\docType}[1]{\def\@docType{#1}}
142
\docType{Technical Note}
143
% Title of the document
144
\newcommand*{\docTitle}[1]{\def\@docTitle{#1}}
145
\docTitle{}
146
% Title of the document
147
\newcommand*{\docSubtitle}[1]{\def\@docSubtitle{#1}}
148
\docSubtitle{}
149
% current revision
150
\newcommand*{\docRevision}[1]{\def\@docRevision{#1}}
151
\docRevision{0.1}
152
% Status Draft/revision/ final
153
\newcommand*{\docStatus}[1]{\def\@docStatus{#1}}
154
\docStatus{Draft}
155
% Who will receive the doc -- differnece to customers???
156
\newcommand*{\recipientList}[1]{\def\@recipientList{#1}}
157
% list of keywords
158
\newcommand*{\keywords}[1]{\def\@keywords{#1}}
159
\keywords{}
160
% list of revisions
161
\newcommand*{\revisionList}[1]{\def\@revisionList{#1}}
162
\revisionList{}
163
 
164
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
165
\newenvironment{CompactList}
166
{\begin{list}{}{
167
  \setlength{\leftmargin}{0.5cm}
168
  \setlength{\itemsep}{0pt}
169
  \setlength{\parsep}{0pt}
170
  \setlength{\topsep}{0pt}
171
  \renewcommand{\makelabel}{\hfill}}}
172
{\end{list}}
173
 
174
\newenvironment{CompactItemize}
175
{
176
  \begin{itemize}
177
  \setlength{\itemsep}{-3pt}
178
  \setlength{\parsep}{0pt}
179
  \setlength{\topsep}{0pt}
180
  \setlength{\partopsep}{0pt}
181
}
182
{\end{itemize}}
183
 
184
\newcommand{\entrylabel}[1]{
185
   {\parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}\vspace{1.5\baselineskip}}}}
186
 
187
\newcommand{\paragraphbreak}[1]{\paragraph{#1}\ \vspace{0.3cm}\\}
188
\newcommand{\subparagraphbreak}[1]{\subparagraph{#1}\ \vspace{0.3cm}\\}
189
 
190
\newenvironment{Desc}
191
{\begin{list}{}
192
  {
193
    \settowidth{\labelwidth}{40pt}
194
    \setlength{\leftmargin}{\labelwidth}
195
    \setlength{\parsep}{0pt}
196
    \setlength{\itemsep}{-4pt}
197
    \renewcommand{\makelabel}{\entrylabel}
198
  }
199
}
200
{\end{list}}
201
      \lstset{
202
            breaklines,
203
            tabsize=5,
204
            columns=flexible,
205
            extendedchars,
206
            xleftmargin=2em,
207
            basicstyle=\scriptsize\sffamily,
208
            showstringspaces=false,
209
            emptylines=*1,
210
            frame=single,
211
            literate={[]}{[{$\;$}]}3,
212
            captionpos=b
213
            backgroundcolor=\color{lightgrey}}
214
%\lstlistingname="Listing"
215
 
216
 
217
% ************************ Header/footer ************************
218
\pagestyle{fancy}
219
\renewcommand{\headrulewidth}{0.0pt}
220
\renewcommand{\footrulewidth}{0.0pt}
221
 
222
\fancyhead[O,E]{
223
 \leftskip-\@secindent
224
 \begin{tabularx}{185mm}{p{98mm}   p{45mm}  p{25mm}}
225
 \hskip2mm \sc{ \@docTitle } &    & \hskip2mm \thepage / \pageref{LastPage}
226
 \end{tabularx}
227
 \includegraphics[width=\@htwidth]{fancy_headsep_r}
228
}
229
 
230
 
231
 
232
 \fancyfoot{}
233
 \fancyfoot[ER,OL]{
234
   \tiny{All rights reserved - \copyright \number\year \ \@authorName}
235
 }
236
 \fancyfoot[EL,OR]{
237
   \tiny{\@docID \  (v. \@docRevision) - \@\shorttoday}
238
 }
239
 
240
 
241
\fancypagestyle{plain}{
242
   \renewcommand{\headrulewidth}{0.0pt}
243
   \renewcommand{\footrulewidth}{0.0pt}
244
   \fancyhead{}
245
   \fancyfoot[EL,OL]{}
246
   \renewcommand{\headrulewidth}{0pt}
247
 }
248
 
249
 
250
 
251
 
252
\renewenvironment{abstract}{
253
    \small
254
    \begin{center}
255
      {\bf\large \abstractname
256
          \vspace{-.5em}\vspace{\z@}}
257
    \end{center}
258
}
259
 
260
% ************************ Revision table *********************
261
\newcommand{ \revisionTable } {
262
    \section*{Change History}
263
        \begin{tabularx}{\textwidth} {| p{11mm} | p{14mm} | X | p{23mm} | p{32mm} |}
264
        \hline
265
        Rev. & Chapter & Description & Date & Reviewer \\
266
        \hline
267
        \@revisionList
268
        \hline
269
    \end{tabularx}
270
}
271
 
272
% ************************ Cover table ************************
273
\def\@maketitle{
274
         \vglue80mm
275
 %% Title
276
      \begin{minipage}{0.65\linewidth}
277
        \begin{flushleft}
278
           \Huge{\textbf{\sc{\@docTitle}}}
279
       \end{flushleft}
280
       \end{minipage}
281
%% fancy line
282
        \vskip4pt
283
        \leftskip-17mm
284
        \includegraphics[width=1.1\textwidth]{fancy_headsep_r}
285
        \vspace{3pt}
286
%% addess
287
        \vglue55mm
288
        \begin{tabularx}{\textwidth}{p{55mm} X p{65mm}}
289
      \begin{minipage}{60mm}
290
                \includegraphics[width=20mm]{logo}
291
      \end{minipage} &  &
292
      \begin{minipage}{62mm}
293
                \Large{\@authorName} \\
294
                \large{\@authorAddress}
295
      \end{minipage} \\
296
        & & \\
297
      \large{\@authorURL} & & \large{\@authorEmail}  \\
298
        \end{tabularx}
299
        \vspace{2ex}
300
}  %% End of maketitle

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.