path: root/Master/texmf-dist/doc/latex/aastex/aasclass.tex

%%
%% 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'.