summaryrefslogtreecommitdiff
path: root/support/frankenbundle/template.dtx
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/frankenbundle/template.dtx
Initial commit
Diffstat (limited to 'support/frankenbundle/template.dtx')
-rw-r--r--support/frankenbundle/template.dtx63
1 files changed, 63 insertions, 0 deletions
diff --git a/support/frankenbundle/template.dtx b/support/frankenbundle/template.dtx
new file mode 100644
index 0000000000..5b1617e008
--- /dev/null
+++ b/support/frankenbundle/template.dtx
@@ -0,0 +1,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