summaryrefslogtreecommitdiff
path: root/macros/latex209/contrib/pphlp/phutguide.sty
blob: c5b617d249f96bfdc38f11faabb5a4b3560bf7ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
%%% ======================================================================
%%%  @LaTeX-style{
%%%     filename        = "phutguide.sty",
%%%     version         = "1.0",
%%%     date            = "19 July 1992",
%%%     time            = "13:53:20.42 ",
%%%     author          = "Norman Gray",
%%%     address         = "Department of Physics
%%%                        Open University
%%%                        Milton Keynes
%%%                        MK7 6AA, UK",
%%%     e-mail          = "N.O.Gray@open.ac.uk (Internet)",
%%%     telephone       = "+44 908 652279",
%%%     FAX             = "+44 908 653744",
%%%     archived        = "Aston, SHSU",
%%%     keywords        = "hlp-files, VMS, help",
%%%     abstract        = "This file is part of the PPHLP package, which
%%%                        allows both printed manuals and VMS help library
%%%                        modules to be prepared from a single file.",
%%%     codetable       = "ISO/Ascii",
%%%     checksum        = "01208 337 784 12102",
%%%     docstring       = "This style-file supports a user guide.  The
%%%                        principal differences from an ordinary article
%%%                        style are in the \maketitle command and the
%%%                        information that goes into it, and in the
%%%                        provision of an advice-box which appears
%%%                        automatically at the end of the text.
%%%
%%%                        There are a number of parochialisms, marked by
%%%                        the line string `% parochial'.  Ach, why not call
%%%                        them `customisable sections'...?
%%%                        
%%%                        The checksum field above contains a CRC-16
%%%                        checksum as the first value, followed by the
%%%                        equivalent of the standard UNIX wc (word 
%%%                        count) utility output of lines, words, and
%%%                        characters.  This is produced by Robert 
%%%                        Solovay's checksum utility."
%%% }
%%% ======================================================================
% phutguide.sty  September 1990
% modified from acsguide.sty, May 87, written by ACS, Open University
\typeout{Physics Userguide. Released September 1990}      % parochial
\def\phutilitarians{Norman ({\tt no\char"5F gray})}       % parochial
\def\phutilitarianext{2279}                               % parochial
% Next line added by Steve Daniels 6 May 88
\newif\ifview\viewfalse
\def\@ptsize{1} 
\@namedef{ds@10pt}{\def\@ptsize{0}}
\@namedef{ds@11pt}{\def\@ptsize{1}}
\@namedef{ds@12pt}{\def\@ptsize{2}} 
\def\ds@twoside{\@twosidetrue \@mparswitchtrue} 
\def\ds@draft{\overfullrule 5pt} 
\@options
%\input acsguide1\@ptsize.sty\relax
\input phutguide11.sty\relax


\def\labelenumi{\arabic{enumi}.} 
\def\theenumi{\arabic{enumi}} 
\def\labelenumii{(\alph{enumii})}
\def\theenumii{\alph{enumii}}
\def\p@enumii{\theenumi}
\def\labelenumiii{\roman{enumiii}.}
\def\theenumiii{\roman{enumiii}}
\def\p@enumiii{\theenumi(\theenumii)}
\def\labelenumiv{\Alph{enumiv}.}
\def\theenumiv{\Alph{enumiv}} 
\def\p@enumiv{\p@enumiii\theenumiii}

\def\labelitemi{$\bullet$}
\def\labelitemii{\bf --}
\def\labelitemiii{$\ast$}
\def\labelitemiv{$\cdot$}

\def\verse{\let\\=\@centercr 
 \list{}{\itemsep\z@ \itemindent -1.5em\listparindent \itemindent 
 \rightmargin\leftmargin\advance\leftmargin 1.5em}\item[]}
\let\endverse\endlist
\def\quotation{\list{}{\listparindent 1.5em
 \itemindent\listparindent
 \rightmargin\leftmargin \parsep 0pt plus 1pt}\item[]}
\let\endquotation=\endlist
\def\quote{\list{}{\rightmargin\leftmargin}\item[]}
\let\endquote=\endlist

\def\descriptionlabel#1{\hspace\labelsep \bf #1}
\def\description{\list{}{\labelwidth\z@ \itemindent-\leftmargin
 \let\makelabel\descriptionlabel}}
\let\enddescription\endlist


\def\theequation{\arabic{equation}}


\def\titlepage{\@restonecolfalse\if@twocolumn\@restonecoltrue\onecolumn
 \else \newpage \fi \thispagestyle{plain}\c@page\z@}
\def\endtitlepage{\if@restonecol\twocolumn \else \newpage \fi}

\arraycolsep 5pt \tabcolsep 6pt \arrayrulewidth .4pt \doublerulesep 2pt 
\tabbingsep \labelsep 

\skip\@mpfootins = \skip\footins
\fboxsep = 3pt \fboxrule = .4pt 

\newcounter{part}
\newcounter {section}
\newcounter {subsection}[section]
\newcounter {subsubsection}[subsection]
\newcounter {paragraph}[subsubsection]
\newcounter {subparagraph}[paragraph]

\def\thepart{\Roman{part}} \def\thesection {\arabic{section}}
\def\thesubsection {\thesection.\arabic{subsection}}
\def\thesubsubsection {\thesubsection .\arabic{subsubsection}}
\def\theparagraph {\thesubsubsection.\arabic{paragraph}}
\def\thesubparagraph {\theparagraph.\arabic{subparagraph}}

\def\@pnumwidth{1.55em}
\def\@tocrmarg {2.55em}
\def\@dotsep{4.5}
\setcounter{tocdepth}{3}

\def\tableofcontents{\section*{Contents\markboth{CONTENTS}{CONTENTS}}
 \@starttoc{toc}}
\def\l@part#1#2{\addpenalty{\@secpenalty}
 \addvspace{2.25em plus 1pt} \begingroup
 \@tempdima 3em \parindent \z@ \rightskip \@pnumwidth \parfillskip
-\@pnumwidth 
 {\large \bf \leavevmode #1\hfil \hbox to\@pnumwidth{\hss #2}}\par
 \nobreak \endgroup}
\def\l@section#1#2{\addpenalty{\@secpenalty} \addvspace{1.0em plus 1pt}
\@tempdima 1.5em \begingroup
 \parindent \z@ \rightskip \@pnumwidth 
 \parfillskip -\@pnumwidth 
 \bf \leavevmode #1\hfil \hbox to\@pnumwidth{\hss #2}\par
 \endgroup}
\def\l@subsection{\@dottedtocline{2}{1.5em}{2.3em}}
\def\l@subsubsection{\@dottedtocline{3}{3.8em}{3.2em}}
\def\l@paragraph{\@dottedtocline{4}{7.0em}{4.1em}}
\def\l@subparagraph{\@dottedtocline{5}{10em}{5em}}
\def\listoffigures{\section*{List of Figures\markboth
 {LIST OF FIGURES}{LIST OF FIGURES}}\@starttoc{lof}}
\def\l@figure{\@dottedtocline{1}{1.5em}{2.3em}}
\def\listoftables{\section*{List of Tables\markboth
 {LIST OF TABLES}{LIST OF TABLES}}\@starttoc{lot}}
\let\l@table\l@figure


\def\thebibliography#1{\section*{References\markboth
 {REFERENCES}{REFERENCES}}\list
 {[\arabic{enumi}]}{\settowidth\labelwidth{[#1]}\leftmargin\labelwidth
 \advance\leftmargin\labelsep
 \usecounter{enumi}}
 \def\newblock{\hskip .11em plus .33em minus -.07em}
 \sloppy
 \sfcode`\.=1000\relax}
\let\endthebibliography=\endlist
 

\newif\if@restonecol
\def\theindex{\@restonecoltrue\if@twocolumn\@restonecolfalse\fi
\columnseprule \z@
\columnsep 35pt\twocolumn[\section*{Index}]
 \markboth{INDEX}{INDEX}\thispagestyle{plain}\parindent\z@
 \parskip\z@ plus .3pt\relax\let\item\@idxitem}
\def\@idxitem{\par\hangindent 40pt}
\def\subitem{\par\hangindent 40pt \hspace*{20pt}}
\def\subsubitem{\par\hangindent 40pt \hspace*{30pt}}
\def\endtheindex{\if@restonecol\onecolumn\else\clearpage\fi}
\def\indexspace{\par \vskip 10pt plus 5pt minus 3pt\relax}

\def\footnoterule{\kern-3\p@ \hrule width \columnwidth  \kern 2.6\p@} 

\long\def\@makefntext#1{\parindent 1em\noindent 
 \hbox to 1.8em{\hss$^{\@thefnmark}$}#1}


\setcounter{topnumber}{2}
\def\topfraction{.7}
\setcounter{bottomnumber}{1}
\def\bottomfraction{.3}
\setcounter{totalnumber}{3}
\def\textfraction{.2}
\def\floatpagefraction{.5}
\setcounter{dbltopnumber}{2}
\def\dbltopfraction{.7}
\def\dblfloatpagefraction{.5}

\long\def\@makecaption#1#2{
 \vskip 10pt 
 \setbox\@tempboxa\hbox{{\bf #1:} #2}
 \ifdim \wd\@tempboxa >\hsize \unhbox\@tempboxa\par \else \hbox
to\hsize{\hfil\box\@tempboxa\hfil} 
 \fi}


\newcounter{figure}
\def\thefigure{\@arabic\c@figure}
\def\fps@figure{tbp}
\def\ftype@figure{1}
\def\ext@figure{lof}
\def\fnum@figure{Figure \thefigure}
\def\figure{\@float{figure}}
\let\endfigure\end@float
\@namedef{figure*}{\@dblfloat{figure}}
\@namedef{endfigure*}{\end@dblfloat}
\newcounter{table}
\def\thetable{\@arabic\c@table}
\def\fps@table{tbp}
\def\ftype@table{2}
\def\ext@table{lot}
\def\fnum@table{Table \thetable}
\def\table{\@float{table}}
\let\endtable\end@float
\@namedef{table*}{\@dblfloat{table}}
\@namedef{endtable*}{\end@dblfloat}

\gdef\@date{\thismonth}
\def\pagetitle#1{\gdef\@pagetitle{#1}}
\def\userguide#1{\gdef\@userguide{#1}}
\def\authorext#1{\gdef\@authorext{#1}}
\def\hoverline#1{\relax\ifmmode
                   \overline{\bigstrut #1}\else
                   $\overline{\hbox{\bigstrut #1}}$\relax\fi}
\newbox\bigstrutbox
\setbox\bigstrutbox=\hbox{\vrule height10pt depth3.5pt width0pt}
\def\bigstrut{\relax\ifmmode\copy\bigstrutbox\else\unhcopy\bigstrutbox\fi}

\def\advbox{\if@twocolumn\else\vfill
\begin{center}
\fbox{\parbox{300pt}{\parskip=\smallskipamount\small\sl\@advboxinfo}}
\end{center}
\fi}
\def\@advboxinfo{    % default text              % parochial
This documentation is also available on-line, by typing\par
\$ help \toptopic\par
\ifx\@author\@empty\else For further information on this package, see
\@author\ifx\@authorext\undefined\else\ on extension \@authorext\fi. \fi
To gain access to physics\_utilities, give the command\par
\$ @ science\$dsk:[physics\_utilities.util]phut\_setup}
\long\def\advboxinfo#1{\long\gdef\@advboxinfo{#1}}

\def\maketitle{\par
 \begingroup
  \def\thefootnote{\fnsymbol{footnote}}
  \def\@makefnmark{\hbox to 0pt{$^{\@thefnmark}$\hss}} 
  \if@twocolumn \twocolumn[\@maketitle] 
   \else \newpage \global\@topnum\z@ \@maketitle \fi
  \thispagestyle{empty}\@thanks
 \endgroup
 \setcounter{footnote}{0}
 \ifx\@pagetitle\undefined\let\@pagetitle=\@title\fi
 \let\maketitle\relax
 \let\@maketitle\relax
 \gdef\@thanks{}\gdef\@title{}\let\thanks\relax}
\def\@maketitle{\newpage
 \ifx\@userguide\undefined\let\@userguide=\@empty\fi
 \hrule\vskip 20pt\par\noindent
 {\Large\bf Physics User Guide \@userguide}                 % parochial
  \vskip 25pt\par\noindent
 {\LARGE\bf\@title}\vskip 25pt\par
 \hrule \par
 \vskip 20pt} 

\def\abstract{\if@twocolumn
  \section*{Abstract}
 \else 
  \quote \sl
 \fi}
\def\endabstract{\if@twocolumn\else
  \endquote
  \flushright
   \ifx\@author\undefined\let\@author=\@empty
        \else\sl \@author\\ \fi
   \sl\@date
  \endlist
  \vskip 5pt\hrule\vskip 15pt
 \fi}

\mark{{}{}} 

\def\ps@plain{
 \def\@oddhead{}
  \def\@oddfoot{\hfil \bf\thepage \hfil}
 \def\@evenhead{}
 \def\@evenfoot{\hfil \bf\thepage \hfil}}
\if@twoside
 \def\ps@headings{
  \ifx\@pagetitle\undefined\let\@pagetitle=\@title\fi
  \ifx\@userguide\undefined\let\@userguide=\@empty\fi
  \def\@oddhead{\protect\underline{\vbox{\hsize=\textwidth\noindent 
                        \bf \@date \hfill \@pagetitle}}}
  \def\@oddfoot{\protect\hoverline{\vbox{\hsize=\textwidth\noindent 
                        \bf Physics User Guide \@userguide \hfill \thepage}}}
                            % parochial
  \def\@evenhead{\protect\underline{\vbox{\hsize=\textwidth\noindent
                        \bf \@pagetitle \hfill \@date}}}
  \def\@evenfoot{\protect\hoverline{\vbox{\hsize=\textwidth\noindent 
                        \bf \thepage \hfill Physics User Guide \@userguide}}}
  \def\sectionmark##1{}
  \def\subsectionmark##1{}}
\else
 \def\ps@headings{
  \ifx\@date\undefined\let\@date=\thismonth\fi
  \ifx\@userguide\undefined\let\@userguide=\@empty\fi
  \ifx\@pagetitle\undefined\let\@pagetitle=\@title\fi
  \def\@oddhead{\protect\underline{\vbox{\noindent
                        \bf\@date \hfill \@pagetitle}}}
  \def\@oddfoot{\protect\hoverline{\vbox{\noindent 
                        \bf Physics User Guide \@userguide \hfill \thepage}}}
                             % parochial
  \def\@evenhead{}
  \def\@evenfoot{}
  \def\sectionmark##1{}
  \def\subsectionmark##1{}}
\fi
\def\ps@myheadings{
 \def\@oddhead{\hbox{}\sl\rightmark \hfil \rm\thepage}
 \def\@oddfoot{}
 \def\@evenhead{\rm \thepage\hfil\sl\leftmark\hbox{}}
 \def\@evenfoot{}
 \def\sectionmark##1{}
 \def\subsectionmark##1{}}


\def\today{\space\number\day\ \ifcase\month\or
January\or February\or March\or April\or May\or June\or
July\or August\or September\or October\or November\or December\fi\ 
\number\year}
\def\thismonth{\ifcase\month\or
January\or February\or March\or April\or May\or June\or
July\or August\or September\or October\or November\or December\fi\ 
\number\year}


\ps@headings \pagenumbering{arabic} \onecolumn \if@twoside\else\raggedbottom\fi