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

Subversion Repositories s6soc

[/] [s6soc/] [trunk/] [doc/] [src/] [gqtekspec.cls] - Blame information for rev 40

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 7 dgisselq
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%/
2
%
3
%  Copyright (C) 2015, Gisselquist Technology, LLC
4
%
5
%  This template is free software: you can redistribute it and/or modify it
6
%  under the terms of the GNU General Public License as published by the
7
%  Free Software Foundation, either version 3 of the License, or (at your
8
%  option) any later version.
9
%
10
%  This template is distributed in the hope that it will be useful, but WITHOUT
11
%  ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or
12
%  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
13
%  for more details.
14
%
15
%  You should have received a copy of the GNU General Public License along
16
%  with this program.  If not, see  for a copy.
17
%
18
%  License:     GPL, v3, as defined and found on www.gnu.org,
19
%               http://www.gnu.org/licenses/gpl.html
20
%
21
%
22
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
23
% \NeedsTeXFormat{LaTeX2e}[1995/12/01]
24
\ProvidesClass{gqtekspec}[2015/03/03 v0.1 -- Gisselquist Technology Specification]
25
\typeout{by Dan Gisselquist}
26
\LoadClassWithOptions{report}
27
\usepackage{datetime}
28
\usepackage{graphicx}
29
\usepackage[dvips]{pstricks}
30
\usepackage{hhline}
31
\usepackage{colortbl}
32 40 dgisselq
\definecolor{webgreen}{rgb}{0,0.5,0}
33
\usepackage[dvips,colorlinks=true,linkcolor=webgreen]{hyperref}
34 7 dgisselq
\newdateformat{headerdate}{\THEYEAR/\twodigit{\THEMONTH}/\twodigit{\THEDAY}}
35
\setlength{\hoffset}{0.25in}
36
\setlength{\voffset}{-0.5in}
37
\setlength{\marginparwidth}{0in}
38
\setlength{\marginparsep}{0in}
39
\setlength{\textwidth}{6in}
40
\setlength{\oddsidemargin}{0in}
41
 
42
%    **************************************
43
%    *         APPENDIX                   *
44
%    **************************************
45
%
46
\newcommand\appfl@g{\appendixname}  %used to test \@chapapp
47
%
48
% \renewcommand\appendix{\par\clearpage
49
  % \setcounter{chapter}{0}%
50
  % \setcounter{section}{0}%
51
  % \renewcommand\@chapapp{\appendixname}%
52
  % \renewcommand\thechapter{\Alph{chapter}}
53
  % \if@nosectnum\else
54
    % \renewcommand\thesection{\Alph{chapter}.\arabic{section}}
55
  % \fi
56
% }
57
 
58
 
59
% FIGURE
60
%   redefine the @caption command to put a period after the figure or
61
%   table number in the lof and lot tables
62
\long\def\@caption#1[#2]#3{\par\addcontentsline{\csname
63
  ext@#1\endcsname}{#1}{\protect\numberline{\csname
64
  the#1\endcsname.}{\ignorespaces #2}}\begingroup
65
    \@parboxrestore
66
    \normalsize
67
    \@makecaption{\csname fnum@#1\endcsname}{\ignorespaces #3}\par
68
  \endgroup}
69
 
70
%    ****************************************
71
%    *         TABLE OF CONTENTS, ETC.      *
72
%    ****************************************
73
 
74
\renewcommand\contentsname{Contents}
75
\renewcommand\listfigurename{Figures}
76
\renewcommand\listtablename{Tables}
77
 
78
\newif\if@toc \@tocfalse
79
\renewcommand\tableofcontents{%
80
    \begingroup% temporarily set if@toc so that \@schapter will not
81
               % put Table of Contents in the table of contents.
82
      \@toctrue
83
      \chapter*{\contentsname}
84
    \endgroup
85
    \thispagestyle{gqtekspecplain}
86
 
87
    \baselineskip=10pt plus .5pt minus .5pt
88
 
89
    {\raggedleft Page \par\vskip-\parskip}
90
    \@starttoc{toc}%
91
    \baselineskip=\normalbaselineskip
92
  }
