blob: c502c31f5d0d040672d8b530a81a03bbfd78ab55 [file] [log] [blame]
Guido van Rossumecae0b71996-06-26 19:03:20 +00001%
2% myformat.sty for the Python doc [updated to work with Latex2e]
3%
4
Guido van Rossumdaff1751997-06-02 17:35:01 +00005% Increase printable page size (copied from fullpage.sty)
6\topmargin 0pt
7\advance \topmargin by -\headheight
8\advance \topmargin by -\headsep
9
10\textheight 8.9in
11
12\oddsidemargin 0pt
13\evensidemargin \oddsidemargin
14\marginparwidth 0.5in
15
16\textwidth 6.5in
17
Guido van Rossum643d9321992-03-31 18:53:47 +000018% Style parameters and macros used by most documents here
Guido van Rossum5badc751992-03-06 10:55:46 +000019\raggedbottom
20\sloppy
21\parindent = 0mm
22\parskip = 2mm
23
Guido van Rossum4c22cb21991-01-25 13:28:15 +000024% Variable used by begin code command
Guido van Rossum44000ed1991-01-24 16:54:29 +000025\newlength{\codewidth}
Guido van Rossum44000ed1991-01-24 16:54:29 +000026
Guido van Rossum5badc751992-03-06 10:55:46 +000027% Command to start a code block (follow this by \begin{verbatim})
Guido van Rossum4c22cb21991-01-25 13:28:15 +000028\newcommand{\bcode}{
29 % Calculate the text width for the minipage:
30 \setlength{\codewidth}{\linewidth}
31 \addtolength{\codewidth}{-\parindent}
32 %
Guido van Rossum4c22cb21991-01-25 13:28:15 +000033 \par
Guido van Rossum92fba021991-11-12 15:44:51 +000034 \vspace{3mm}
Guido van Rossum4c22cb21991-01-25 13:28:15 +000035 \indent
36 \begin{minipage}[t]{\codewidth}
37}
38
Guido van Rossum5badc751992-03-06 10:55:46 +000039% Command to end a code block (precede this by \end{verbatim})
Guido van Rossum4c22cb21991-01-25 13:28:15 +000040\newcommand{\ecode}{
41 \end{minipage}
42 \vspace{3mm}
43 \par
44 \noindent
45}
Guido van Rossum5badc751992-03-06 10:55:46 +000046
Guido van Rossumecae0b71996-06-26 19:03:20 +000047% Underscore hack (only act like subscript operator if in math mode)
48%
49% The following is due to Mark Wooding (the old version didn't work with
50% Latex 2e.
51
52\DeclareRobustCommand\hackscore{%
53 \ifmmode_\else\textunderscore\fi%
54}
55\begingroup
56\catcode`\_\active
57\def\next{%
58 \AtBeginDocument{\catcode`\_\active\def_{\hackscore{}}}%
59}
60\expandafter\endgroup\next
61
62%
63% This is the old hack, which didn't work with 2e.
64% If you're still using Latex 2.09, you can give it a try if the above fails.
65%
66%\def\_{\ifnum\fam=\ttfamily \char'137\else{\tt\char'137}\fi}
67%\catcode`\_=12
68%\catcode`\_=\active\def_{\ifnum\fam=\ttfamily \char'137 \else{\tt\char'137}\fi}
Guido van Rossum5badc751992-03-06 10:55:46 +000069
Guido van Rossum5badc751992-03-06 10:55:46 +000070% Define \itembreak: force the text after an item to start on a new line
71\newcommand{\itembreak}{
72\mbox{}
73\\*[0mm]
74}
75
76% Command to generate two index entries (using subentries)
Guido van Rossum16d6e711994-08-08 12:30:22 +000077\newcommand{\indexii}[2]{\index{#1!#2}\index{#2!#1}}
Guido van Rossum5badc751992-03-06 10:55:46 +000078
79% And three entries (using only one level of subentries)
Guido van Rossum16d6e711994-08-08 12:30:22 +000080\newcommand{\indexiii}[3]{\index{#1!#2 #3}\index{#2!#3, #1}\index{#3!#1 #2}}
Guido van Rossum5badc751992-03-06 10:55:46 +000081
82% And four (again, using only one level of subentries)
83\newcommand{\indexiv}[4]{
84\index{#1!#2 #3 #4}
85\index{#2!#3 #4, #1}
86\index{#3!#4, #1 #2}
87\index{#4!#1 #2 #3}
88}
89
90% Command to generate a reference to a function, statement, keyword, operator
91\newcommand{\stindex}[1]{\indexii{statement}{#1@{\tt#1}}}
92\newcommand{\kwindex}[1]{\indexii{keyword}{#1@{\tt#1}}}
93\newcommand{\opindex}[1]{\indexii{operator}{#1@{\tt#1}}}
Guido van Rossum6886c831992-04-03 14:44:27 +000094\newcommand{\exindex}[1]{\indexii{exception}{#1@{\tt#1}}}
95\newcommand{\obindex}[1]{\indexii{object}{#1}}
Guido van Rossum5badc751992-03-06 10:55:46 +000096\newcommand{\bifuncindex}[1]{\index{#1@{\tt#1} (built-in function)}}
97
98% Add an index entry for a module
Fred Drake207e57b1997-12-15 21:37:45 +000099\newcommand{\refmodule}[2]{\index{#1@{\tt#1} (#2module)}}
Fred Drake4af18141997-12-15 22:08:14 +0000100\newcommand{\refmodindex}[1]{\refmodule{#1}{}}
Fred Drake207e57b1997-12-15 21:37:45 +0000101\newcommand{\refbimodindex}[1]{\refmodule{#1}{built-in }}
102\newcommand{\refstmodindex}[1]{\refmodule{#1}{standard }}
103
104% Add the defining entry for a module
105\newcommand{\defmodindex}[2]{\index{#1@{\tt#1} (#2module)|textbf}}
106\newcommand{\bimodindex}[1]{\defmodindex{#1}{built-in }}
107\newcommand{\stmodindex}[1]{\defmodindex{#1}{standard }}
Guido van Rossum5badc751992-03-06 10:55:46 +0000108
109% Additional string for an index entry
110\newcommand{\indexsubitem}{}
111\newcommand{\ttindex}[1]{\index{#1@{\tt#1} \indexsubitem}}
112
113% Define \itemjoin: some negative vspace to join two items together
114\newcommand{\itemjoin}{
115\mbox{}
116\vspace{-\itemsep}
117\vspace{-\parsep}
118}
119
120% Define \funcitem{func}{args}: define a function item
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000121\newcommand{\funcitem}[2]{%
122\ttindex{#1}%
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000123\item[\code{#1(\varvars{#2})}]
Guido van Rossum5badc751992-03-06 10:55:46 +0000124\
125}
126
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000127
128% from user-level, fulllineitems should be called as an environment
129\def\fulllineitems{\list{}{\labelwidth \leftmargin \labelsep 0pt
130\rightmargin 0pt \topsep -\parskip \partopsep \parskip
131\itemsep -\parsep
132\let\makelabel\itemnewline}}
133\let\endfulllineitems\endlist
134
135
Guido van Rossum36f35021997-05-22 20:43:24 +0000136% cfuncdesc should be called as
137% \begin{cfuncdesc}{type}{name}{arglist}
138% ... description ...
139% \end{cfuncdesc}
Fred Drakeeb33c781996-10-29 15:55:08 +0000140\newcommand{\cfuncline}[3]{\item[\code{#1 #2(\varvars{#3})}]\ttindex{#2}}
141\newcommand{\cfuncdesc}[3]{\fulllineitems\cfuncline{#1}{#2}{#3}}
142\let\endcfuncdesc\endfulllineitems
143
Guido van Rossum36f35021997-05-22 20:43:24 +0000144\newcommand{\cvarline}[2]{\item[\code{#1 #2}]\ttindex{#2}}
145\newcommand{\cvardesc}[2]{\fulllineitems\cvarline{#1}{#2}}
146\let\endcvardesc\endfulllineitems
147
148\newcommand{\ctypeline}[1]{\item[\code{#1}]\ttindex{#1}}
149\newcommand{\ctypedesc}[1]{\fulllineitems\ctypeline{#1}}
150\let\endctypedesc\endfulllineitems
151
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000152% funcdesc should be called as an \begin{funcdesc} ... \end{funcdesc}
153\newcommand{\funcline}[2]{\item[\code{#1(\varvars{#2})}]\ttindex{#1}}
154\newcommand{\funcdesc}[2]{\fulllineitems\funcline{#1}{#2}}
155\let\endfuncdesc\endfulllineitems
Guido van Rossum16d6e711994-08-08 12:30:22 +0000156\newcommand{\optional}[1]{{\ \Large[}{#1}\hspace{0.5mm}{\Large]}\ }
157
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000158
159% same for excdesc
160\newcommand{\excline}[1]{\item[\code{#1}]\ttindex{#1}}
161\newcommand{\excdesc}[1]{\fulllineitems\excline{#1}}
162\let\endexcdesc\endfulllineitems
163
164% same for datadesc
165\newcommand{\dataline}[1]{\item[\code{#1}]\ttindex{#1}}
166\newcommand{\datadesc}[1]{\fulllineitems\dataline{#1}}
167\let\enddatadesc\endfulllineitems
168
169
Fred Drakea610f9f1997-12-03 03:42:39 +0000170% opcodedesc should be called as an \begin{opcodedesc} ... \end{opcodedesc}
171\newcommand{\opcodeline}[2]{\item[\code{#1\quad\varvars{#2}}]\ttindex{#1}}
172\newcommand{\opcodedesc}[2]{\fulllineitems\opcodeline{#1}{#2}}
173\let\endopcodedesc\endfulllineitems
174
175
Guido van Rossum5badc751992-03-06 10:55:46 +0000176% Define \dataitem{name}: define a data item
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000177\newcommand{\dataitem}[1]{%
178\ttindex{#1}%
Guido van Rossum5badc751992-03-06 10:55:46 +0000179\item[{\tt #1}]
180\
181}
182
183% Define \excitem{name}: define an exception item
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000184\newcommand{\excitem}[1]{%
185\ttindex{#1}%
Guido van Rossum5badc751992-03-06 10:55:46 +0000186\item[{\tt #1}]
187\itembreak
188}
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000189
190\let\nodename=\label
191
Fred Drake30824241996-12-13 21:53:07 +0000192%% For these commands, use \command{} to get the typography right, not
193%% {\command}. This works better with the texinfo translation.
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000194\newcommand{\ABC}{{\sc abc}}
195\newcommand{\UNIX}{{\sc Unix}}
196\newcommand{\ASCII}{{\sc ascii}}
Guido van Rossum16d6e711994-08-08 12:30:22 +0000197\newcommand{\Cpp}{C\protect\raisebox{.18ex}{++}}
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000198\newcommand{\C}{C}
199\newcommand{\EOF}{{\sc eof}}
Guido van Rossum9231c8f1997-05-15 21:43:21 +0000200\newcommand{\NULL}{\code{NULL}}
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000201
202% code is the most difficult one...
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000203\newcommand{\code}[1]{{\@vobeyspaces\@noligs\def\{{\char`\{}\def\}{\char`\}}\def\~{\char`\~}\def\^{\char`\^}\def\e{\char`\\}\def\${\char`\$}\def\#{\char`\#}\def\&{\char`\&}\def\%{\char`\%}%
204\mbox{\tt #1}}}
Guido van Rossumecae0b71996-06-26 19:03:20 +0000205
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000206\newcommand{\kbd}[1]{\mbox{\tt #1}}
207\newcommand{\key}[1]{\mbox{\tt #1}}
208\newcommand{\samp}[1]{\mbox{`\code{#1}'}}
209\newcommand{\var}[1]{\mbox{\it#1\/}}
210\let\file=\samp
Guido van Rossum45416021995-03-30 16:00:58 +0000211\newcommand{\dfn}[1]{{\em #1\/}}
Guido van Rossumecae0b71996-06-26 19:03:20 +0000212\renewcommand{\emph}[1]{{\em #1\/}}
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000213\newcommand{\strong}[1]{{\bf #1}}
214
Fred Drake9b550d91996-11-11 20:43:46 +0000215\newcommand{\varvars}[1]{{\def\,{\/{\char`\,}}\var{#1}}}
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000216
217\newif\iftexi\texifalse
Guido van Rossumecae0b71996-06-26 19:03:20 +0000218\newif\iflatex\latextrue
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000219
Guido van Rossume7af5a01994-08-01 12:39:35 +0000220\newenvironment{tableii}[4]{\begin{center}\def\lineii##1##2{\csname#2\endcsname{##1}&##2\\}\begin{tabular}{#1}\hline#3&#4\\
221\hline}{\hline\end{tabular}\end{center}}
222
Guido van Rossum95cd2ef1992-12-08 14:37:55 +0000223\newenvironment{tableiii}[5]{\begin{center}\def\lineiii##1##2##3{\csname#2\endcsname{##1}&##2&##3\\}\begin{tabular}{#1}\hline#3&#4&#5\\
224\hline}{\hline\end{tabular}\end{center}}
225
226\newcommand{\itemnewline}[1]{\@tempdima\linewidth
227\advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}}
228
229\newcommand{\sectcode}[1]{{\tt #1}}
Guido van Rossume3d5fc51997-07-17 18:27:53 +0000230
231% Cross-referencing (AMK)
232% Sample usage:
233% \begin{seealso}
234% \seemodule{rand}{Uniform random number generator}; % Module xref
235% \seetext{{\em Encyclopedia Britannica}}. % Ref to a book
236% \end{seealso}
237
238\newenvironment{seealso}[0]{{\bf See Also: }}{\par}
239\newcommand{\seemodule}[2]{\ref{module-#1}: {\tt #1} (#2)}
240\newcommand{\seetext}[1]{\par{#1}}