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

annotate Doc/texinputs/python.sty @ 9524:c6a1103efa8a legacy-trunk

Minor nit that fixes a bunch of indexing: the way the classdesc environment saves the name of the last class described, method and member descriptions were not picking it up correctly. Thus, many index entries were described as "( method)" instead of "(FooClass method)". Multiple entries were collapsed in the index when methods/members from multiple classes share the same name.

author	Fred Drake <fdrake@acm.org>
date	Wed, 25 Nov 1998 17:13:28 +0000
parents	18f81faf4bd9
children	1437c2335b3b

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
8306 4674cd2f6f07 Set the right page size in the PDF output. Fred Drake <fdrake@acm.org> parents: 8229 diff changeset	27 \pdfpagewidth=\paperwidth % page width of PDF output
4674cd2f6f07 Set the right page size in the PDF output. Fred Drake <fdrake@acm.org> parents: 8229 diff changeset	28 \pdfpageheight=\paperheight % page height of PDF output
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	29 %
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	30 % 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	31 % of any other.
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	32 %
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	33 \newcommand{\py@targetno}[1]{\ifnum#1<100 0\fi\ifnum#1<10 0\fi#1}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	34 \newcommand{\py@pageno}{\py@targetno\thepage}
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	35 %
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	36 % 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	37 % 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	38 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	39 \let\py@OldContentsline=\contentsline
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	40 % 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	41 % \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	42 \renewcommand{\contentsline}[3]{%
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	43 \def\my@pageno{\py@targetno{#3}}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	44 \py@OldContentsline{#1}{%
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	45 \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	46 \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	47 \pdfendlink%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	48 }{#3}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	49 }
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	50 \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	51 \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	52 }
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	53 \newcommand{\py@target}[1]{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	54 \ifpy@doing@page@targets%
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	55 {\pdfdest name{#1} fit}%
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	56 \fi%
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	57 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	58 \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	59 \renewcommand{\label}[1]{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	60 \py@OldLabel{#1}%
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	61 \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	62 }
8306 4674cd2f6f07 Set the right page size in the PDF output. Fred Drake <fdrake@acm.org> parents: 8229 diff changeset	63 % This stuff adds a page# destination to every PDF page, where # is three
4674cd2f6f07 Set the right page size in the PDF output. Fred Drake <fdrake@acm.org> parents: 8229 diff changeset	64 % digits wide, padded with leading zeros. This doesn't really help with
4674cd2f6f07 Set the right page size in the PDF output. Fred Drake <fdrake@acm.org> parents: 8229 diff changeset	65 % the frontmatter, but does fine with the body.
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	66 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	67 % 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	68 %
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	69 \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	70 \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	71 \@hyperfixhead
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	72 }
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	73 \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	74 \let\H@old@thehead\@thehead
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	75 \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	76 \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	77 \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	78 \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	79 }
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	80 \fi\fi
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	81
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	82 % 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	83 \topmargin 0pt
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	84 \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	85 \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	86
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	87 % 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	88 \@ifundefined{paperheight}{
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	89 \textheight 9in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	90 }{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	91 \textheight \paperheight
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	92 \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	93 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	94
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	95 \oddsidemargin 0pt
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	96 \evensidemargin \oddsidemargin
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	97 \marginparwidth 0.5in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	98
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	99 \@ifundefined{paperwidth}{
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	100 \textwidth 6.5in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	101 }{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	102 \textwidth \paperwidth
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	103 \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	104 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	105
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 % 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	108 \raggedbottom
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	109 \sloppy
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	110 \parindent = 0mm
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	111 \parskip = 2mm
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	112 \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	113
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	114 \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	115 \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	116 \setcounter{secnumdepth}{1}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	117
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	118 % 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	119 \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	120
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	121 % 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	122 \@ifundefined{fancyhf}{}{
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	123 % 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	124 \fancypagestyle{normal}{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	125 \fancyhf{}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	126 \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	127 \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	128 \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	129 \renewcommand{\headrulewidth}{0pt}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	130 \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	131 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	132 % 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	133 % 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	134 % 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	135 \fancypagestyle{plain}{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	136 \fancyhf{}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	137 \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	138 \renewcommand{\headrulewidth}{0pt}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	139 \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	140 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	141 % 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	142 % 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	143 % 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	144 \@ifundefined{chapter}{}{
7548 7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	145 \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	146 \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	147 \hbox{}
7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	148 \thispagestyle{plain}
7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	149 \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	150 \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	151 }
7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	152 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	153 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	154
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	155 % 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	156 % 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	157 % code samples.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	158
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	159 % Variable used by begin code command
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	160 \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	161
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	162 \newcommand{\py@examplevspace}{2mm}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	163 \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	164
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	165 \let\py@OldVerbatim=\verbatim
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	166 \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	167 \renewcommand{\verbatim}{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	168 \begingroup%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	169 \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	170 % 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	171 \setlength{\py@codewidth}{\linewidth}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	172 \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	173 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	174 \par%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	175 \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	176 \indent%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	177 \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	178 \small%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	179 \py@OldVerbatim%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	180 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	181 \renewcommand{\endverbatim}{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	182 \py@OldEndVerbatim%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	183 \end{minipage}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	184 \endgroup%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	185 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	186
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	187
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	188 \newcommand{\py@modulebadkey}{{--just-some-junk--}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	189
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	190
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	191 %% 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	192
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	193 % 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	194 % 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	195 % just keep the index entries in the roman font, uncomment the second
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	196 % definition; it matches O'Reilly style more.
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	197 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	198 \newcommand{\py@idxcode}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	199 %\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	200
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	201 % 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	202 \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	203
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	204 % 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	205 \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	206
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	207 % 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	208 \newcommand{\indexiv}[4]{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	209 \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	210 \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	211 \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	212 \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	213 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	214
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	215 % 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	216 % operator.
8229 df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	217 \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	218 \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	219 \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	220 \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	221 \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	222 \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	223
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	224 % 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	225 \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	226 \newcommand{\refmodindex}[1]{\py@refmodule{#1}{}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	227 \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	228 \newcommand{\refexmodindex}[1]{\py@refmodule{#1}{extension }}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	229 \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	230
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	231 % support for the module index
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	232 \newif\ifpy@UseModuleIndex
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	233 \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	234
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	235 \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	236 \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	237 \openout\modindexfile=mod\jobname.idx
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	238 \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	239 }
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	240
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	241 % 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	242 \newcommand{\py@modindex}[2]{%
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	243 \renewcommand{\py@thismodule}{#1}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	244 \setindexsubitem{(in module #1)}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	245 \index{#1@{\py@idxcode{#1}} (#2module)\|textbf}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	246 \ifpy@UseModuleIndex%
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	247 \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	248 \fi%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	249 }
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	250
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	251 % 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	252 \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	253 \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	254
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	255 % 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	256 \newcommand{\modindex}[1]{\py@modindex{#1}{}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	257 \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	258
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	259 % 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	260 \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	261 \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	262 \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	263
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	264 \newcommand{\withsubitem}[2]{%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	265 \begingroup%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	266 \def\index@subitem{#1}#2%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	267 \endgroup%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	268 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	269
7801 047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	270
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	271 % Module synopsis processing -----------------------------------------------
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	272 %
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	273 \newcommand{\py@standardIndexModule}[1]{\stmodindex{#1}}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	274 \newcommand{\py@builtinIndexModule}[1]{\bimodindex{#1}}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	275 \newcommand{\py@extensionIndexModule}[1]{\exmodindex{#1}}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	276 \newcommand{\py@IndexModule}[1]{\modindex{#1}}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	277
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	278 \newif\ifpy@HaveModSynopsis\py@HaveModSynopsisfalse
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	279 \newif\ifpy@ModSynopsisFileIsOpen\py@ModSynopsisFileIsOpenfalse
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	280
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	281 % \declaremodule[key]{type}{name}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	282 \newcommand{\declaremodule}[3][\py@modulebadkey]{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	283 \py@openModSynopsisFile
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	284 \renewcommand{\py@thismoduletype}{#2}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	285 \csname py@#2IndexModule\endcsname{#3}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	286 \ifx\py@modulebadkey#1
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	287 \renewcommand{\py@thismodulekey}{#3}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	288 \else
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	289 \renewcommand{\py@thismodulekey}{#1}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	290 \fi
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	291 \label{module-\py@thismodulekey}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	292 \py@HaveModSynopsistrue
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	293 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	294
8916 6b633df41e59 \moduleauthor, Fred Drake <fdrake@acm.org> parents: 8779 diff changeset	295 % \moduleauthor{name}{email}
6b633df41e59 \moduleauthor, Fred Drake <fdrake@acm.org> parents: 8779 diff changeset	296 \newcommand{\moduleauthor}[2]{}
6b633df41e59 \moduleauthor, Fred Drake <fdrake@acm.org> parents: 8779 diff changeset	297
6b633df41e59 \moduleauthor, Fred Drake <fdrake@acm.org> parents: 8779 diff changeset	298 % \sectionauthor{name}{email}
6b633df41e59 \moduleauthor, Fred Drake <fdrake@acm.org> parents: 8779 diff changeset	299 \newcommand{\sectionauthor}[2]{}
6b633df41e59 \moduleauthor, Fred Drake <fdrake@acm.org> parents: 8779 diff changeset	300
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	301
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	302 \newcommand{\py@defsynopsis}{Module has no synopsis.}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	303 \newcommand{\py@modulesynopsis}{\py@defsynopsis}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	304 \newcommand{\modulesynopsis}[1]{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	305 \renewcommand{\py@modulesynopsis}{#1}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	306 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	307
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	308 % define the file
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	309 \newwrite\py@ModSynopsisFile
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	310
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	311 % hacked from \addtocontents from latex.ltx:
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	312 \long\def\py@writeModSynopsisFile#1{%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	313 \protected@write\py@ModSynopsisFile%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	314 {\let\label\@gobble \let\index\@gobble \let\glossary\@gobble}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	315 {\string#1}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	316 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	317 \newcommand{\py@closeModSynopsisFile}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	318 \ifpy@ModSynopsisFileIsOpen
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	319 \closeout\py@ModSynopsisFile
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	320 \py@ModSynopsisFileIsOpenfalse
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	321 \fi
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	322 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	323 \newcommand{\py@openModSynopsisFile}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	324 \ifpy@ModSynopsisFileIsOpen\else
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	325 \openout\py@ModSynopsisFile=\py@ModSynopsisFilename
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	326 \py@ModSynopsisFileIsOpentrue
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	327 \fi
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	328 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	329
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	330 \newcommand{\py@ProcessModSynopsis}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	331 \ifpy@HaveModSynopsis
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	332 \py@writeModSynopsisFile{\modulesynopsis%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	333 {\py@thismodulekey}{\py@thismodule}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	334 {\py@thismoduletype}{\py@modulesynopsis}}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	335 \py@HaveModSynopsisfalse
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	336 \fi
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	337 \renewcommand{\py@modulesynopsis}{\py@defsynopsis}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	338 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	339 \AtEndDocument{\py@ProcessModSynopsis\py@closeModSynopsisFile}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	340
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	341 \newcommand{\localmoduletable}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	342 \IfFileExists{\py@ModSynopsisFilename}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	343 \begin{synopsistable}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	344 \input{\py@ModSynopsisFilename}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	345 \end{synopsistable}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	346 }{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	347 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	348
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	349 \@ifundefined{pdfoutput}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	350 \newcommand{\py@ModSynopsisSummary}[4]{\bfcode{#2} & #4\\}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	351 }{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	352 \newcommand{\py@ModSynopsisSummary}[4]{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	353 {\pdfannotlink attr{/Border [0 0 0]} goto name{label-module-#1}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	354 \py@LinkColor \bfcode{#2} \py@NormalColor
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	355 \pdfendlink}& #4\\}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	356 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	357 \newenvironment{synopsistable}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	358 % key, name, type, synopsis
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	359 \let\modulesynopsis=\py@ModSynopsisSummary
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	360 \begin{tabular}{ll}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	361 }{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	362 \end{tabular}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	363 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	364 %
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	365 % --------------------------------------------------------------------------
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	366
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	367
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	368 \newcommand{\py@thisclass}{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	369 \newcommand{\py@thismodule}{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	370 \newcommand{\py@thismodulekey}{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	371 \newcommand{\py@thismoduletype}{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	372
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	373 \newcommand{\py@reset}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	374 \py@ProcessModSynopsis
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	375 \renewcommand{\py@thisclass}{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	376 \renewcommand{\py@thismodule}{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	377 \renewcommand{\py@thismodulekey}{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	378 \renewcommand{\py@thismoduletype}{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	379 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	380
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	381 % Augment the sectioning commands used to get our own font family in place,
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	382 % and reset some internal data items:
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	383 \renewcommand{\section}{\py@reset%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	384 \@startsection{section}{1}{\z@}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	385 {-3.5ex \@plus -1ex \@minus -.2ex}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	386 {2.3ex \@plus.2ex}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	387 {\reset@font\Large\py@HeaderFamily}}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	388 \renewcommand{\subsection}{\@startsection{subsection}{2}{\z@}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	389 {-3.25ex\@plus -1ex \@minus -.2ex}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	390 {1.5ex \@plus .2ex}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	391 {\reset@font\large\py@HeaderFamily}}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	392 \renewcommand{\subsubsection}{\@startsection{subsubsection}{3}{\z@}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	393 {-3.25ex\@plus -1ex \@minus -.2ex}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	394 {1.5ex \@plus .2ex}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	395 {\reset@font\normalsize\py@HeaderFamily}}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	396 \renewcommand{\paragraph}{\@startsection{paragraph}{4}{\z@}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	397 {3.25ex \@plus1ex \@minus.2ex}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	398 {-1em}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	399 {\reset@font\normalsize\py@HeaderFamily}}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	400 \renewcommand{\subparagraph}{\@startsection{subparagraph}{5}{\parindent}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	401 {3.25ex \@plus1ex \@minus .2ex}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	402 {-1em}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	403 {\reset@font\normalsize\py@HeaderFamily}}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	404
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	405
8726 74ea4dfda82d \textunderscore: Re-define with a width that's more appropriate for the Fred Drake <fdrake@acm.org> parents: 8713 diff changeset	406 % This gets the underscores closer to the right width; the only change
74ea4dfda82d \textunderscore: Re-define with a width that's more appropriate for the Fred Drake <fdrake@acm.org> parents: 8713 diff changeset	407 % from standard LaTeX is the width specified.
74ea4dfda82d \textunderscore: Re-define with a width that's more appropriate for the Fred Drake <fdrake@acm.org> parents: 8713 diff changeset	408
74ea4dfda82d \textunderscore: Re-define with a width that's more appropriate for the Fred Drake <fdrake@acm.org> parents: 8713 diff changeset	409 \DeclareTextCommandDefault{\textunderscore}{%
74ea4dfda82d \textunderscore: Re-define with a width that's more appropriate for the Fred Drake <fdrake@acm.org> parents: 8713 diff changeset	410 \leavevmode \kern.06em\vbox{\hrule\@width.55em}}
74ea4dfda82d \textunderscore: Re-define with a width that's more appropriate for the Fred Drake <fdrake@acm.org> parents: 8713 diff changeset	411
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	412 % Underscore hack (only act like subscript operator if in math mode)
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	413 %
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	414 % The following is due to Mark Wooding (the old version didn't work with
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	415 % Latex 2e.
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	416
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	417 \DeclareRobustCommand\hackscore{%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	418 \ifmmode_\else\textunderscore\fi%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	419 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	420 \begingroup
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	421 \catcode`\_\active
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	422 \def\next{%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	423 \AtBeginDocument{\catcode`\_\active\def_{\hackscore{}}}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	424 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	425 \expandafter\endgroup\next
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	426
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	427
7801 047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	428 % 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	429 % 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	430 % 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	431
047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	432
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	433 % {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	434 % 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	435 %
9078 18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	436 \newcommand{\py@itemnewline}[1]{%
18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	437 \@tempdima\linewidth%
18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	438 \advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}%
18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	439 }
18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	440
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	441 \newenvironment{fulllineitems}{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	442 \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	443 \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	444 \itemsep -\parsep
9078 18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	445 \let\makelabel=\py@itemnewline}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	446 }{\end{list}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	447
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	448 % \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	449 % {*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	450 % be used in the debugger chapter.
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	451 %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	452 % Typical usage:
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	453 %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	454 % \begin{funcdesc}{myfunc}{reqparm\optional{, optparm}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	455 % ^^^ ^^^
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	456 % No space here No space here
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	457 %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	458 % 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	459 % nested, not chained. This is right:
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	460 %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	461 % \begin{funcdesc}{myfunc}{\optional{parm1\optional{, parm2}}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	462 %
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	463 \newcommand{\optional}[1]{%
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	464 {\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	465
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	466 % C functions ------------------------------------------------------------
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	467 % \begin{cfuncdesc}{type}{name}{arglist}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	468 \newenvironment{cfuncdesc}[3]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	469 \begin{fulllineitems}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	470 \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	471 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	472
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	473 % C variables ------------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	474 % \begin{cvardesc}{type}{name}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	475 \newenvironment{cvardesc}[2]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	476 \begin{fulllineitems}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	477 \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	478 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	479
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	480 % C data types -----------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	481 % \begin{ctypedesc}{typedef name}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	482 \newenvironment{ctypedesc}[1]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	483 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	484 \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	485 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	486
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	487 % simple functions (not methods) -----------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	488 % \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	489 \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	490 \newenvironment{funcdesc}[2]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	491 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	492 \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	493 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	494
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	495 % 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	496 \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	497 \newenvironment{funcdescni}[2]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	498 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	499 \funclineni{#1}{#2}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	500 }{\end{fulllineitems}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	501
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	502 % classes ----------------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	503 % \begin{classdesc}{name}{constructor args}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	504 \newenvironment{classdesc}[2]{
9524 c6a1103efa8a Minor nit that fixes a bunch of indexing: the way the classdesc Fred Drake <fdrake@acm.org> parents: 9078 diff changeset	505 % Using \renewcommand doesn't work for this, for unknown reasons:
c6a1103efa8a Minor nit that fixes a bunch of indexing: the way the classdesc Fred Drake <fdrake@acm.org> parents: 9078 diff changeset	506 \global\def\py@thisclass{#1}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	507 \begin{fulllineitems}
8075 e39145a13096 Hide \varvars from "public" interface. Fred Drake <fdrake@acm.org> parents: 8067 diff changeset	508 \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	509 \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	510 }{\end{fulllineitems}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	511
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	512
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	513 \let\py@classbadkey=\@undefined
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	514
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	515 % object method ----------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	516 % \begin{methoddesc}[classname]{methodname}{args}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	517 \newcommand{\methodline}[3][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	518 \methodlineni{#2}{#3}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	519 \ifx#1\@undefined
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	520 \withsubitem{(\py@thisclass\ method)}{\ttindex{#2()}}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	521 \else
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	522 \withsubitem{(#1 method)}{\ttindex{#2()}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	523 \fi
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	524 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	525 \newenvironment{methoddesc}[3][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	526 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	527 \ifx#1\@undefined
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	528 \methodline{#2}{#3}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	529 \else
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	530 \def\py@thisclass{#1}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	531 \methodline[#1]{#2}{#3}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	532 \fi
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	533 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	534
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	535 % 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	536 % (never actually uses the optional argument)
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	537 \newcommand{\methodlineni}[3][\py@classbadkey]{%
8075 e39145a13096 Hide \varvars from "public" interface. Fred Drake <fdrake@acm.org> parents: 8067 diff changeset	538 \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	539 \newenvironment{methoddescni}[3][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	540 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	541 \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	542 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	543
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	544 % object data attribute --------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	545 % \begin{memberdesc}[classname]{membername}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	546 \newcommand{\memberline}[2][\py@classbadkey]{%
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	547 \ifx#1\@undefined
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	548 \memberlineni{#2}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	549 \withsubitem{(\py@thisclass\ attribute)}{\ttindex{#2}}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	550 \else
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	551 \memberlineni{#2}
7898 6a0299ebccef Data attributes of objects should not be indexed with trailing parentheses! Fred Drake <fdrake@acm.org> parents: 7850 diff changeset	552 \withsubitem{(#1 attribute)}{\ttindex{#2}}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	553 \fi
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	554 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	555 \newenvironment{memberdesc}[2][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	556 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	557 \ifx#1\@undefined
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	558 \memberline{#2}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	559 \else
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	560 \def\py@thisclass{#1}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	561 \memberline[#1]{#2}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	562 \fi
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	563 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	564
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	565 % 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	566 % (never actually uses the optional argument)
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	567 \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	568 \newenvironment{memberdescni}[2][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	569 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	570 \memberlineni{#2}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	571 }{\end{fulllineitems}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	572
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	573 % For exceptions: --------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	574 % \begin{excdesc}{name}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	575 % -- 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	576 \newenvironment{excdesc}[1]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	577 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	578 \item[\bfcode{#1}\ttindex{#1}]
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	579 }{\end{fulllineitems}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	580
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	581 % Module data or constants: ----------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	582 % \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	583 \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	584 \newenvironment{datadesc}[1]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	585 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	586 \dataline{#1}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	587 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	588
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	589 % 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	590 \newcommand{\datalineni}[1]{\item[\bfcode{#1}]\nopagebreak}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	591 \newenvironment{datadescni}[1]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	592 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	593 \datalineni{#1}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	594 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	595
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	596 % bytecode instruction ---------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	597 % \begin{opcodedesc}{name}{var}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	598 % -- {var} may be {}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	599 \newenvironment{opcodedesc}[2]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	600 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	601 \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	602 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	603
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	604
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	605 \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	606
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	607 % 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	608 % {\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	609 \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	610 \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	611 \newcommand{\POSIX}{POSIX}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	612 \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	613 \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	614 \newcommand{\C}{C}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	615 \newcommand{\EOF}{{\sc eof}}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	616 \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	617
7801 047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	618 % 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	619
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	620 % 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	621 \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	622 \texttt{#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 \newcommand{\bfcode}[1]{\code{\bfseries#1}} % bold-faced code font
8609 ce295bfacef3 Fix the \kbd definition so it didn't leave the courier face on. Fred Drake <fdrake@acm.org> parents: 8396 diff changeset	625 \newcommand{\kbd}[1]{\code{#1}}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	626 \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	627 % 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	628 % 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	629 % with fonts.
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	630 \newcommand{\var}[1]{\normalsize\textrm{\textit{#1\/}}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	631 \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	632 \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	633 \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	634 % 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	635 \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	636
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	637 % 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	638 % 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	639 \@ifundefined{pdfannotlink}{
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	640 \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	641 }{
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	642 \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	643 \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	644 \py@LinkColor% color of the link text
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	645 \mbox{\small\textsf{#1}}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	646 \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	647 \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	648 }% formatting "box".
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	649 }
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	650 \let\url=\py@url
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	651 \newcommand{\email}[1]{{\small\textsf{#1}}}
7778 b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	652 \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	653
8075 e39145a13096 Hide \varvars from "public" interface. Fred Drake <fdrake@acm.org> parents: 8067 diff changeset	654 \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	655 % 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	656 \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	657
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	658 % 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	659 \newif\iftexi\texifalse
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	660
8779 9138272c1fe6 Define stuff to allow simple HTML-only selection using TeX's \if<foo>...\fi Fred Drake <fdrake@acm.org> parents: 8762 diff changeset	661 % This is used to get l2h to put the copyright and abstract on
9138272c1fe6 Define stuff to allow simple HTML-only selection using TeX's \if<foo>...\fi Fred Drake <fdrake@acm.org> parents: 8762 diff changeset	662 % a separate HTML page.
9138272c1fe6 Define stuff to allow simple HTML-only selection using TeX's \if<foo>...\fi Fred Drake <fdrake@acm.org> parents: 8762 diff changeset	663 \newif\ifhtml\htmlfalse
9138272c1fe6 Define stuff to allow simple HTML-only selection using TeX's \if<foo>...\fi Fred Drake <fdrake@acm.org> parents: 8762 diff changeset	664
9138272c1fe6 Define stuff to allow simple HTML-only selection using TeX's \if<foo>...\fi Fred Drake <fdrake@acm.org> parents: 8762 diff changeset	665
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	666 % 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	667 % 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	668 % 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	669 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	670 % 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	671 % 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	672 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	673 \newcommand{\module}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	674 \newcommand{\keyword}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	675 \newcommand{\exception}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	676 \newcommand{\class}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	677 \newcommand{\function}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	678 \newcommand{\member}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	679 \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	680
7801 047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	681 \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	682
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	683 \newcommand{\cfunction}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	684 \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	685 \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	686
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	687 \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	688 % 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	689 \newcommand{\regexp}[1]{%
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	690 {\tiny$^{^\lceil}\!\!$%
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	691 {\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	692 $\!\rfloor\!$%
7670 8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	693 }}
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	694 \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	695 \$#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	696 \index{#1@{\$#1}}% $
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	697 \index{environment variables!{\$#1}}% $
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	698 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	699 \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	700 \newcommand{\character}[1]{\samp{#1}}
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	701
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	702 % 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	703 \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	704
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	705 \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	706 \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	707 \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	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 % Deprecation stuff.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	711 % 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	712 % 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	713 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	714 % 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	715 % 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	716 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	717 % Example:
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	718 % \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	719 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	720 \newcommand{\deprecated}[2]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	721 \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	722
8762 4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	723 % New stuff.
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	724 % This should be used to mark things which have been added to the
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	725 % development tree but that aren't in the release, but are documented.
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	726 % This allows release of documentation that already includes updated
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	727 % descriptions.
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	728 %
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	729 % Example:
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	730 % \versionadded{1.5.2}
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	731 %
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	732 \newcommand{\versionadded}[1]{%
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	733 \strong{New in version #1.}\par}
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	734 \newcommand{\versionchanged}[1]{%
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	735 \strong{Changed in version #1.}\par}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	736
8762 4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	737
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	738 % Tables.
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	739 %
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	740 \newenvironment{tableii}[4]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	741 \begin{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	742 \def\lineii##1##2{\csname#2\endcsname{##1}&##2\\}%
8018 011ae71fea96 Lighten up tables. Fred Drake <fdrake@acm.org> parents: 7898 diff changeset	743 \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	744 }{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	745 \end{tabular}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	746 \end{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	747 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	748
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	749 \newenvironment{tableiii}[5]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	750 \begin{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	751 \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	752 \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	753 }{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	754 \end{tabular}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	755 \end{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	756 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	757
8751 99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	758 \newenvironment{tableiv}[6]{%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	759 \begin{center}%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	760 \def\lineiv##1##2##3##4{\csname#2\endcsname{##1}&##2&##3&##4\\}%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	761 \begin{tabular}{#1}\strong{#3}&\strong{#4}&\strong{#5}&\strong{#6} \\%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	762 \hline%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	763 }{%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	764 \end{tabular}%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	765 \end{center}%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	766 }
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	767
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	768 % 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	769 % Sample usage:
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	770 % \begin{seealso}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	771 % \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	772 % \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	773 %
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	774 % % 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	775 % \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	776 %
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	777 % \end{seealso}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	778
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	779 \@ifundefined{pdfannotlink}{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	780 \newcommand{\py@seemodule}[3][\py@modulebadkey]{%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	781 \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	782 \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	783 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	784 \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	785 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	786 }{\newcommand{\py@seemodule}[3][\py@modulebadkey]{%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	787 \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	788 \ref{module-\py@modulekey}:\quad %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	789 {\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	790 \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	791 \pdfendlink%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	792 }%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	793 \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	794 }
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	795 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	796 \newenvironment{seealso}[0]{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	797 \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	798 \def\seetext##1{\par{##1}}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	799 \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	800 }{\par}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	801
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	802
8762 4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	803 % Allow the Python release number to be specified independently of the
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	804 % \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	805 % 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	806 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	807 \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	808 \newcommand{\version}{}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	809 \newcommand{\releasename}{Release}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	810 \newcommand{\release}[1]{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	811 \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	812 \renewcommand{\version}{#1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	813
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	814 % 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	815 % 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	816 % 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	817 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	818 \newcommand{\py@authoraddress}{}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	819 \newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}}
8341 ebfde06fdb8d Added definitions for \developer, \developers, \developersaddress. Fred Drake <fdrake@acm.org> parents: 8306 diff changeset	820 \let\developersaddress=\authoraddress
ebfde06fdb8d Added definitions for \developer, \developers, \developersaddress. Fred Drake <fdrake@acm.org> parents: 8306 diff changeset	821 \let\developer=\author
ebfde06fdb8d Added definitions for \developer, \developers, \developersaddress. Fred Drake <fdrake@acm.org> parents: 8306 diff changeset	822 \let\developers=\author
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	823
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	824 % 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	825 % 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	826 %
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	827 \@ifundefined{ChTitleVar}{}{
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	828 \ChNameVar{\raggedleft\normalsize\py@HeaderFamily}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	829 \ChNumVar{\raggedleft \bfseries\Large\py@HeaderFamily}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	830 \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	831 % 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	832 \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	833 {\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	834 \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	835 \DOCH
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	836 \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	837 \interlinepenalty\@M
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	838 \DOTI{#1}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	839 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	840 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	841 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	842
8396 79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	843
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	844 % Definition lists; requested by AMK for HOWTO documents. Probably useful
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	845 % elsewhere as well, so keep in in the general style support.
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	846 %
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	847 \newenvironment{definitions}{%
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	848 \begin{description}%
9078 18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	849 \def\term##1{\item[##1]\mbox{}\\*[0mm]}
8396 79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	850 }{%
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	851 \end{description}%
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	852 }
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	853
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	854 % 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	855 \hyphenation{Base-HTTP-Re-quest-Hand-ler}

Mercurial > cpython-lru_cache-weakref

annotate Doc/texinputs/python.sty @ 9524:c6a1103efa8a legacy-trunk