93
 
94
\def\l@appendix{\pagebreak[3]
95
 \vskip 1.0em plus 1pt % space above appendix line
96
  \@dottedtocline{0}{0em}{8em}}
97
 
98
\def\l@chapter{\pagebreak[3]
99
 \vskip 1.0em plus 1pt % space above appendix line
100
  \@dottedtocline{0}{0em}{4em}}
101
 
102
% \if@nosectnum\else
103
 %  \renewcommand\l@section{\@dottedtocline{1}{5.5em}{2.4em}}
104
  % \renewcommand\l@subsection{\@dottedtocline{2}{8.5em}{3.2em}}
105
  % \renewcommand\l@subsubsection{\@dottedtocline{3}{11em}{4.1em}}
106
  % \renewcommand\l@paragraph{\@dottedtocline{4}{13.5em}{5em}}
107
  % \renewcommand\l@subparagraph{\@dottedtocline{5}{16em}{6em}}
108
% \fi
109
 
110
% LIST OF FIGURES
111
%
112
\def\listoffigures{%
113
  \begingroup
114
  \chapter*{\listfigurename}%
115
  \endgroup
116
  \thispagestyle{gqtekspecplain}%
117
 
118
  \baselineskip=10pt plus .5pt minus .5pt%
119
 
120
  {\hbox to \hsize{Figure\hfil Page} \par\vskip-\parskip}%
121
 
122
  \rule[2mm]{\textwidth}{0.5mm}\par
123
 
124
  \@starttoc{lof}%
125
  \baselineskip=\normalbaselineskip}%
126
 
127
\def\l@figure{\@dottedtocline{1}{1em}{4.0em}}
128
 
129
% LIST OF TABLES
130
%
131
\def\listoftables{%
132
  \begingroup
133
  \chapter*{\listtablename}%
134
  \endgroup
135
  \thispagestyle{gqtekspecplain}%
136
  \baselineskip=10pt plus .5pt minus .5pt%
137
  {\hbox to \hsize{Table\hfil Page} \par\vskip-\parskip}%
138
 
139
  % Added line underneath headings, 20 Jun 01, Capt Todd Hale.
140
  \rule[2mm]{\textwidth}{0.5mm}\par
141
 
142
  \@starttoc{lot}%
143
  \baselineskip=\normalbaselineskip}%
144
 
145
\let\l@table\l@figure
146
 
