3
% This is a template for short or medium-size Python-related documents,
4
% mostly notably the series of HOWTOs, but it can be used for any
7
% The title should be descriptive enough for people to be able to find
8
% the relevant document.
9
\title{Spammifying Sprockets in Python}
11
% Increment the release number whenever significant changes are made.
12
% The author and/or editor can define 'significant' however they like.
15
% At minimum, give your name and an e-mail address. You can include a
16
% snail-mail address if you like.
17
\author{Me, 'cause I wrote it}
18
\authoraddress{Me, 'cause I'm self-employed.}
23
% This makes the Abstract go on a separate page in the HTML version;
24
% if a copyright notice is used, it should go immediately after this.
27
\chapter*{Front Matter\label{front}}
30
% Copyright statement should go here, if needed.
33
% The abstract should be a paragraph or two long, and describe the
34
% scope of the document.
37
This document describes how to spammify sprockets. It is a useful
38
example of a Python HOWTO document. It is not dependent on any
39
particular sprocket implementation, and includes a Python-based
40
implementation in the \module{sprunkit} module.
45
Spammifying sprockets from Python is both fun and entertaining.
46
Applying the techniques described here, you can also fill your hard
47
disk quite effectively.
49
\section{What is Sprocket Spammification?}
51
You have to ask? It's the only thing to do to your sprockets!
54
\section{Why Use Python?}
56
Python is an excellent language from which to spammify your sprockets
57
since you can do it on any platform.
60
\section{Software Requirements}
62
You need to have the following software installed:
64
% The {itemize} environment uses a bullet for each \item. If you want the
65
% \item's numbered, use the {enumerate} environment instead.
68
\item Some sprocket definition files.
69
\item At least one sprocket system implementation.
72
Note that the \module{sprunkit} is provided with this package and
73
implements ActiveSprockets in Python.
76
% The preceding sections will have been written in a gentler,
77
% introductory style. You may also wish to include a reference
78
% section, documenting all the functions/exceptions/constants.
79
% Often, these will be placed in separate files and input like this:
86
\section{This is an Appendix}
88
To create an appendix in a Python HOWTO document, use markup like
94
\section{This is an Appendix}
96
To create an appendix in a Python HOWTO document, ....
99
\section{This is another}
101
Just add another \section{}, but don't say \appendix again.
added
removed
doc/tools/templates/howto.tex
