diff options
author | cinap_lenrek <cinap_lenrek@localhost> | 2011-05-03 11:25:13 +0000 |
---|---|---|
committer | cinap_lenrek <cinap_lenrek@localhost> | 2011-05-03 11:25:13 +0000 |
commit | 458120dd40db6b4df55a4e96b650e16798ef06a0 (patch) | |
tree | 8f82685be24fef97e715c6f5ca4c68d34d5074ee /sys/src/cmd/python/Doc/templates/howto.tex | |
parent | 3a742c699f6806c1145aea5149bf15de15a0afd7 (diff) |
add hg and python
Diffstat (limited to 'sys/src/cmd/python/Doc/templates/howto.tex')
-rw-r--r-- | sys/src/cmd/python/Doc/templates/howto.tex | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/sys/src/cmd/python/Doc/templates/howto.tex b/sys/src/cmd/python/Doc/templates/howto.tex new file mode 100644 index 000000000..fdbb0657c --- /dev/null +++ b/sys/src/cmd/python/Doc/templates/howto.tex @@ -0,0 +1,112 @@ +% Complete documentation on the extended LaTeX markup used for Python +% documentation is available in ``Documenting Python'', which is part +% of the standard documentation for Python. It may be found online +% at: +% +% http://www.python.org/doc/current/doc/doc.html + +\documentclass{howto} + +% This is a template for short or medium-size Python-related documents, +% mostly notably the series of HOWTOs, but it can be used for any +% document you like. + +% The title should be descriptive enough for people to be able to find +% the relevant document. +\title{Spammifying Sprockets in Python} + +% Increment the release number whenever significant changes are made. +% The author and/or editor can define 'significant' however they like. +\release{0.00} + +% At minimum, give your name and an email address. You can include a +% snail-mail address if you like. +\author{Me, 'cause I wrote it} +\authoraddress{Me, 'cause I'm self-employed.} + +\begin{document} +\maketitle + +% This makes the Abstract go on a separate page in the HTML version; +% if a copyright notice is used, it should go immediately after this. +% +\ifhtml +\chapter*{Front Matter\label{front}} +\fi + +% Copyright statement should go here, if needed. +% ... + +% The abstract should be a paragraph or two long, and describe the +% scope of the document. +\begin{abstract} +\noindent +This document describes how to spammify sprockets. It is a useful +example of a Python HOWTO document. It is not dependent on any +particular sprocket implementation, and includes a Python-based +implementation in the \module{sprunkit} module. +\end{abstract} + +\tableofcontents + +Spammifying sprockets from Python is both fun and entertaining. +Applying the techniques described here, you can also fill your hard +disk quite effectively. + +\section{What is Sprocket Spammification?} + +You have to ask? It's the only thing to do to your sprockets! + + +\section{Why Use Python?} + +Python is an excellent language from which to spammify your sprockets +since you can do it on any platform. + + +\section{Software Requirements} + +You need to have the following software installed: + +% The {itemize} environment uses a bullet for each \item. If you want the +% \item's numbered, use the {enumerate} environment instead. +\begin{itemize} + \item Python 1.9. + \item Some sprocket definition files. + \item At least one sprocket system implementation. +\end{itemize} + +Note that the \module{sprunkit} is provided with this package and +implements ActiveSprockets in Python. + + +% The preceding sections will have been written in a gentler, +% introductory style. You may also wish to include a reference +% section, documenting all the functions/exceptions/constants. +% Often, these will be placed in separate files and input like this: + +\input{module} + + +\appendix + +\section{This is an Appendix} + +To create an appendix in a Python HOWTO document, use markup like +this: + +\begin{verbatim} +\appendix + +\section{This is an Appendix} + +To create an appendix in a Python HOWTO document, .... + + +\section{This is another} + +Just add another \section{}, but don't say \appendix again. +\end{verbatim} + + +\end{document} |