147
%    ****************************************
148
%    *            PAGE STYLES               *
149
%    ****************************************
150
%
151
\def\ps@gqtekspectoc{%
152
      \let\@mkboth\@gobbletwo
153
      \def \@oddhead{}
154
      \def \@oddfoot{\rm
155
            \hfil\raisebox{-9pt}{\thepage}\hfil\thispagestyle{gqtekspectocn}}
156
      \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
157
\def\ps@gqtekspectocn{\let\@mkboth\@gobbletwo
158
      \def \@oddhead{\rm \hfil\raisebox{10pt}{Page}}
159
      \def \@oddfoot{\rm
160
            \hfil\raisebox{-9pt}{\thepage}\hfil\thispagestyle{gqtekspectocn}}
161
      \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
162
 
163
\def\ps@gqtekspeclof{\let\@mkboth\@gobbletwo
164
      \def \@oddhead{}
165
      \def \@oddfoot{\rm
166
           \hfil\raisebox{-9pt}{\thepage}\hfil\thispagestyle{gqtekspeclofn}}
167
      \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
168
\def\ps@gqtekspeclofn{\let\@mkboth\@gobbletwo
169
      \def \@oddhead{\rm
170
           \parbox{\textwidth}{\raisebox{0pt}{Figure}\hfil\raisebox{0pt}{Page} %
171
           \raisebox{20pt}{\rule[10pt]{\textwidth}{0.5mm}} }}
172
 
173
      \def \@oddfoot{\rm
174
           \hfil\raisebox{-9pt}{\thepage}\hfil\thispagestyle{gqtekspeclofn}}
175
      \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
176
 
177
\def\ps@gqtekspeclot{\let\@mkboth\@gobbletwo
178
      \def \@oddhead{}
179
      \def \@oddfoot{\rm
180
           \hfil\raisebox{-9pt}{\thepage}\hfil\thispagestyle{gqtekspeclotn}}
181
      \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
182
\def\ps@gqtekspeclotn{\let\@mkboth\@gobbletwo
183
      \def \@oddhead{\rm
184
           \parbox{\textwidth}{\raisebox{0pt}{Table}\hfil\raisebox{0pt}{Page} %
185
           \raisebox{20pt}{\rule[10pt]{\textwidth}{0.5mm}} }}
186
 
187
      \def \@oddfoot{\rm
188
           \hfil\raisebox{-9pt}{\thepage}\hfil\thispagestyle{gqtekspeclotn}}
189
      \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
190
 
191
\def\ps@gqtekspecplain{\let\@mkboth\@gobbletwo
192
      \def \@oddhead{\rput(0,-2pt){\psline(0,0)(\textwidth,0)}\rm \hbox to 1in{\includegraphics[height=0.8\headheight]{GT.eps} Gisselquist Technology, LLC}\hfil\hbox{\@title}\hfil\hbox to 1in{\hfil\headerdate\@date}}
193
      \def \@oddfoot{\rput(0,9pt){\psline(0,0)(\textwidth,0)}\rm \hbox to 1in{www.opencores.com\hfil}\hfil\hbox{\r@vision}\hfil\hbox to 1in{\hfil{\thepage}}}
194
      \let \@evenhead\@oddhead \let \@evenfoot\@oddfoot}
195
 
196
% \def\author#1{\def\auth@r{#1}}
197
% \def\title#1{\def\ti@tle{#1}}
198
 
199
\def\logo{\begin{pspicture}(0,0)(5.67in,0.75in)
200
        \rput[lb](0.05in,0.10in){\includegraphics[height=0.75in]{GT.eps}}
201
        \rput[lb](1.15in,0.05in){\scalebox{1.8}{\parbox{2.0in}{Gisselquist\\Technology, LLC}}}
202
        \end{pspicture}}
203
%  TITLEPAGE
204
%
205
\def\titlepage{\setcounter{page}{1}
206
   \typeout{^^JTitle Page.}
207
   \thispagestyle{empty}
208
   \leftline{\rput(0,0){\psline(0,0)(\textwidth,0)}\hfill}
209
        \vskip 2\baselineskip
210
        \logo\hfil % Original is 3.91 in x 1.26 in, let's match V thus
211
        \vskip 2\baselineskip
212
        \vspace*{10pt}\vfil
213
        \begin{minipage}{\textwidth}\raggedleft
214
        \ifproject{\Huge\bfseries\MakeUppercase\@project} \\\fi
215
        \vspace*{15pt}
216
        {\Huge\bfseries\MakeUppercase\@title} \\
217
        \vskip 10\baselineskip
218
        \Large \@author \\
219
        \ifemail{\Large \@email}\\\fi
220
        \vskip 6\baselineskip
221
        \Large \usdate\@date \\
222
        \end{minipage}
223
        % \baselineskip 22.5pt\large\rm\MakeUppercase\ti@tle
224
        \vspace*{30pt}
225
        \vfil
226
        \newpage\baselineskip=\normalbaselineskip}
227
 
228
\newenvironment{license}{\clearpage\typeout{^^JLicense Page.}\ \vfill\noindent}%
229
        {\vfill\newpage}
230
%    ****************************************
231
%    *           CHAPTER DEFINITIONS        *
232
%    ****************************************
233
%
234
\renewcommand\chapter{\if@openright\cleardoublepage\else\clearpage\fi
235
        \thispagestyle{gqtekspecplain}%
236
        \global\@topnum\z@
237
        \@afterindentfalse
238
        \secdef\@chapter\@schapter}
239
\renewcommand\@makechapterhead[1]{%
240
        \hbox  to \textwidth{\hfil{\Huge\bfseries \thechapter.}}\vskip 10\p@
241
        \hbox to \textwidth{\rput(0,0){\psline[linewidth=0.04in](0,0)(\textwidth,0)}}\vskip \p@
242
        \hbox to \textwidth{\rput(0,0){\psline[linewidth=0.04in](0,0)(\textwidth,0)}}\vskip 10\p@
243
        \hbox  to \textwidth{\hfill{\Huge\bfseries #1}}%
244
        \par\nobreak\vskip 40\p@}
245
\renewcommand\@makeschapterhead[1]{%
246
        \hbox  to \textwidth{\hfill{\Huge\bfseries #1}}%
247
        \par\nobreak\vskip 40\p@}
248
%    ****************************************
249
%    *           INITIALIZATION             *
250
%    ****************************************
251
%
252
% Default initializations
253
 
254
\ps@gqtekspecplain          % 'gqtekspecplain' page style with lowered page nos.
255
\onecolumn             % Single-column.
256
\pagenumbering{roman}  % the first chapter will change pagenumbering
257
                       % to arabic
258
\setcounter{page}{1}   % in case a titlepage is not requested
259
                       % otherwise titlepage sets page to 1 since the
260
                       % flyleaf is not counted as a page
261
\widowpenalty 10000    % completely discourage widow lines
262
\clubpenalty 10000     % completely discourage club (orphan) lines
263
\raggedbottom          % don't force alignment of bottom of pages
264
 
265
\date{\today}
266
\newif\ifproject\projectfalse
267
\def\project#1{\projecttrue\gdef\@project{#1}}
268
\def\@project{}
269
\newif\ifemail\emailfalse
270
\def\email#1{\emailtrue\gdef\@email{#1}}
271
\def\@email{}
272
\def\revision#1{\gdef\r@vision{#1}}
273
\def\r@vision{}
274
\def\at{\makeatletter @\makeatother}
275
\newdateformat{theyear}{\THEYEAR}
276
\newenvironment{revisionhistory}{\clearpage\typeout{^^JRevision History.}%
277
        \hbox  to \textwidth{\hfil\scalebox{1.8}{\large\bfseries Revision History}}\vskip 10\p@\noindent%
278
        \begin{tabular}{|p{0.5in}|p{1in}|p{1in}|p{2.875in}|}\hline
279
        \rowcolor[gray]{0.8} Rev. & Date & Author & Description\\\hline\hline}
280
        {\end{tabular}\clearpage}
281
\newenvironment{clocklist}{\begin{tabular}{|p{0.75in}|p{0.5in}|l|l|p{2.875in}|}\hline
282
        \rowcolor[gray]{0.85} Name & Source & \multicolumn{2}{l|}{Rates (MHz)} & Description \\\hhline{~|~|-|-|~}%
283
        \rowcolor[gray]{0.85} & & Max & Min & \\\hline\hline}%
284
        {\end{tabular}}
285
\newenvironment{reglist}{\begin{tabular}{|p{0.75in}|p{0.5in}|p{0.5in}|p{0.5in}|p{2.875in}|}\hline
286
        \rowcolor[gray]{0.85} Name & Address & Width & Access & Description \\\hline\hline}%
287
        {\end{tabular}}
288
\newenvironment{bitlist}{\begin{tabular}{|p{0.5in}|p{0.5in}|p{3.875in}|}\hline
289
        \rowcolor[gray]{0.85} Bit \# & Access & Description \\\hline\hline}%
290
        {\end{tabular}}
291
\newenvironment{portlist}{\begin{tabular}{|p{0.75in}|p{0.5in}|p{0.75in}|p{3.375in}|}\hline
292
        \rowcolor[gray]{0.85} Port & Width & Direction & Description \\\hline\hline}%
293
        {\end{tabular}}
294
\newenvironment{wishboneds}{\begin{tabular}{|p{2.5in}|p{2.5in}|}\hline
295
        \rowcolor[gray]{0.85} Description &  Specification \\\hline\hline}%
296
        {\end{tabular}}
297
\newenvironment{preface}{\chapter*{Preface}}{\par\bigskip\bigskip\leftline{\hfill\@author}}
298
\endinput

powered by: WebSVN 2.1.0

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