summaryrefslogtreecommitdiff
path: root/macros/latex209/contrib/biemes/vg_guide.tex
blob: 60b997256a5d850b7a226ee2d607c6cf0b800f64 (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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
\documentstyle[11pt,twoside,cdbtex]{article}

\pagestyle{myheadings}
\head{STScI Viewgraphs --- User Info}

\begin{document}

\begin{titlepage}
\begin{center}
\vspace*{2in}

{\Large\bf Using the STScI Viewgraph Style}\\[.5in]

\begin{abstract} \noindent
The use of a \LaTeX{} document style for the preparation of viewgraphs
at STScI is described.  Some information that may be helpful for people
who want to design their own viewgraph format is also included, but no
promises are made.
\end{abstract}

\vspace{.5in}
\today

\vfill
C. D. Biemesderfer\\[.3ex]
Space Telescope Science Institute $\bullet$ Baltimore, Maryland
\end{center}
\end{titlepage}

\thispagestyle{plain}
\tableofcontents
\smallskip
\noindent\rule[6pt]{\textwidth}{.8pt}

\section*{Introduction}

There is a document style option available for \LaTeX{} users at the Institute
that enables you to prepare viewgraphs in the comfort of your own office.
Macros that extend plain \TeX{} are also under development and should be ready
Real Soon Now, so stay tuned.

I have endeavored to layer this style on top of vanilla \LaTeX{} as much as
possible in order that the usual array of handy environments is available
for producing itemized and enumerated lists, displayed equations, and so forth.
I have largely been successful at that, I think, but there are plenty of
bugs in this, and the reason I am releasing this now is that folks are
starting to copy ``test'' versions of my files that are in intermediate
(and not always working) condition.  This can be very confusing for me,
and it is obviously better to have everyone
use the same file so I know where to start when the complaints come rolling
in (interspersed, hopefully, with some positive feedback as well).

Please feel free to exercise all the advertised capabilities and report on
the things that don't work properly.  Do not hesitate to send along
suggestions for improvements and extensions, although you have to realize that
I may take a while to implement complicated ones.  It is preferable to receive
communications in a filable form, and \filename{VAX} Mail is best for this;
please note that my username is \filename{BIEMES}.  Have fun.

\section{What Is A Viewgraph ?}

A `viewgraph' is a `page' as far as \LaTeX{} is concerned, so pagebreaking
commands can be used to end a slide and get on with the next one.  At the
moment, there are five page `styles', and they have to do with viewgraphs
not text documents, so don't just assume that the regular \LaTeX{}
page styles will be there.  Most of the time, you will
probably use the default pagestyle, which is called `sthead'; the others
are `empty', `plain', `noaohead', and `overlay'.  They are covered in more
detail in \S\ref{pssec}.

\section{What You Cannot Do on Viewgraphs}

The ST viewgraph style is layered on top of regular \LaTeX{}, and you should
be aware of some things that are a function of the document style,
and that I have chosen \emphasize{not} to implement for viewgraphs.

\begin{description}
  \item[Sections.]  Forget sections entirely when you are making slides, and
        do not try to use commands like \verb"\section" or \verb"\paragraph".
        They are not defined.
  \item[Marginal notes.]  The margins of a viewgraph are off the glass of the
        projector, so don't waste your (and my) time with these.  They are
        not completely disabled, but it could be arranged.
  \item[Footnotes.]  These are not disabled, either, but it seems to me to
        be rather stupid to me to put teeny-weeny text on a viewgraph that
        somebody with poor eyesight in the back row is supposed to see on
        a projection screen (that is out of focus).
  \item[Twosided substyle.]  Do I need to explain this ?
  \item[Front and back matter.]  That's tables of contents, lists of figures,
        glossaries, appendices, etc.
\end{description}

There are other things are not such a great idea, either; for instance, you
shouldn't need things like the `figure' and `table' environments
to define floats.  Not that you shouldn't use `tabular' to make tables,
but you should just have it appear on the slide wherever you typeset it.
In general, you should be able to put a \verb"\nofiles" command right after
\verb"\documentstyle" because there shouldn't ever need to be any auxiliary
files.  I can imagine why you \emphasize{might} want to use \verb"\label" and
\verb"\ref" on viewgraphs, but I don't think this is good idea.

\section{What You Can Do on Viewgraphs}

Everything else you might expect should work properly.
The list making environments (`itemize', `enumerate', `description') are
probably the most useful, and other environments like `center', `quote',
and `verse' can be used also.  I think that `flushleft' and `flushright'
will probably give you trouble, and I \emphasize{know} that the `verbatim'
environment misbehaves.  The trouble with these is with the margins; vanilla
\LaTeX{} makes some assumptions about margin parameters that I use to pull
the sides of the page away from the true width of the text (so that words
don't mash into the frame), and I have to redefine certain \LaTeX{} macros
to solve this.  The problem at the present time is finding the right ones.

\subsection{Substyles}

There are only four substyles (those are the arguments to \verb"\documentstyle"
that go in the square brackets) at the moment.  Three of them are for the
various default type sizes, and the fourth one turns on the frame around the
whole slide.

\begin{description}
  \item[18pt]  This is the default typesize, so you don't have to specify
        `18pt' as a substyle, but you can if you like.
  \item[20pt]  This one gives you somewhat larger type, which is probably what
        you expected.
  \item[24pt]  This is the largest size for which we have a complete
        set of fonts.
  \item[frame]  Specify this substyle if you want frames around the whole
        page.  By default, only the header box is framed.  You can change
        your mind about framing in the document by using
        \verb"\framepages" and \verb"\unframepages" commands.
\end{description}

Consider the implications of my statement above about the 24pt fonts.  Since
that is the largest ``set'' of fonts (Roman, math, slanted, italic, typewriter,
san serif, and small caps faces make up a set), and the ``normal'' size for
viewgraph type is quite large, you will find that the type size changing
commands of \LaTeX{} won't always do something when you're trying to get
\emphasize{bigger} type.  The commands that select smaller type
sizes should be fine.

\subsection{Page styles} \label{pssec}

The default pagestyle for viewgraphs assembles a header for the transparency
consisting of the Institute name and several pieces of information that you
can supply for the right-hand box (see \S\ref{rbsec}).  You can have
the entire viewgraph enclosed in a frame (see \S\ref{framesec}).  This
style is called `sthead', although it is not necessary to include a
\verb"\pagestyle" command to use it.

There is an `noaohead' pagestyle which is similar to the `sthead' style,
but there is no ``right-hand box'' in the NOAO header.  It just says
``National Optical Astronomy Observatories'' across the top of the
slide.  The people at NOAO do not care much for this style.

Two of the ``regular'' \LaTeX{} pagestyles are implemented for those of
you who like to keep things simple (like the people at NOAO).  These are
`empty' and `plain', and they work like you would expect.  The `empty'
style doesn't add anything to the page besides what you type, while the
`plain' style adds the page (slide) number in the lower right-hand corner
of the viewgraph.

The last style option for viewgraphs is `overlay', which will not put
any borders or extraneous markings on the page.  The page size parameters
for the overlay style are tuned so
that the meeting, date, and presenter information wind up in the appropriate
locations on the page so that your \LaTeX ed output can be photocopied onto
the Institute's blank overhead transparency forms.  (By blank, I mean that
there are not `Date' and `Presenter' words in the upper right-hand box.)
If the registration of the pages isn't
exactly what you like, you will have to twiddle page size parameters yourself.

Please note that, while in principle you can toggle pagestyles,
you will probably find that the frames are not the same size when you switch
between pagestyles with headers and pagestyles without headers.  I am trying
to tune the sizes and the various macros involved so that this works smoothly,
but it's very low priority because it seems to me that you should pick a
style for a presentation and then stay with it.  But I am working on it.

\subsection{Framing the Page} \label{framesec}

You can get the whole viewgraph enclosed in a big frame by either selecting
the `frame' substyle or by putting a \verb"\framepages" command in your text.
If you want to disable page framing, there is an \verb"\unframepages" command.
These commands take effect on the page on which they are invoked.

\subsection{Putting Stuff in the Little Box on the Right Side} \label{rbsec}

Yes, this is the important part, isn't it ?  There are three very short lines
in the right-hand box in the header; the first one is for the name of the
meeting, the middle one is for the date, and the bottom one is for the
presenter.  You can supply text for these lines with the commands
\verb"\setmeeting", \verb"\setdate", and \verb"\setpresenter".  These
each take one argument, that being the text for the particular line;
for instance,
\begin{quote}
\verb"\setmeeting{STOPAT}"
\end{quote}
could be issued so that the acronym \filename{STOPAT} appears at the left
side of the top line in the little right-hand box.  (Observe that the page
number, or slide number, appears at the right side of this line, and at the
moment I don't have a way for you to suppress that.)  If you do not set the
date, today's date is used; if you don't set the meeting or presenter, those
items are left blank.  No additional text
is supplied by these commands, so in principle, you could put whatever you
wanted on these very short lines in the little right-hand box.  For example,
\begin{quote}
\verb"\setpresenter{I $\heartsuit$ SDAS}"
\end{quote}
would produce ``I $\heartsuit$ SDAS'' on the bottom line of the little
right-hand box.

By now, you have probably noticed that I am somewhat fanatical about the
smallish size of the right-hand box.  It is small because the Institute name
is very long and takes up about 70\% of the available text width, so you
are left with a little less than 2 inches to play with.  If you put a longish
bit of text on one of those lines (say, for instance, the presenter's name was
something like Christopher D. Biemesderfer), you could very easily wind up
with a header that is wider than the page width.  I have arranged it so that
such a header can be constructed without an overfull hbox, but
unfortunately \TeX{} has its own ideas about what do
in this situation, and will probably mess up the alignment of the header and the
box containing the text of your viewgraph.  I am trying to solve this, but
it is quite tricky; as long as you are terse, everything will be OK anyway.

\subsection{What About the ST Logo ?}

You cannot simply pull the ST logo into the viewgraph header because it is
generated with the \filename{NCAR} graphics software, which is very
independent of \TeX .  It is possible to leave some extra space on the
left side of the Institute name by using the \verb"\stlogospace" command.
This command also takes one argument, and that is the horizontal dimension
of the white space you would like added before the word ``SPACE''.
\begin{quote}
\verb"\stlogospace{.65in}"
\end{quote}
would add about $\frac{2}{3}$ of an inch of blank space to the left of the
Institute name.  Please observe that this makes the left-hand box even
\emphasize{bigger}, so you have to be that much briefer in the right-hand box.

But, you say, leaving space is not the same thing as putting the logo in there.
That is quite correct, and you have to get the logo on the page by
``overlaying'' the graphics created by \filename{NCAR} on each viewgraph.
Since \TeX{} and \filename{NCAR} know nothing about one another, it is
completely up to you to make sure that the logo that \filename{NCAR} makes
lands in the space that \LaTeX{} creates.  This is sort of like playing
pin the tail on the donkey when you have a broken leg and are drunk.  You
also have to make the graphics overlay, which is itself a non-trivial
exercise.

In short, I would suggest that you not bother with this.  The logo might look
cute, but \emphasize{overlaying} graphics material is the \emphasize{wrong} way
to get graphics merged into \TeX{} documents, and hardly worth the pain
and suffering to get the alignment correct (scissors and glue are far
superior).  The appropriate mechanisms (a discussion of which is too long
and boring to include here) for doing this kind of integration
are well known to the \TeX{} cognoscenti,
and we are trying to deal with the problem.
A proper solution will eventually be available.

For those of you who insist on the presence of the little picture, you can
use the `overlay' pagestyle that disables the page frame as well as the
automatically generated ST header.  You must then photocopy the output from
\LaTeX{} onto a blank ST viewgraph form.

\subsection{Shut Up and Give an Example}

\begin{verbatim}
%  Select viewgraph document style and frame substyle so that pages get
%  surrounded by a big box.
%
\documentstyle[frame]{viewgraph}
%
%  Turn off auxiliary output files.  LaTeX always says "no file <file>.aux",
%  but that's what you asked for, so it's OK.
%
\nofiles
%
%  That's all you need in the preamble.
%
\begin{document}

\begin{center}
\bf A Sample Viewgraph
\end{center}

Itemized components for the first slide~:
\begin{itemize}
  \item speed
  \item accuracy
  \item portability
  \item nonsense
\end{itemize}

\clearpage      % end of the first slide

\setmeeting{RSDP ICD PDR}       % acronyms don't have to make sense

Enumerated components for the second slide~:
\begin{enumerate}
  \item speed
  \item accuracy
  \item portability
  \item more nonsense
\end{enumerate}

In order to demonstrate this new style more completely, let's put some
sentences here to show that you can also include running text.  You probably
want to stay away from too much of this though, because if there's lots of
text on the screen, people will get eyestrain trying to read it, and they
won't listen to a word you're saying.

\clearpage      % that's it for the second slide

\unframepages   % turn off the page frame
\setpresenter{Charlie the Tasteful Tuna}
\stlogospace .6in % leave white space and try to put a logo in it because
                  % you don't believe me that it's hard

{\large Since the default type size is used for this set of viewgraphs
(and there are bigger ones), the \verb"\large" command will select a
larger size.}

{\scriptsize This will be pretty small and therefore hard for your
audience to read.  This is where you put conclusions you are not sure about.}

\end{document}  % enough of this silliness
\end{verbatim}

\section{Making Your Own Headers}

Some people are never satisfied.  If you want to make up a header for
viewgraphs that is impossible within the constraints of my macros, you
can create your own substyle file to define an alternate pagestyle.  If
you do not know what a substyle file is, or the concept of an alternate
page style is foreign to your mind, please don't read the rest of this
section; it will only make things worse.

As you may know, after \LaTeX{} has finished reading substyle files and
executing the correct \verb"\ds@..." commands for defined document substyles,
it will try to resolve outstanding substyle requests by reading files
(named {\it substyle\/}\filename{.STY}) in
the local (default) directory.  The
easiest way to implement alternate headers is to define a new pagestyle
(a \verb"\ps@..." command) and place the custom \verb"\ps@..." description
(plus whatever other specialized things are wanted) in a \filename{.STY}
file in your \TeX{} directory.  A few remarks about these definitions are
in order.

Since the viewgraph document style doesn't support twosided printing, you
can save one level of macro replacement by defining \verb"\@thehead" and
\verb"\@thefoot" directly (you can skip \verb"\@oddhead" and \verb"\@oddfoot",
in other words).  It is unbelievably important that when you define the
header and footer macros, you leave \emphasize{absolutely} no spaces in the
definition.  I mean none at all, and that means you have to put a `\%' on the
end of every line so \TeX{} doesn't interpret the CR-LF as a word break.
If you leave spaces in the macros anywhere (other than \verb"\hspace" and
\verb"\hfil" and white space you want as part of the header), the header and
footer spacing will be completely screwed up.

You will probably need to look at the comments in the \filename{VIEWGRAPH.DOC}
file, because you might want to override the framing boolean or something
like that.  However, please note that the definitions I have written for the
default Institute header have a lot more jazz going on in them than is
required for most applications.  If you would like to see an example of
a special pagestyle (header), you would be better off examining
one that I made up for the SDAS workshop.  Ask me where it is hiding.

\end{document}