summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/aastex/aasclass.tex
blob: 5332bd34d68c1d1eb03d1f6ae85a96df3e1dacd1 (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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
%%
%% This is file `aasclass.tex',
%% generated with the docstrip utility.
%%
%% The original source files were:
%%
%% aasclass.dtx  (with options: `doc')
%% 
%% This is a generated file;
%% altering it directly is inadvisable;
%% instead, modify the original source file.
%% 
%% Copyright notice.
%% 
%%    These files are distributed
%%    WITHOUT ANY WARRANTY; without even the implied warranty of
%%    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
%% 
%% \CharacterTable
%%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%%   Digits        \0\1\2\3\4\5\6\7\8\9
%%   Exclamation   \!     Double quote  \"     Hash (number) \#
%%   Dollar        \$     Percent       \%     Ampersand     \&
%%   Acute accent  \'     Left paren    \(     Right paren   \)
%%   Asterisk      \*     Plus          \+     Comma         \,
%%   Minus         \-     Point         \.     Solidus       \/
%%   Colon         \:     Semicolon     \;     Less than     \<
%%   Equals        \=     Greater than  \>     Question mark \?
%%   Commercial at \@     Left bracket  \[     Backslash     \\
%%   Right bracket \]     Circumflex    \^     Underscore    \_
%%   Grave accent  \`     Left brace    \{     Vertical bar  \|
%%   Right brace   \}     Tilde         \~}%
%%%  @LaTeX-file{
%%%     filename        = "aastex.dtx",
%%%     version         = "5.2",
%%%     date            = "2005/06/22",
%%%     time            = "16:23:00 GMT",
%%%     checksum        = "5964",
%%%     author          = "Arthur Ogawa (mailto:ogawa@teleport.com)",
%%%     revised by      = "SR Nova Private Ltd."
%%%     copyright       = "Copyright (C) 2003 American Astronomical Society
%%%
%%%                        This work may be distributed and/or modified under the
%%%                        conditions of the LaTeX Project Public License, either version 1.3
%%%                        of this license or (at your option) any later version.
%%%                        The latest version of this license is in
%%%                        http://www.latex-project.org/lppl.txt
%%%                        and version 1.3 or later is part of all distributions of LaTeX
%%%                        version 2003/12/01 or later.
%%%
%%%                        This work has the LPPL maintenance status "maintained".
%%%
%%%                        The Current Maintainer of this work is the American Astronomical Society.
%%%
%%%                        This work consists of all files listed in the document README.
%%%
%%%     address         = "American Astronomical Society
%%%                        USA",
%%%     telephone       = "+1 ???",
%%%     FAX             = "",
%%%     email           = "aastex-help@aas.org",
%%%     codetable       = "ISO/ASCII",
%%%     keywords        = "latex, AAS, journal",
%%%     supported       = "yes",
%%%     abstract        = "formatter for AAS journal submissions",
%%%     docstring       = "The checksum field above generated by ltxdoc",
%%%  }
\NeedsTeXFormat{LaTeX2e}[1995/12/01]%
\expandafter\ProvidesFile\expandafter{\jobname.dtx}%
 [2005/06/22 5.2/AAS markup document class]%
\begin{filecontents}{ltxdoc.cfg}
\AtBeginDocument{\CodelineIndex\EnableCrossrefs}
\AtEndDocument{\PrintIndex}
\end{filecontents}
\documentclass[draft]{ltxdoc}
\DoNotIndex{\',\.,\@M,\@@input,\@Alph,\@alph,\@addtoreset,\@arabic}
\DoNotIndex{\@badmath,\@centercr,\@cite}
\DoNotIndex{\@dotsep,\@empty,\@float,\@gobble,\@gobbletwo,\@ignoretrue}
\DoNotIndex{\@input,\@ixpt,\@m,\@minus,\@mkboth}
\DoNotIndex{\@ne,\@nil,\@nomath,\@plus,\roman,\@set@topoint}
\DoNotIndex{\@tempboxa,\@tempcnta,\@tempdima,\@tempdimb}
\DoNotIndex{\@tempswafalse,\@tempswatrue,\@viipt,\@viiipt,\@vipt}
\DoNotIndex{\@vpt,\@warning,\@xiipt,\@xipt,\@xivpt,\@xpt,\@xviipt}
\DoNotIndex{\@xxpt,\@xxvpt,\\,\ ,\addpenalty,\addtolength,\addvspace}
\DoNotIndex{\advance,\ast,\begin,\begingroup,\bfseries,\bgroup,\box}
\DoNotIndex{\bullet}
\DoNotIndex{\cdot,\cite,\CodelineIndex,\cr,\day,\DeclareOption}
\DoNotIndex{\def,\DisableCrossrefs,\divide,\DocInput,\documentclass}
\DoNotIndex{\DoNotIndex,\egroup,\ifdim,\else,\fi,\em,\endtrivlist}
\DoNotIndex{\EnableCrossrefs,\end,\end@dblfloat,\end@float,\endgroup}
\DoNotIndex{\endlist,\everycr,\everypar,\ExecuteOptions,\expandafter}
\DoNotIndex{\fbox}
\DoNotIndex{\filedate,\filename,\fileversion,\fontsize,\framebox,\gdef}
\DoNotIndex{\global,\halign,\hangindent,\hbox,\hfil,\hfill,\hrule}
\DoNotIndex{\hsize,\hskip,\hspace,\hss,\if@tempswa,\ifcase,\or,\fi,\fi}
\DoNotIndex{\ifhmode,\ifvmode,\ifnum,\iftrue,\ifx,\fi,\fi,\fi,\fi,\fi}
\DoNotIndex{\input}
\DoNotIndex{\jobname,\kern,\leavevmode,\let,\leftmark}
\DoNotIndex{\list,\llap,\long,\m@ne,\m@th,\mark,\markboth,\markright}
\DoNotIndex{\month,\newcommand,\newcounter,\newenvironment}
\DoNotIndex{\NeedsTeXFormat,\newdimen}
\DoNotIndex{\newlength,\newpage,\nobreak,\noindent,\null,\number}
\DoNotIndex{\numberline,\OldMakeindex,\OnlyDescription,\p@}
\DoNotIndex{\pagestyle,\par,\paragraph,\paragraphmark,\parfillskip}
\DoNotIndex{\penalty,\PrintChanges,\PrintIndex,\ProcessOptions}
\DoNotIndex{\protect,\ProvidesClass,\raggedbottom,\raggedright}
\DoNotIndex{\refstepcounter,\relax,\renewcommand}
\DoNotIndex{\rightmargin,\rightmark,\rightskip,\rlap,\rmfamily}
\DoNotIndex{\secdef,\selectfont,\setbox,\setcounter,\setlength}
\DoNotIndex{\settowidth,\sfcode,\skip,\sloppy,\slshape,\space}
\DoNotIndex{\symbol,\the,\trivlist,\typeout,\tw@,\undefined,\uppercase}
\DoNotIndex{\usecounter,\usefont,\usepackage,\vfil,\vfill,\viiipt}
\DoNotIndex{\viipt,\vipt,\vskip,\vspace}
\DoNotIndex{\wd,\xiipt,\year,\z@}
\DoNotIndex{\next}
\EnableCrossrefs
\setcounter{StandardModuleDepth}{1}
\expandafter\GetFileInfo\expandafter{\jobname.dtx}%
\CodelineIndex\EnableCrossrefs
\newcommand*{\Lopt}[1]{\textsf {#1}}%
\newcommand*{\Lcount}[1]{\textsl {\small#1}}%
\newcommand*{\pstyle}[1]{\textsl {#1}}%
\newcommand\aastex{AAS\TeX}%
\setlength\arraycolsep{0pt}%
\let\oarg\undefined
\makeatletter
\renewenvironment{theindex}
               {\if@twocolumn
                  \@restonecolfalse
                \else
                  \@restonecoltrue
                \fi
                \columnseprule \z@
                \columnsep 35\p@
                \twocolumn[\section{\indexname}]%
                \thispagestyle{plain}\parindent\z@
                \parskip\z@ \@plus .3\p@\relax
                \let\item\@idxitem}
               {\if@restonecol\onecolumn\else\clearpage\fi}
\makeatother
\makeatletter
 % This code stolen from ltxguide.cls:

\let\o@verbatim\verbatim
\def\verbatim{%
  \ifhmode\unskip\par\fi
  \ifx\@currsize\normalsize
     \small
  \fi
  \o@verbatim
}

\renewcommand \verbatim@font {%
  \normalfont \ttfamily
  \catcode`\<=\active
  \catcode`\>=\active
}

\RequirePackage{shortvrb}
\MakeShortVerb{\|}


\begingroup
  \catcode`\<=\active
  \catcode`\>=\active
  \gdef<{\@ifnextchar<\@lt\@meta}
  \gdef>{\@ifnextchar>\@gt\@gtr@err}
  \gdef\@meta#1>{\m{#1}}
  \gdef\@lt<{\char`\<}
  \gdef\@gt>{\char`\>}
\endgroup
\def\@gtr@err{%
   \ClassError{ltxguide}{%
      Isolated \protect>%
   }{%
      In this document class, \protect<...\protect>
      is used to indicate a parameter.\MessageBreak
      I've just found a \protect> on its own.
      Perhaps you meant to type \protect>\protect>?
   }%
}
\def\verbatim@nolig@list{\do\`\do\,\do\'\do\-}


\newcommand{\m}[1]{\mbox{$\langle$\it #1\/$\rangle$}}
\renewcommand{\arg}[1]{{\tt\string{}\m{#1}{\tt\string}}}
\newcommand{\oarg}[1]{{\tt[%]
}\m{#1}{\tt%[
]}}
\def\cmd#1{\cs{\expandafter\cmd@to@cs\string#1}}
\def\cmd@to@cs#1#2{\char\number`#2\relax}
\DeclareRobustCommand\cs[1]{\texttt{\char`\\#1}}
\newcommand*{\file}[1]{\texttt{#1}}%
 % end of code stolen from ltxguide.cls. Thanks, Alan.
\newcommand\subsubsubsection{%
 \@startsection{subsubsection}{4}%
  {\z@}{-15\p@\@plus-5\p@\@minus-2\p@}%
  {5\p@}{\normalfont\normalsize\itshape}%
}%
\def\endfilecontents{%
 \immediate\write\reserved@c{%
  \string\iffalse\space ltxdoc klootch^^J%
  This file has version number \fileversion, last revised \filedate.%
  \string\fi
 }%
 \immediate\closeout\reserved@c
 \def\T##1##2##3{%
  \ifx##1\@undefined\else
    \@latex@warning@no@line{##2 has been converted to Blank ##3e}%
  \fi
 }%
 \T\L{Form Feed}{Lin}%
 \T\I{Tab}{Spac}%
 \immediate\write\@unused{}%
}%
\expandafter\let\csname endfilecontents*\endcsname\endfilecontents
\makeatother
\begin{filecontents}{aasclass.ins}
%% This file will generate documentation and runtime files
%% from aasclass.dtx when run through LaTeX or TeX.
\input docstrip
\preamble

This is a generated file;
altering it directly is inadvisable;
instead, modify the original source file.

Copyright notice.

   These files are distributed
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

\endpreamble
\keepsilent
\generate{%
 \file{aastex.cls}{\from{aasclass.dtx}{class}}%
 \file{aastex.sty}{\from{aasclass.dtx}{style}}%
 \file{aasclass.tex}{\from{aasclass.dtx}{doc}}%
 \file{aasguide.tex}{\from{aasclass.dtx}{guide}}%
 \file{aassymbols.tex}{\from{aasclass.dtx}{symbols}}%
 \file{sample.tex}{\from{aasclass.dtx}{sample}}%
 \file{table.tex}{\from{aasclass.dtx}{table}}%
}%
\ifToplevel{
\Msg{***********************************************************}
\Msg{*}
\Msg{* To finish the installation, please move the following}
\Msg{* files into a directory searched by TeX:}
\Msg{*}
\Msg{* \space\space aastex.cls}
\Msg{*}
\Msg{* To produce the user documentation,
       run aasguide.tex through LaTeX.}
\Msg{*}
\Msg{* To produce the AAS and AMS symbols crib sheet,
       run aassymbols.tex through LaTeX.}
\Msg{*}
\Msg{* To typeset the aastex sample document,
       run sample.tex and table.tex
       through LaTeX.}
\Msg{*}
\Msg{* To produce the programmer documentation,
       run aasclass.dtx through LaTeX.}
\Msg{*}
\Msg{* Happy TeXing}
\Msg{***********************************************************}
}
\endbatchfile
\end{filecontents}
\begin{filecontents*}{Read.Me}
\title{%
 The \aastex\ Document Class For \LaTeXe\\
 Programmer's Manual%
 \thanks{%
  This file has version number \fileversion, last revised \filedate.%
  % For version number and date, search on "\fileversion" in the .dtx file,
  % or see the end of the Read.Me file.
 }%
}%

\author{%
Chris Biemesderfer (\texttt{mailto:chris@seagoat.com}), v4\\
Arthur Ogawa (\texttt{mailto:ogawa@teleport.com}), v\fileversion\\
Copyright (C) 1998 AAS
}%
\maketitle

\aastex\ provides a markup system and formatter for authoring
papers to be submitted electronically to a number of
astonomy journals.
This file embodies the document class,
the implementation, and the user documentation.

The distribution point for \aastex\ is
\file{ftp://ftp.aas.org/pubs/aastex50.zip}, which contains
fully unpacked, prebuilt runtime files and documentation.

To use this document class, you must have a working
\TeX\ installation equipped with \LaTeXe.
Certain features of \aastex\ (such as landscape tables)
require a PostScript printer.

To install, retrieve the distribution,
unpack it into a directory on the target computer,
and move the file \file{aastex.cls}
into a location in your filesystem where it will be found by \LaTeX.

If you will be using the |astro| font in your \aastex\ documents,
put the file \file{Astrosym.tfm} where \TeX\ can find it
(Textures users will put \file{Astrosym metrics} into their \file{TeX fonts} folder).
Now either install the (ATM-compatible) PostScript Type~1 fonts
appropriate to your operating system and \TeX\ implementation,
or install the MetaFont source (both provided with \aastex).
In any case, you are responsible for properly installing the
|astro| font on your system.

Then print out the user guide \file{aasguide.dvi} and
the two sample documents, \file{sample.dvi} and \file{table.dvi}.
If need be, print the programmer's manual \file{aasclass.dvi}.

\StopEventually{}\tableofcontents

\section{Processing Instructions}

The document class \file{aastex.cls} (plus other macro files),
the user documentation \file{aasguide.tex},
and the sample documents
are generated from this file, \file{aasclass.dtx},
via the {\sc docstrip} facility of \LaTeX.
The documentation that you are now reading is generated from
the same file by simply typesetting it with \LaTeX.

\subsection{Build Instructions for V5.0}

You may bootstrap \aastex\ solely from \file{aasclass.dtx}.
Prepare by installing \LaTeXe\ on your computer,
then carry out the following steps:
\begin{enumerate}

\item
Within an otherwise empty directory,
typeset \file{aasclass.dtx} with \LaTeX;
you will obtain the typeset documentation you are now reading,
along with the installer \file{aasclass.ins} and the file \file{Read.Me}.

Note that you will have to run MakeIndex (using the \LaTeX\ standard
\file{gind.ist}) and retypeset with \LaTeX\ as appropriate.

\item
Now typeset \file{aasclass.ins}, thereby generating
macro files \file{aastex.cls}, and \file{aastex.sty}, user documentation \file{aasguide.tex}, \file{aassymbols.tex},
the sample file \file{sample.tex} and the sample table
\file{table.tex}.

\item
Install \file{aastex.cls} and \file{aastex.sty}:
move them to a location
in your file system where they will be found by \LaTeX.

\item
Typeset \file{aasguide.tex} to obtain the user documentation
(you will have to run MakeIndex and retypeset as needed),

\item
Typeset the sample file \file{sample.tex}.
\end{enumerate}

For your reference,
there are six \TeX\ log files appended to this file
(locate them by searching on |preloaded format=|).
They result respectively from typesetting
\file{aasclass.dtx}, \file{aasclass.ins}, \file{aasguide.tex},
\file{aassymbols.tex},
\file{sample.tex}, \file{table.tex}.

\subsection{Build Instructions for V4.1}

When you bootstrap V5.0, you automatically create the files rquired for the
V4.1 distribution, which consists of a number of the documents for V4.0
along with style files to patch it, plus revised sample documents.
The user guide for V5.0 is also the guide for 4.1; relevant differences
appear in an appendix.

The files for version~4.1 are located in a separate part of the distribution tree,
a directory called \file{./V4.1/}.

To build, simply copy the file
\file{aastex.sty} into the 4.1 directory.
Then copy
the sample files \file{sample.tex}, \file{sample2.tex}, and \file{samptbls.tex},
and the sample tables
\file{table1.tex}, \file{table2.tex}, \file{table3.tex}, and \file{complext.tex}
into the same directory.
Finally, copy
\file{aasguide.dvi} and \file{aasguide.ps} into the same directory.

\end{filecontents*}
\begin{document}%
\expandafter\DocInput\expandafter{\jobname.dtx}%
\setcounter{secnumdepth}{0}%
\PrintIndex
\end{document}
\endinput
%%
%% End of file `aasclass.tex'.