% \changes{v1.1}{28 Jan 96}{First release}
% \CheckSum{89}
%
% \iffalse meta-comment
%
% File: FILENAME.dtx
% Options: 
% Written by Nick Urbanik, 28 Jan 96
% An example of its use:
%
%\documentclass{FILENAME}
%
% To use this template:
% search for the following:
% FILENAME, ACTION, EXAMPLE, 28 Jan 96, 28 January 96, 1996/01/28,
% PURPOSE, FIRSTOPTION, BASE, DEFAULTOPTIONS, 
%
% $Header: G:\EMTEX\TEXINPUT\LATEX2E\NICK\RCS\template.dtx 1.1 1996/01/28 17:12:57 Nick Exp Nick $
%
% $Log: template.dtx $
% Revision 1.1  1996/01/28  17:12:57  Nick
% Initial revision
%
%
% \fi
%
% \begin{abstract}
%
% \end{abstract}
%
% \tableofcontents
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \section{How to use this class}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% The best way to see how to use this is by example.  See the file
% EXAMPLE.tex for a complete example.
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \subsection{Options available}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \subsection{}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%\StopEventually{}
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \section{The implementation}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \subsection{Producing the documentation}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Here is a short driver program that can be extracted with the \LaTeXe
% \textsf{docstrip} program.  It is not necessary to create a separate
% driver file from this, however; you can just run \emph{this}
% file, \file{FILENAME.dtx} through \LaTeXe.
%
%    \begin{macrocode}
%<*driver>
\ProvidesFile{FILENAME.drv}
\documentclass[a4paper,twoside]{ltxdoc}
\usepackage{a4,fancyheadings}
%    \end{macrocode}
% I have had problems with getting the correct |\filedate| and |\fileversion|
% from this file.  I keep getting them from the file \file{a4.sty}.
% I believe the next line is supposed to fix such a problem, but it
% leaves them undefined.
%    \begin{macrocode}
% \GetFileInfo{FILENAME.dtx}
%    \end{macrocode}
% This is definitely the wrong place to put |\fileversion|,
% |\fileversion| and |\docdate|, since it is hard
% to find them here, but at the moment it's the only place where I can get
% them to work!
%    \begin{macrocode}
\def\fileversion{1.0}
\def\filedate{28 January 96}
\def\docdate{28 January 96}
%    \end{macrocode}
% These depend on the package |fancyheadings|.  If you don't have it, you
% may want to comment out these lines.  You may prefer to comment out the
% line |\thispagestyle{empty}| further down.
%    \begin{macrocode}
\pagestyle{fancy}
\lhead[\textbf{\upshape The file \texttt{FILENAME.dtx}, a class to ACTION
       with \LaTeXe}]{\textbf{\thepage}}
\rhead[\textbf{\thepage}]{\textbf{\upshape The file \texttt{FILENAME.dtx}, a class to write lecture
      notes with \LaTeXe}}
\cfoot{}
%    \end{macrocode}
%    \begin{macrocode}
\EnableCrossrefs   % Make a full index.
%\DisableCrossrefs % Make no index.
\CodelineIndex     % Index by line numbers rather than by page.
%\PageIndex        % index commands using page numbers.
\DoNotIndex{\textbf,\texttt,bfseries,\renewcommand,\providescommand}
\DoNotIndex{\filedate,\filename,\fileversion}
\DoNotIndex{\DoNotIndex,\arabic}
\DoNotIndex{\NeedsTeXFormat}
\RecordChanges     % Show change history.
%\OnlyDescription  % uncomment this to not format the code.
\title{The file \texttt{FILENAME.dtx}, a class to ACTION
      with \LaTeXe.\thanks{This file has version number \fileversion,
      dated \filedate.}\\[2pt]
      It contains the code for \texttt{FILENAME.cls}}
\author{Nick Urbanik}
\date{\filedate}
\begin{document}
\thispagestyle{empty}
\maketitle
\providecommand{\Lenv}[1]{\textsf{#1}}
\providecommand{\pkg}[1]{\texttt{#1}}
\providecommand{\file}[1]{\texttt{#1}}
\DocInput{FILENAME.dtx}
\PrintIndex
\PrintChanges
%    \end{macrocode}
% Now tell the people what they need to do next to get the index and
% change list:
%    \begin{macrocode}
\typeout{Next, to make the index and changes list for this documentation:}
\typeout{2. makeindx -s gind.ist FILENAME}
\typeout{3. makeindx -s gglo.ist -o FILENAME.gls FILENAME.glo}
\typeout{Finally, run this file through LaTeX once more.}
%    \end{macrocode}
%
%    \begin{macrocode}
\end{document}
%</driver>
%    \end{macrocode}
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \subsection{Identification part}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%    \begin{macrocode}
%<*class>
\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{FILENAME}%
      [1996/01/28 PURPOSE]
%    \end{macrocode}
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \subsection{Declaration of options}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \subsubsection{The \texttt{FIRSTOPTION} option}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \subsubsection{Pass all other options unchanged to \texttt{BASE.cls}}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%    \begin{macrocode}
\DeclareOption*{\PassOptionsToClass{\CurrentOption}{BASE}}
%    \end{macrocode}
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \subsection{Execution of options}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% SHOULD WE USE |\ExecuteOption{..}| instead or as well as this?
% If see |classes.dtx|. |\ExecuteOptions| provides defaults that can
% be overridden.
%
%    \begin{macrocode}
\ProcessOptions
%    \end{macrocode}
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \subsection{Special class file commands}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%    \begin{macrocode}
\LoadClass[DEFAULTOPTIONS]{BASE}
%    \end{macrocode}
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \subsection{Package loading}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%    \begin{macrocode}
\RequirePackage{%
   %vmargin,%
   %array,%
   nick,%
   %ifthen,%
   %verbatim,%
   %rcs,%
   %slidesec,%
   %fancybox,%
   %version,%
   %alltt%
}
%    \end{macrocode}
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \subsection{Commands to make things work}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% These macros come from the \pkg{vmargin} package.
%    \begin{macrocode}
% \setpapersize{A4}
% \shiftmargins
%    \end{macrocode}
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \subsection{Miscellaneous commands}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%    \begin{macrocode}
%</class>
%    \end{macrocode}
%    \begin{macrocode}
\endinput
%    \end{macrocode}
%
%% \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         \~}
%%
% \Finale
