summaryrefslogtreecommitdiff
path: root/support/frankenbundle/template.dtx
blob: 5b1617e0081354429dd246f35f99f5acf9c71061 (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
%^^A** file information
% \CheckSum{6}
%
%^^A** abstract
% \begin{abstract}
% 
% \end{abstract}
% \tableofcontents
%
% \part{Discussion}
%
% \DescribeMacro{\jaguar}
%   Typesets a nice jaguar.
%
% \StopEventually{}
%
% \part{Implementation}
%
\def\fileinfo{Description of X}
^^A 
^^A What packages besides compsci do the package's DOX require?
^^A E.g., it's common for a package's dox to require the package itself.
^^A Use an argument like \usepackage.
^^A If the dox don't need packages, leave it \def'd to {} (else CheckSum fails)
\def\DoXPackageS{}
^^A Include next line IFF your dox \cite anything.
\def\initelyHavECitationS{}
\def\fileversion{v1.0}
\def\filedate{1996/03/25}
\def\docdate{1996/03/25}
%
% \section{Requirements}
%
%    \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
^^A What packages does your package/class require?
^^A Omit next line if none.
\RequirePackage{}
%    \end{macrocode}
%
% \section{Basics}
%
% \begin{macro}{\jaguar}
%   Defining a jaguar is easy.
%    \begin{macrocode}
\newcommand\jaguar {%
  \MakeCat{Central-American}{black}{sharpteeth}%
}
%    \end{macrocode}
% \end{macro}
%
% \part{Configuration}^^A This part is optional.
%
% Other things are deferred to a configuration file.
%    \begin{macrocode}
\InputIfFileExists{X.cfg}{}{}
%    \end{macrocode}
%
%  The contents of the distributed configuration file are below.
%
% \InputIfFileExists{X.cfg}{}{}
% 
% \Finale