summaryrefslogtreecommitdiffstats
path: root/Doc/templates/manual.tex
blob: 19dec8bf66983fad163cbcbf8c4277c4d544fd91 (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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
% 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{manual}

\title{Big Python Manual}

\author{Your Name Here}

% Please at least include a long-lived email address;
% the rest is at your discretion.
\authoraddress{
	Organization name, if applicable \\
	Street address, if you want to use it \\
	Email: \email{your-email@your.domain}
}

\date{April 30, 1999}		% update before release!
				% Use an explicit date so that reformatting
				% doesn't cause a new date to be used.  Setting
				% the date to \today can be used during draft
				% stages to make it easier to handle versions.

\release{x.y}			% release version; this is used to define the
				% \version macro

\makeindex			% tell \index to actually write the .idx file
\makemodindex			% If this contains a lot of module sections.


\begin{document}

\maketitle

% This makes the contents more accessible from the front page of the HTML.
\ifhtml
\chapter*{Front Matter\label{front}}
\fi

%\input{copyright}

\begin{abstract}

\noindent
Big Python is a special version of Python for users who require larger 
keys on their keyboards.  It accommodates their special needs by ...

\end{abstract}

\tableofcontents


\chapter{...}

My chapter.


\appendix
\chapter{...}

My appendix.

The \code{\e appendix} markup need not be repeated for additional
appendices.


%
%  The ugly "%begin{latexonly}" pseudo-environments are really just to
%  keep LaTeX2HTML quiet during the \renewcommand{} macros; they're
%  not really valuable.
%
%  If you don't want the Module Index, you can remove all of this up
%  until the second \input line.
%
%begin{latexonly}
\renewcommand{\indexname}{Module Index}
%end{latexonly}
\input{mod\jobname.ind}		% Module Index

%begin{latexonly}
\renewcommand{\indexname}{Index}
%end{latexonly}
\input{\jobname.ind}			% Index

\end{document}