blob: c0610ebbf160ec0deb47580e44ae9a2520170673 [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
Guido van Rossumb7fc4af1992-08-07 16:06:42 +000041% Underscores are not magic throughout the Python documentation.
42% This still only gives the right effect in the tt font!!!
Guido van Rossum5badc751992-03-06 10:55:46 +000043\catcode`_=12
44
45% Dummy \cbstart and \cbend so I can leave changebars in...
46\newcommand{\cbstart}{}
47\newcommand{\cbend}{}
48
49% Define \itembreak: force the text after an item to start on a new line
50\newcommand{\itembreak}{
51\mbox{}
52\\*[0mm]
53}
54
55% Command to generate two index entries (using subentries)
56\newcommand{\indexii}[2]{
57\index{#1!#2}
58\index{#2!#1}
59}
60
61% And three entries (using only one level of subentries)
62\newcommand{\indexiii}[3]{
63\index{#1!#2 #3}
64\index{#2!#3, #1}
65\index{#3!#1 #2}
66}
67
68% And four (again, using only one level of subentries)
69\newcommand{\indexiv}[4]{
70\index{#1!#2 #3 #4}
71\index{#2!#3 #4, #1}
72\index{#3!#4, #1 #2}
73\index{#4!#1 #2 #3}
74}
75
76% Command to generate a reference to a function, statement, keyword, operator
77\newcommand{\stindex}[1]{\indexii{statement}{#1@{\tt#1}}}
78\newcommand{\kwindex}[1]{\indexii{keyword}{#1@{\tt#1}}}
79\newcommand{\opindex}[1]{\indexii{operator}{#1@{\tt#1}}}
Guido van Rossum6886c831992-04-03 14:44:27 +000080\newcommand{\exindex}[1]{\indexii{exception}{#1@{\tt#1}}}
81\newcommand{\obindex}[1]{\indexii{object}{#1}}
Guido van Rossum5badc751992-03-06 10:55:46 +000082\newcommand{\bifuncindex}[1]{\index{#1@{\tt#1} (built-in function)}}
83
84% Add an index entry for a module
85\newcommand{\modindex}[2]{\index{#1@{\tt#1} (#2module)}}
86\newcommand{\bimodindex}[1]{\modindex{#1}{built-in }}
87\newcommand{\stmodindex}[1]{\modindex{#1}{standard }}
88
89% Additional string for an index entry
90\newcommand{\indexsubitem}{}
91\newcommand{\ttindex}[1]{\index{#1@{\tt#1} \indexsubitem}}
92
93% Define \itemjoin: some negative vspace to join two items together
94\newcommand{\itemjoin}{
95\mbox{}
96\vspace{-\itemsep}
97\vspace{-\parsep}
98}
99
100% Define \funcitem{func}{args}: define a function item
101\newcommand{\funcitem}[2]{
102\ttindex{#1}
103\item[{\tt #1(#2)}]
104\
105}
106
107% Define \dataitem{name}: define a data item
108\newcommand{\dataitem}[1]{
109\ttindex{#1}
110\item[{\tt #1}]
111\
112}
113
114% Define \excitem{name}: define an exception item
115\newcommand{\excitem}[1]{
116\ttindex{#1}
117\item[{\tt #1}]
118\itembreak
119}