blob: 42bbb7ad654a1de5f121498a360917c5e9061005 [file] [log] [blame]
Guido van Rossum643d9321992-03-31 18:53:47 +00001% Style parameters and macros used by most documents here
Guido van Rossum515834a1991-01-22 11:45:29 +00002
Guido van Rossumec24f1f1992-04-06 14:02:23 +00003\input{a4wide.sty} % Take this out if it doesn't exist or doesn't work
4
Guido van Rossum643d9321992-03-31 18:53:47 +00005% This has to be tuned each time the repair person takes the printer apart:
6\addtolength{\oddsidemargin}{-2.5mm}
7\addtolength{\evensidemargin}{-2.5mm}
Guido van Rossum515834a1991-01-22 11:45:29 +00008
Guido van Rossum5badc751992-03-06 10:55:46 +00009% Style parameters
10\raggedbottom
11\sloppy
12\parindent = 0mm
13\parskip = 2mm
14
Guido van Rossum4410c751991-06-04 20:22:18 +000015% Frequently used system name
Guido van Rossum515834a1991-01-22 11:45:29 +000016\newcommand{\UNIX}{U{\sc nix}}
17
Guido van Rossum4c22cb21991-01-25 13:28:15 +000018% Variable used by begin code command
Guido van Rossum44000ed1991-01-24 16:54:29 +000019\newlength{\codewidth}
Guido van Rossum44000ed1991-01-24 16:54:29 +000020
Guido van Rossum5badc751992-03-06 10:55:46 +000021% Command to start a code block (follow this by \begin{verbatim})
Guido van Rossum4c22cb21991-01-25 13:28:15 +000022\newcommand{\bcode}{
23 % Calculate the text width for the minipage:
24 \setlength{\codewidth}{\linewidth}
25 \addtolength{\codewidth}{-\parindent}
26 %
Guido van Rossum4c22cb21991-01-25 13:28:15 +000027 \par
Guido van Rossum92fba021991-11-12 15:44:51 +000028 \vspace{3mm}
Guido van Rossum4c22cb21991-01-25 13:28:15 +000029 \indent
30 \begin{minipage}[t]{\codewidth}
31}
32
Guido van Rossum5badc751992-03-06 10:55:46 +000033% Command to end a code block (precede this by \end{verbatim})
Guido van Rossum4c22cb21991-01-25 13:28:15 +000034\newcommand{\ecode}{
35 \end{minipage}
36 \vspace{3mm}
37 \par
38 \noindent
39}
Guido van Rossum5badc751992-03-06 10:55:46 +000040
41% Underscores are not magic throughout the Python documentation
42\catcode`_=12
43
44% Dummy \cbstart and \cbend so I can leave changebars in...
45\newcommand{\cbstart}{}
46\newcommand{\cbend}{}
47
48% Define \itembreak: force the text after an item to start on a new line
49\newcommand{\itembreak}{
50\mbox{}
51\\*[0mm]
52}
53
54% Command to generate two index entries (using subentries)
55\newcommand{\indexii}[2]{
56\index{#1!#2}
57\index{#2!#1}
58}
59
60% And three entries (using only one level of subentries)
61\newcommand{\indexiii}[3]{
62\index{#1!#2 #3}
63\index{#2!#3, #1}
64\index{#3!#1 #2}
65}
66
67% And four (again, using only one level of subentries)
68\newcommand{\indexiv}[4]{
69\index{#1!#2 #3 #4}
70\index{#2!#3 #4, #1}
71\index{#3!#4, #1 #2}
72\index{#4!#1 #2 #3}
73}
74
75% Command to generate a reference to a function, statement, keyword, operator
76\newcommand{\stindex}[1]{\indexii{statement}{#1@{\tt#1}}}
77\newcommand{\kwindex}[1]{\indexii{keyword}{#1@{\tt#1}}}
78\newcommand{\opindex}[1]{\indexii{operator}{#1@{\tt#1}}}
Guido van Rossum6886c831992-04-03 14:44:27 +000079\newcommand{\exindex}[1]{\indexii{exception}{#1@{\tt#1}}}
80\newcommand{\obindex}[1]{\indexii{object}{#1}}
Guido van Rossum5badc751992-03-06 10:55:46 +000081\newcommand{\bifuncindex}[1]{\index{#1@{\tt#1} (built-in function)}}
82
83% Add an index entry for a module
84\newcommand{\modindex}[2]{\index{#1@{\tt#1} (#2module)}}
85\newcommand{\bimodindex}[1]{\modindex{#1}{built-in }}
86\newcommand{\stmodindex}[1]{\modindex{#1}{standard }}
87
88% Additional string for an index entry
89\newcommand{\indexsubitem}{}
90\newcommand{\ttindex}[1]{\index{#1@{\tt#1} \indexsubitem}}
91
92% Define \itemjoin: some negative vspace to join two items together
93\newcommand{\itemjoin}{
94\mbox{}
95\vspace{-\itemsep}
96\vspace{-\parsep}
97}
98
99% Define \funcitem{func}{args}: define a function item
100\newcommand{\funcitem}[2]{
101\ttindex{#1}
102\item[{\tt #1(#2)}]
103\
104}
105
106% Define \dataitem{name}: define a data item
107\newcommand{\dataitem}[1]{
108\ttindex{#1}
109\item[{\tt #1}]
110\
111}
112
113% Define \excitem{name}: define an exception item
114\newcommand{\excitem}[1]{
115\ttindex{#1}
116\item[{\tt #1}]
117\itembreak
118}