cpython-lru_cache-weakref: Doc/texinputs/python.sty annotate

annotate Doc/texinputs/python.sty @ 8229:df752c08b462 legacy-trunk

\itembreak, \itemjoin, \kwindex: Revived definitions to support the Python Reference Manual.

author	Fred Drake <fdrake@acm.org>
date	Wed, 06 May 1998 19:36:01 +0000
parents	25c2aea64501
children	4674cd2f6f07

rev	line source
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1 %
7592 09440606aac5 Oops; file copy error somewhere along the way.... Fred Drake <fdrake@acm.org> parents: 7585 diff changeset	2 % python.sty for the Python docummentation [works only with with Latex2e]
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	3 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	4
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	5 \NeedsTeXFormat{LaTeX2e}[1995/12/01]
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	6 \ProvidesPackage{python}
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	7 [1998/01/11 LaTeX package (Python markup)]
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	8
7778 b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	9 % These packages can be used to add marginal annotations which indicate
b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	10 % index entries and labels; useful for reviewing this messy documentation!
b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	11 %
b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	12 %\RequirePackage{showkeys}
b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	13 %\RequirePackage{showidx}
b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	14
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	15 % for PDF output, use maximal compression & a lot of other stuff
5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	16 % (test for PDF recommended by Tanmoy Bhattacharya <tanmoy@qcd.lanl.gov>)
5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	17 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	18 \newif\ifpy@doing@page@targets
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	19 \py@doing@page@targetsfalse
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	20
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	21 \ifx\pdfoutput\undefined\else\ifcase\pdfoutput
5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	22 \else
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	23 \input{pdfcolor}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	24 \let\py@LinkColor=\NavyBlue
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	25 \let\py@NormalColor=\Black
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	26 \pdfcompresslevel=9
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	27 %
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	28 % Pad the number with '0' to 3 digits wide so no page name is a prefix
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	29 % of any other.
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	30 %
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	31 \def\py@targetno#1{\ifnum#1<100 0\fi\ifnum#1<10 0\fi#1}
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	32 \def\py@pageno{\py@targetno\thepage}
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	33 %
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	34 % This definition allows the entries in the page-view of the ToC to be
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	35 % active links. Some work, some don't.
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	36 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	37 \let\py@OldContentsline=\contentsline
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	38 % Compute the padded page number separately since we end up with a pair of
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	39 % \relax tokens; this gets the right string computed and works.
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	40 \renewcommand{\contentsline}[3]{%
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	41 \def\my@pageno{\py@targetno{#3}}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	42 \py@OldContentsline{#1}{%
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	43 \pdfannotlink attr{/Border [0 0 0]} goto name{page\my@pageno}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	44 \py@LinkColor#2\py@NormalColor%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	45 \pdfendlink%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	46 }{#3}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	47 }
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	48 %
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	49 % This is supposed to build the "outline" view of the document; it seems
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	50 % quite fragile. The breakages are the same as in the ToC.
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	51 %
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	52 \AtEndDocument{
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	53 \InputIfFileExists{\jobname.bkm}{\pdfcatalog{/PageMode /UseOutlines}}{}
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	54 }
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	55 \newcommand{\py@target}[1]{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	56 \ifpy@doing@page@targets%
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	57 {\pdfdest name{#1} fit}%
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	58 \fi%
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	59 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	60 \let\py@OldLabel=\label
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	61 \renewcommand{\label}[1]{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	62 \py@OldLabel{#1}%
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	63 \py@target{label-#1}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	64 }
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	65 % This stuff adds a page# destination to every PDF page, where # has
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	66 % the same formatting as the displayed page number. This doesn't really
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	67 % help with the frontmatter, but does fine with the body.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	68 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	69 % This is heavily based on the hyperref package.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	70 %
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	71 \def\@begindvi{%
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	72 \unvbox \@begindvibox
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	73 \@hyperfixhead
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	74 }
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	75 \def\@hyperfixhead{%
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	76 \let\H@old@thehead\@thehead
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	77 \global\def\@foo{\py@target{page\py@pageno}}%
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	78 \expandafter\ifx\expandafter\@empty\H@old@thehead
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	79 \def\H@old@thehead{\hfil}\fi
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	80 \def\@thehead{\@foo\relax\H@old@thehead}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	81 }
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	82 \fi\fi
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	83
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	84 % Increase printable page size (copied from fullpage.sty)
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	85 \topmargin 0pt
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	86 \advance \topmargin by -\headheight
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	87 \advance \topmargin by -\headsep
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	88
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	89 % attempt to work a little better for A4 users
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	90 \@ifundefined{paperheight}{
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	91 \textheight 9in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	92 }{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	93 \textheight \paperheight
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	94 \advance\textheight by -2in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	95 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	96
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	97 \oddsidemargin 0pt
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	98 \evensidemargin \oddsidemargin
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	99 \marginparwidth 0.5in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	100
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	101 \@ifundefined{paperwidth}{
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	102 \textwidth 6.5in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	103 }{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	104 \textwidth \paperwidth
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	105 \advance\textwidth by -2in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	106 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	107
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	108
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	109 % Style parameters and macros used by most documents here
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	110 \raggedbottom
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	111 \sloppy
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	112 \parindent = 0mm
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	113 \parskip = 2mm
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	114 \hbadness = 5000 % don't print trivial gripes
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	115
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	116 \pagestyle{empty} % start this way; change for
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	117 \pagenumbering{roman} % ToC & chapters
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	118 \setcounter{secnumdepth}{1}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	119
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	120 % Use this to set the font family for headers and other decor:
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	121 \newcommand{\py@HeaderFamily}{\sffamily}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	122
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	123 % Redefine the 'normal' header/footer style when using "fancyhdr" package:
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	124 \@ifundefined{fancyhf}{}{
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	125 % Use \pagestyle{normal} as the primary pagestyle for text.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	126 \fancypagestyle{normal}{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	127 \fancyhf{}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	128 \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	129 \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	130 \fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	131 \renewcommand{\headrulewidth}{0pt}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	132 \renewcommand{\footrulewidth}{0.4pt}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	133 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	134 % Update the plain style so we get the page number & footer line,
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	135 % but not a chapter or section title. This is to keep the first
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	136 % page of a chapter and the blank page between chapters `clean.'
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	137 \fancypagestyle{plain}{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	138 \fancyhf{}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	139 \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	140 \renewcommand{\headrulewidth}{0pt}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	141 \renewcommand{\footrulewidth}{0.4pt}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	142 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	143 % Redefine \cleardoublepage so that the blank page between chapters
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	144 % gets the plain style and not the fancy style. This is described
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	145 % in the documentation for the fancyhdr package by Piet von Oostrum.
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	146 \@ifundefined{chapter}{}{
7548 7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	147 \renewcommand{\cleardoublepage}{
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	148 \clearpage\if@openright \ifodd\c@page\else
7548 7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	149 \hbox{}
7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	150 \thispagestyle{plain}
7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	151 \newpage
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	152 \if@twocolumn\hbox{}\newpage\fi\fi\fi
7548 7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	153 }
7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	154 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	155 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	156
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	157 % This sets up the {verbatim} environment to be indented and a minipage,
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	158 % and to have all the other mostly nice properties that we want for
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	159 % code samples.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	160
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	161 % Variable used by begin code command
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	162 \newlength{\py@codewidth}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	163
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	164 \newcommand{\py@examplevspace}{2mm}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	165 \newcommand{\py@exampleindent}{1cm}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	166
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	167 \let\py@OldVerbatim=\verbatim
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	168 \let\py@OldEndVerbatim=\endverbatim
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	169 \renewcommand{\verbatim}{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	170 \begingroup%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	171 \setlength{\parindent}\py@exampleindent%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	172 % Calculate the text width for the minipage:
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	173 \setlength{\py@codewidth}{\linewidth}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	174 \addtolength{\py@codewidth}{-\parindent}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	175 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	176 \par%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	177 \vspace\py@examplevspace%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	178 \indent%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	179 \begin{minipage}[t]{\py@codewidth}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	180 \small%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	181 \py@OldVerbatim%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	182 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	183 \renewcommand{\endverbatim}{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	184 \py@OldEndVerbatim%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	185 \end{minipage}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	186 \endgroup%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	187 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	188
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	189 \newcommand{\reset@python}{
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	190 \global\let\py@thisclass=\@undefined
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	191 \global\let\py@thismodule=\@undefined
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	192 }
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	193 \reset@python
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	194
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	195 % Augment the sectioning commands used to get our own font family in place,
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	196 % and reset some internal data items:
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	197 \renewcommand{\section}{\reset@python%
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	198 \@startsection{section}{1}{\z@}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	199 {-3.5ex \@plus -1ex \@minus -.2ex}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	200 {2.3ex \@plus.2ex}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	201 {\reset@font\Large\py@HeaderFamily}}
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	202 \renewcommand{\subsection}{\@startsection{subsection}{2}{\z@}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	203 {-3.25ex\@plus -1ex \@minus -.2ex}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	204 {1.5ex \@plus .2ex}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	205 {\reset@font\large\py@HeaderFamily}}
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	206 \renewcommand{\subsubsection}{\@startsection{subsubsection}{3}{\z@}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	207 {-3.25ex\@plus -1ex \@minus -.2ex}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	208 {1.5ex \@plus .2ex}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	209 {\reset@font\normalsize\py@HeaderFamily}}
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	210 \renewcommand{\paragraph}{\@startsection{paragraph}{4}{\z@}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	211 {3.25ex \@plus1ex \@minus.2ex}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	212 {-1em}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	213 {\reset@font\normalsize\py@HeaderFamily}}
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	214 \renewcommand{\subparagraph}{\@startsection{subparagraph}{5}{\parindent}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	215 {3.25ex \@plus1ex \@minus .2ex}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	216 {-1em}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	217 {\reset@font\normalsize\py@HeaderFamily}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	218
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	219
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	220 % Underscore hack (only act like subscript operator if in math mode)
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	221 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	222 % The following is due to Mark Wooding (the old version didn't work with
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	223 % Latex 2e.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	224
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	225 \DeclareRobustCommand\hackscore{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	226 \ifmmode_\else\textunderscore\fi%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	227 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	228 \begingroup
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	229 \catcode`\_\active
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	230 \def\next{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	231 \AtBeginDocument{\catcode`\_\active\def_{\hackscore{}}}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	232 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	233 \expandafter\endgroup\next
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	234
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	235
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	236 %% Lots of index-entry generation support.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	237
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	238 % Command to wrap around stuff that refers to function / module /
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	239 % attribute names in the index. Default behavior: like \code{}. To
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	240 % just keep the index entries in the roman font, uncomment the second
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	241 % definition to use instead; it matches O'Reilly style more.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	242 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	243 \newcommand{\py@idxcode}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	244 %\renewcommand{\py@idxcode}[1]{#1}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	245
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	246 % Command to generate two index entries (using subentries)
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	247 \newcommand{\indexii}[2]{\index{#1!#2}\index{#2!#1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	248
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	249 % And three entries (using only one level of subentries)
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	250 \newcommand{\indexiii}[3]{\index{#1!#2 #3}\index{#2!#3, #1}\index{#3!#1 #2}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	251
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	252 % And four (again, using only one level of subentries)
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	253 \newcommand{\indexiv}[4]{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	254 \index{#1!#2 #3 #4}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	255 \index{#2!#3 #4, #1}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	256 \index{#3!#4, #1 #2}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	257 \index{#4!#1 #2 #3}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	258 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	259
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	260 % Command to generate a reference to a function, statement, keyword,
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	261 % operator.
8229 df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	262 \newcommand{\kwindex}[1]{\indexii{keyword}{#1@{\py@idxcode{#1}}}}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	263 \newcommand{\stindex}[1]{\indexii{statement}{#1@{\py@idxcode{#1}}}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	264 \newcommand{\opindex}[1]{\indexii{operator}{#1@{\py@idxcode{#1}}}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	265 \newcommand{\exindex}[1]{\indexii{exception}{#1@{\py@idxcode{#1}}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	266 \newcommand{\obindex}[1]{\indexii{object}{#1}}
7792 8d4148213cc0 \bifuncindex: Fix so entries combine correctly with those of the built-in Fred Drake <fdrake@acm.org> parents: 7786 diff changeset	267 \newcommand{\bifuncindex}[1]{\withsubitem{(built-in function)}{\ttindex{#1()}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	268
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	269 % Add an index entry for a module
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	270 \newcommand{\py@refmodule}[2]{\index{#1@{\py@idxcode{#1}} (#2module)}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	271 \newcommand{\refmodindex}[1]{\py@refmodule{#1}{}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	272 \newcommand{\refbimodindex}[1]{\py@refmodule{#1}{built-in }}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	273 \newcommand{\refexmodindex}[1]{\py@refmodule{#1}{extension }}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	274 \newcommand{\refstmodindex}[1]{\py@refmodule{#1}{standard }}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	275
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	276 % support for the module index
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	277 \newif\ifpy@UseModuleIndex
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	278 \py@UseModuleIndexfalse
7617 068a6942fe1a Adjust the index support a bit to make it easier to deal with module index. Fred Drake <fdrake@acm.org> parents: 7597 diff changeset	279
068a6942fe1a Adjust the index support a bit to make it easier to deal with module index. Fred Drake <fdrake@acm.org> parents: 7597 diff changeset	280 \newcommand{\makemodindex}{
068a6942fe1a Adjust the index support a bit to make it easier to deal with module index. Fred Drake <fdrake@acm.org> parents: 7597 diff changeset	281 \newwrite\modindexfile
068a6942fe1a Adjust the index support a bit to make it easier to deal with module index. Fred Drake <fdrake@acm.org> parents: 7597 diff changeset	282 \openout\modindexfile=mod\jobname.idx
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	283 \py@UseModuleIndextrue
7617 068a6942fe1a Adjust the index support a bit to make it easier to deal with module index. Fred Drake <fdrake@acm.org> parents: 7597 diff changeset	284 }
068a6942fe1a Adjust the index support a bit to make it easier to deal with module index. Fred Drake <fdrake@acm.org> parents: 7597 diff changeset	285
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	286 % Add the defining entry for a module
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	287 \newcommand{\py@modindex}[2]{%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	288 \global\def\py@thismodule{#1}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	289 \setindexsubitem{(in module #1)}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	290 \index{#1@{\py@idxcode{#1}} (#2module)\|textbf}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	291 \ifpy@UseModuleIndex%
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	292 \write\modindexfile{\protect\indexentry{#1@{\tt #1}}{\thepage}}%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	293 \fi%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	294 }
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	295
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	296 % built-in & Python modules in the main distribution
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	297 \newcommand{\bimodindex}[1]{\py@modindex{#1}{built-in }}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	298 \newcommand{\stmodindex}[1]{\py@modindex{#1}{standard }}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	299
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	300 % Python & extension modules outside the main distribution
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	301 \newcommand{\modindex}[1]{\py@modindex{#1}{}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	302 \newcommand{\exmodindex}[1]{\py@modindex{#1}{extension }}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	303
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	304 % Additional string for an index entry
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	305 \newcommand{\index@subitem}{}
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	306 \newcommand{\setindexsubitem}[1]{\renewcommand{\index@subitem}{#1}}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	307 \newcommand{\ttindex}[1]{\index{#1@{\py@idxcode{#1}} \index@subitem}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	308
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	309 \newcommand{\withsubitem}[2]{%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	310 \begingroup%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	311 \def\index@subitem{#1}#2%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	312 \endgroup%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	313 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	314
7801 047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	315
047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	316 % Now for a lot of semantically-loaded environments that do a ton of magical
047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	317 % things to get the right formatting and index entries for the stuff in
047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	318 % Python modules and C API.
047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	319
047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	320
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	321 % {fulllineitems} is used in one place in libregex.tex, but is really for
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	322 % internal use in this file.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	323 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	324 \newenvironment{fulllineitems}{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	325 \begin{list}{}{\labelwidth \leftmargin \labelsep 0pt
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	326 \rightmargin 0pt \topsep -\parskip \partopsep \parskip
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	327 \itemsep -\parsep
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	328 \let\makelabel=\itemnewline}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	329 }{\end{list}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	330
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	331 % \optional is mostly for use in the arguments parameters to the various
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	332 % {*desc} environments defined below, but may be used elsewhere. Known to
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	333 % be used in the debugger chapter.
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	334 %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	335 % Typical usage:
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	336 %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	337 % \begin{funcdesc}{myfunc}{reqparm\optional{, optparm}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	338 % ^^^ ^^^
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	339 % No space here No space here
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	340 %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	341 % When a function has multiple optional parameters, \optional should be
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	342 % nested, not chained. This is right:
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	343 %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	344 % \begin{funcdesc}{myfunc}{\optional{parm1\optional{, parm2}}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	345 %
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	346 \newcommand{\optional}[1]{%
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	347 {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	348
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	349 % C functions ------------------------------------------------------------
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	350 % \begin{cfuncdesc}{type}{name}{arglist}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	351 \newenvironment{cfuncdesc}[3]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	352 \begin{fulllineitems}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	353 \item[\code{#1 \bfcode{#2}(\py@varvars{#3})}\index{#2@{\py@idxcode{#2()}}}]
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	354 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	355
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	356 % C variables ------------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	357 % \begin{cvardesc}{type}{name}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	358 \newenvironment{cvardesc}[2]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	359 \begin{fulllineitems}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	360 \item[\code{#1 \bfcode{#2}}\index{#2@{\py@idxcode{#2}}}]
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	361 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	362
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	363 % C data types -----------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	364 % \begin{ctypedesc}{typedef name}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	365 \newenvironment{ctypedesc}[1]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	366 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	367 \item[\bfcode{#1}\ttindex{#1}]
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	368 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	369
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	370 % simple functions (not methods) -----------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	371 % \begin{funcdesc}{name}{args}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	372 \newcommand{\funcline}[2]{\funclineni{#1}{#2}\ttindex{#1()}}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	373 \newenvironment{funcdesc}[2]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	374 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	375 \funcline{#1}{#2}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	376 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	377
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	378 % similar to {funcdesc}, but doesn't add to the index
8075 e39145a13096 Hide \varvars from "public" interface. Fred Drake <fdrake@acm.org> parents: 8067 diff changeset	379 \newcommand{\funclineni}[2]{\item[\code{\bfcode{#1}(\py@varvars{#2})}]}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	380 \newenvironment{funcdescni}[2]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	381 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	382 \funclineni{#1}{#2}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	383 }{\end{fulllineitems}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	384
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	385 % classes ----------------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	386 % \begin{classdesc}{name}{constructor args}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	387 \newenvironment{classdesc}[2]{
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	388 \global\def\py@thisclass{#1}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	389 \begin{fulllineitems}
8075 e39145a13096 Hide \varvars from "public" interface. Fred Drake <fdrake@acm.org> parents: 8067 diff changeset	390 \item[\code{\bfcode{#1}(\py@varvars{#2})}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	391 \withsubitem{(class in \py@thismodule)}{\ttindex{#1}}]
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	392 }{\end{fulllineitems}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	393
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	394
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	395 \let\py@classbadkey=\@undefined
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	396
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	397 % object method ----------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	398 % \begin{methoddesc}[classname]{methodname}{args}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	399 \newcommand{\methodline}[3][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	400 \methodlineni{#2}{#3}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	401 \ifx#1\@undefined
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	402 \withsubitem{(\py@thisclass\ method)}{\ttindex{#2()}}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	403 \else
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	404 \withsubitem{(#1 method)}{\ttindex{#2()}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	405 \fi
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	406 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	407 \newenvironment{methoddesc}[3][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	408 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	409 \ifx#1\@undefined
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	410 \methodline{#2}{#3}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	411 \else
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	412 \def\py@thisclass{#1}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	413 \methodline[#1]{#2}{#3}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	414 \fi
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	415 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	416
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	417 % similar to {methoddesc}, but doesn't add to the index
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	418 % (never actually uses the optional argument)
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	419 \newcommand{\methodlineni}[3][\py@classbadkey]{%
8075 e39145a13096 Hide \varvars from "public" interface. Fred Drake <fdrake@acm.org> parents: 8067 diff changeset	420 \item[\code{\bfcode{#2}(\py@varvars{#3})}]}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	421 \newenvironment{methoddescni}[3][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	422 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	423 \methodlineni{#2}{#3}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	424 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	425
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	426 % object data attribute --------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	427 % \begin{memberdesc}[classname]{membername}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	428 \newcommand{\memberline}[2][\py@classbadkey]{%
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	429 \ifx#1\@undefined
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	430 \memberlineni{#2}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	431 \withsubitem{(\py@thisclass\ attribute)}{\ttindex{#2}}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	432 \else
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	433 \memberlineni{#2}
7898 6a0299ebccef Data attributes of objects should not be indexed with trailing parentheses! Fred Drake <fdrake@acm.org> parents: 7850 diff changeset	434 \withsubitem{(#1 attribute)}{\ttindex{#2}}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	435 \fi
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	436 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	437 \newenvironment{memberdesc}[2][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	438 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	439 \ifx#1\@undefined
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	440 \memberline{#2}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	441 \else
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	442 \def\py@thisclass{#1}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	443 \memberline[#1]{#2}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	444 \fi
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	445 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	446
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	447 % similar to {memberdesc}, but doesn't add to the index
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	448 % (never actually uses the optional argument)
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	449 \newcommand{\memberlineni}[2][\py@classbadkey]{\item[\bfcode{#2}]}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	450 \newenvironment{memberdescni}[2][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	451 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	452 \memberlineni{#2}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	453 }{\end{fulllineitems}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	454
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	455 % For exceptions: --------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	456 % \begin{excdesc}{name}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	457 % -- need support for constructor; maybe use optional parameter?
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	458 \newenvironment{excdesc}[1]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	459 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	460 \item[\bfcode{#1}\ttindex{#1}]
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	461 }{\end{fulllineitems}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	462
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	463 % Module data or constants: ----------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	464 % \begin{datadesc}{name}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	465 \newcommand{\dataline}[1]{\datalineni{#1}\ttindex{#1}}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	466 \newenvironment{datadesc}[1]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	467 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	468 \dataline{#1}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	469 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	470
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	471 % similar to {datadesc}, but doesn't add to the index
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	472 \newcommand{\datalineni}[1]{\item[\bfcode{#1}]\nopagebreak}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	473 \newenvironment{datadescni}[1]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	474 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	475 \datalineni{#1}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	476 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	477
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	478 % bytecode instruction ---------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	479 % \begin{opcodedesc}{name}{var}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	480 % -- {var} may be {}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	481 \newenvironment{opcodedesc}[2]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	482 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	483 \item[\bfcode{#1}\quad\var{#2}]
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	484 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	485
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	486
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	487 \newcommand{\nodename}[1]{\label{#1}}
7740 423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	488
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	489 % For these commands, use \command{} to get the typography right, not
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	490 % {\command}. This works better with the texinfo translation.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	491 \newcommand{\ABC}{{\sc abc}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	492 \newcommand{\UNIX}{{\sc Unix}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	493 \newcommand{\POSIX}{POSIX}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	494 \newcommand{\ASCII}{{\sc ascii}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	495 \newcommand{\Cpp}{C\protect\raisebox{.18ex}{++}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	496 \newcommand{\C}{C}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	497 \newcommand{\EOF}{{\sc eof}}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	498 \newcommand{\NULL}{\constant{NULL}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	499
7801 047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	500 % Also for consistency: spell Python "Python", not "python"!
047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	501
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	502 % code is the most difficult one...
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	503 \newcommand{\code}[1]{{\@vobeyspaces\@noligs\def\{{\char`\{}\def\}{\char`\}}\def\~{\char`\~}\def\^{\char`\^}\def\e{\char`\\}\def\${\char`\$}\def\#{\char`\#}\def\&{\char`\&}\def\%{\char`\%}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	504 \texttt{#1}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	505
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	506 \newcommand{\bfcode}[1]{\code{\bfseries#1}} % bold-faced code font
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	507 \newcommand{\kbd}[1]{\tt #1}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	508 \newcommand{\samp}[1]{`\code{#1}'}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	509 % This weird definition of \var{} allows it to always appear in roman
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	510 % italics, and won't get funky in code fragments when we play around
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	511 % with fonts.
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	512 \newcommand{\var}[1]{\normalsize\textrm{\textit{#1\/}}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	513 \renewcommand{\emph}[1]{{\em #1}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	514 \newcommand{\dfn}[1]{\emph{#1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	515 \newcommand{\strong}[1]{{\bf #1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	516 % let's experiment with a new font:
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	517 \newcommand{\file}[1]{`{\small\textsf{#1}}'}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	518
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	519 % Use this def/redef approach for \url{} since hyperref defined this already,
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	520 % but only if we actually used hyperref:
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	521 \@ifundefined{pdfannotlink}{
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	522 \newcommand{\py@url}[1]{\mbox{\small\textsf{#1}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	523 }{
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	524 \newcommand{\py@url}[1]{{%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	525 \pdfannotlink attr{/Border [0 0 0]} user{/S /URI /URI (#1)}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	526 \py@LinkColor% color of the link text
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	527 \mbox{\small\textsf{#1}}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	528 \py@NormalColor% Turn it back off; these are declarative
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	529 \pdfendlink}% and don't appear bound to the current
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	530 }% formatting "box".
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	531 }
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	532 \let\url=\py@url
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	533 \newcommand{\email}[1]{{\small\textsf{#1}}}
7778 b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	534 \newcommand{\newsgroup}[1]{{\small\textsf{#1}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	535
8075 e39145a13096 Hide \varvars from "public" interface. Fred Drake <fdrake@acm.org> parents: 8067 diff changeset	536 \newcommand{\py@varvars}[1]{{\def\,{\/{\char`\,}}\var{#1}}}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	537 % let's see if this breaks anything now; we may be able to simplify...
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	538 \renewcommand{\py@varvars}[1]{\var{#1}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	539
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	540 % I'd really like to get rid of this!
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	541 \newif\iftexi\texifalse
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	542
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	543 % These should be used for all references to identifiers which are
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	544 % used to refer to instances of specific language constructs. See the
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	545 % names for specific semantic assignments.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	546 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	547 % For now, don't do anything really fancy with them; just use them as
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	548 % logical markup. This might change in the future.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	549 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	550 \newcommand{\module}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	551 \newcommand{\keyword}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	552 \newcommand{\exception}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	553 \newcommand{\class}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	554 \newcommand{\function}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	555 \newcommand{\member}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	556 \newcommand{\method}[1]{\texttt{#1}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	557
7801 047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	558 \newcommand{\pytype}[1]{#1} % built-in Python type
047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	559
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	560 \newcommand{\cfunction}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	561 \newcommand{\ctype}[1]{\texttt{#1}} % C struct or typedef name
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	562 \newcommand{\cdata}[1]{\texttt{#1}} % C variable, typically global
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	563
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	564 \newcommand{\mimetype}[1]{{\small\textsf{#1}}}
7670 8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	565 % The \! is a "negative thin space" in math mode.
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	566 \newcommand{\regexp}[1]{%
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	567 {\tiny$^{^\lceil}\!\!$%
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	568 {\normalsize\code{#1}}%
7850 db1e49d51fe1 Increase space between the end of a regexp and the little right floor symbol Fred Drake <fdrake@acm.org> parents: 7801 diff changeset	569 $\!\rfloor\!$%
7670 8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	570 }}
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	571 \newcommand{\envvar}[1]{%
7670 8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	572 \$#1% $ <-- bow to font-lock 3 times!
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	573 \index{#1@{\$#1}}% $
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	574 \index{environment variables!{\$#1}}% $
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	575 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	576 \newcommand{\makevar}[1]{#1} % variable in a Makefile
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	577 \newcommand{\character}[1]{\samp{#1}}
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	578
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	579 % constants defined in Python modules or C headers, not language constants:
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	580 \newcommand{\constant}[1]{\code{#1}} % manifest constant, not syntactic
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	581
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	582 \newcommand{\manpage}[2]{{\emph{#1}(#2)}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	583 \newcommand{\rfc}[1]{RFC #1\index{RFC!RFC #1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	584 \newcommand{\program}[1]{\strong{#1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	585
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	586
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	587 % Deprecation stuff.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	588 % Should be extended to allow an index / list of deprecated stuff. But
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	589 % there's a lot of stuff that needs to be done to make that automatable.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	590 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	591 % First parameter is the release number that deprecates the feature, the
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	592 % second is the action the should be taken by users of the feature.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	593 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	594 % Example:
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	595 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	596 % \deprecated{1.5.1}{Use \method{frobnicate()} instead.}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	597 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	598 \newcommand{\deprecated}[2]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	599 \strong{Deprecated since release #1.} #2\par}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	600
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	601
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	602 \newenvironment{tableii}[4]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	603 \begin{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	604 \def\lineii##1##2{\csname#2\endcsname{##1}&##2\\}%
8018 011ae71fea96 Lighten up tables. Fred Drake <fdrake@acm.org> parents: 7898 diff changeset	605 \begin{tabular}{#1}\strong{#3}&\strong{#4} \\ \hline%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	606 }{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	607 \end{tabular}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	608 \end{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	609 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	610
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	611 \newenvironment{tableiii}[5]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	612 \begin{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	613 \def\lineiii##1##2##3{\csname#2\endcsname{##1}&##2&##3\\}%
8018 011ae71fea96 Lighten up tables. Fred Drake <fdrake@acm.org> parents: 7898 diff changeset	614 \begin{tabular}{#1}\strong{#3}&\strong{#4}&\strong{#5} \\ \hline%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	615 }{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	616 \end{tabular}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	617 \end{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	618 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	619
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	620 \newcommand{\itemnewline}[1]{%
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	621 \@tempdima\linewidth%
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	622 \advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	623 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	624
8229 df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	625 % Define \itembreak: force the text after an item to start on a new line
df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	626 \newcommand{\itembreak}{%
df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	627 \mbox{}%
df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	628 \\*[0mm]%
df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	629 }
df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	630
df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	631 % Define \itemjoin: some negative vspace to join two items together
df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	632 \newcommand{\itemjoin}{%
df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	633 \mbox{}%
df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	634 \vspace{-\itemsep}%
df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	635 \vspace{-\parsep}%
df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	636 }
df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	637
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	638 % Cross-referencing (AMK, new impl. FLD)
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	639 % Sample usage:
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	640 % \begin{seealso}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	641 % \seemodule{rand}{Uniform random number generator}; % Module xref
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	642 % \seetext{\emph{Encyclopedia Britannica}}. % Ref to a book
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	643 %
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	644 % % A funky case: module name contains '_'; have to supply an optional key
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	645 % \seemodule[copyreg]{copy_reg}{pickle interface constructor registration}
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	646 %
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	647 % \end{seealso}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	648
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	649 \newcommand{\py@modulebadkey}{{--just-some-junk--}}
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	650
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	651 \@ifundefined{pdfannotlink}{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	652 \newcommand{\py@seemodule}[3][\py@modulebadkey]{%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	653 \ifx\py@modulebadkey#1\def\py@modulekey{#2}\else\def\py@modulekey{#1}\fi%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	654 \ref{module-\py@modulekey}:\quad %
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	655 Module \module{#2}%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	656 \quad (#3)%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	657 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	658 }{\newcommand{\py@seemodule}[3][\py@modulebadkey]{%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	659 \ifx\py@modulebadkey#1\def\py@modulekey{#2}\else\def\py@modulekey{#1}\fi%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	660 \ref{module-\py@modulekey}:\quad %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	661 {\pdfannotlink attr{/Border [0 0 0]} goto name{label-module-\py@modulekey}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	662 \py@LinkColor Module \module{#2} \py@NormalColor%
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	663 \pdfendlink%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	664 }%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	665 \quad (#3)%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	666 }
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	667 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	668 \newenvironment{seealso}[0]{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	669 \strong{See Also:}\par
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	670 \def\seetext##1{\par{##1}}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	671 \let\seemodule=\py@seemodule
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	672 }{\par}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	673
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	674
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	675 % Allow the release number to be specified independently of the
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	676 % \date{}. This allows the date to reflect the document's date and
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	677 % release to specify the Python release that is documented.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	678 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	679 \newcommand{\py@release}{}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	680 \newcommand{\version}{}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	681 \newcommand{\releasename}{Release}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	682 \newcommand{\release}[1]{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	683 \renewcommand{\py@release}{\releasename\space\version}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	684 \renewcommand{\version}{#1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	685
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	686 % Allow specification of the author's address separately from the
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	687 % author's name. This can be used to format them differently, which
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	688 % is a good thing.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	689 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	690 \newcommand{\py@authoraddress}{}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	691 \newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	692
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	693 % This sets up the fancy chapter headings that make the documents look
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	694 % at least a little better than the usual LaTeX output.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	695 %
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	696 \@ifundefined{ChTitleVar}{}{
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	697 \ChNameVar{\raggedleft\normalsize\py@HeaderFamily}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	698 \ChNumVar{\raggedleft \bfseries\Large\py@HeaderFamily}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	699 \ChTitleVar{\raggedleft \rm\Huge\py@HeaderFamily}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	700 % This creates chapter heads without the leading \vspace*{}:
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	701 \def\@makechapterhead#1{%
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	702 {\parindent \z@ \raggedright \normalfont
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	703 \ifnum \c@secnumdepth >\m@ne
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	704 \DOCH
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	705 \fi
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	706 \interlinepenalty\@M
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	707 \DOTI{#1}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	708 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	709 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	710 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	711
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	712 % Tell TeX about pathological hyphenation cases:
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	713 \hyphenation{Base-HTTP-Re-quest-Hand-ler}

Mercurial > cpython-lru_cache-weakref

annotate Doc/texinputs/python.sty @ 8229:df752c08b462 legacy-trunk