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

annotate Doc/texinputs/python.sty @ 33216:6b743cbc4171 legacy-trunk

sf #1009373, #1005936. fix underscores in index entries in PDF files. I couldn't test this, but it didn't break anything and the patch reported fixed the problem. Bugfix candidate.

author	Neal Norwitz <nnorwitz@gmail.com>
date	Sat, 21 Aug 2004 15:13:52 +0000
parents	64cc163eeaf1
children	cec31edea414

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 %
30722 651fc8d98d99 Fix a bunch of typos in documentation, docstrings and comments. Walter Dörwald <walter@livinglogic.de> parents: 30345 diff changeset	2 % python.sty for the Python docummentation [works only 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
14722 4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	9 \RequirePackage{longtable}
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	10
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	11 % Uncomment these two lines to ignore the paper size and make the page
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	12 % size more like a typical published manual.
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	13 %\renewcommand{\paperheight}{9in}
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	14 %\renewcommand{\paperwidth}{8.5in} % typical squarish manual
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	15 %\renewcommand{\paperwidth}{7in} % O'Reilly ``Programmming Python''
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	16
7778 b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	17 % These packages can be used to add marginal annotations which indicate
b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	18 % index entries and labels; useful for reviewing this messy documentation!
b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	19 %
b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	20 %\RequirePackage{showkeys}
b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	21 %\RequirePackage{showidx}
b17d200edf62 Added some comments. Fred Drake <fdrake@acm.org> parents: 7764 diff changeset	22
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	23 % 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	24 % (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	25 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	26 \newif\ifpy@doing@page@targets
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	27 \py@doing@page@targetsfalse
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	28
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	29 \newif\ifpdf\pdffalse
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	30 \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	31 \else
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	32 \pdftrue
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	33 \input{pdfcolor}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	34 \let\py@LinkColor=\NavyBlue
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	35 \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	36 \pdfcompresslevel=9
8306 4674cd2f6f07 Set the right page size in the PDF output. Fred Drake <fdrake@acm.org> parents: 8229 diff changeset	37 \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	38 \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	39 %
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	40 % 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	41 % of any other.
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	42 %
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	43 \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	44 \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	45 %
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	46 % 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	47 % 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	48 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	49 \let\py@OldContentsline=\contentsline
9968 485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	50 %
22320 dc6054e5b642 pdfTeX 0.13 and 0.14 do not agree on the name of the macro, and I will not Fred Drake <fdrake@acm.org> parents: 22316 diff changeset	51 % Backward compatibility hack: pdfTeX 0.13 defined \pdfannotlink,
dc6054e5b642 pdfTeX 0.13 and 0.14 do not agree on the name of the macro, and I will not Fred Drake <fdrake@acm.org> parents: 22316 diff changeset	52 % but it changed to \pdfstartlink in 0.14. This let's us use either
dc6054e5b642 pdfTeX 0.13 and 0.14 do not agree on the name of the macro, and I will not Fred Drake <fdrake@acm.org> parents: 22316 diff changeset	53 % version and still get useful behavior.
dc6054e5b642 pdfTeX 0.13 and 0.14 do not agree on the name of the macro, and I will not Fred Drake <fdrake@acm.org> parents: 22316 diff changeset	54 %
dc6054e5b642 pdfTeX 0.13 and 0.14 do not agree on the name of the macro, and I will not Fred Drake <fdrake@acm.org> parents: 22316 diff changeset	55 \@ifundefined{pdfstartlink}{
dc6054e5b642 pdfTeX 0.13 and 0.14 do not agree on the name of the macro, and I will not Fred Drake <fdrake@acm.org> parents: 22316 diff changeset	56 \let\pdfstartlink=\pdfannotlink
dc6054e5b642 pdfTeX 0.13 and 0.14 do not agree on the name of the macro, and I will not Fred Drake <fdrake@acm.org> parents: 22316 diff changeset	57 }{}
dc6054e5b642 pdfTeX 0.13 and 0.14 do not agree on the name of the macro, and I will not Fred Drake <fdrake@acm.org> parents: 22316 diff changeset	58 %
9968 485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	59 % Macro that takes two args: the name to link to and the content of
485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	60 % the link. This takes care of the PDF magic, getting the colors
485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	61 % the same for each link, and avoids having lots of garbage all over
485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	62 % this style file.
485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	63 \newcommand{\py@linkToName}[2]{%
22316 cc788b3b21b6 Revise the markup related to the grammar productions to increase the Fred Drake <fdrake@acm.org> parents: 21418 diff changeset	64 \pdfstartlink attr{/Border [0 0 0]} goto name{#1}%
9968 485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	65 \py@LinkColor#2\py@NormalColor%
485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	66 \pdfendlink%
22316 cc788b3b21b6 Revise the markup related to the grammar productions to increase the Fred Drake <fdrake@acm.org> parents: 21418 diff changeset	67 }
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	68 % 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	69 % \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	70 \renewcommand{\contentsline}[3]{%
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	71 \def\my@pageno{\py@targetno{#3}}%
9968 485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	72 \py@OldContentsline{#1}{\py@linkToName{page\my@pageno}{#2}}{#3}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	73 }
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	74 \AtEndDocument{
33216 6b743cbc4171 sf #1009373, #1005936. fix underscores in index entries in PDF files. Neal Norwitz <nnorwitz@gmail.com> parents: 31845 diff changeset	75 \def\_{\string_}
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	76 \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	77 }
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	78 \newcommand{\py@target}[1]{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	79 \ifpy@doing@page@targets%
10451 2b1dfc13951d Use more recent option to \pdfdest to not change the zoom factor. Fred Drake <fdrake@acm.org> parents: 10423 diff changeset	80 {\pdfdest name{#1} xyz}%
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	81 \fi%
48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	82 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	83 \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	84 \renewcommand{\label}[1]{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	85 \py@OldLabel{#1}%
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	86 \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	87 }
8306 4674cd2f6f07 Set the right page size in the PDF output. Fred Drake <fdrake@acm.org> parents: 8229 diff changeset	88 % 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	89 % 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	90 % 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	91 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	92 % 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	93 %
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	94 \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	95 \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	96 \@hyperfixhead
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	97 }
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	98 \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	99 \let\H@old@thehead\@thehead
8067 48e2349d11c6 Fix the broken PDF links, really this time! Fred Drake <fdrake@acm.org> parents: 8066 diff changeset	100 \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	101 \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	102 \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	103 \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	104 }
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	105 \fi\fi
7527 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 % 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	108 \topmargin 0pt
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	109 \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	110 \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	111
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	112 % attempt to work a little better for A4 users
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	113 \textheight \paperheight
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	114 \advance\textheight by -2in
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	115
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	116 \oddsidemargin 0pt
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	117 \evensidemargin 0pt
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	118 %\evensidemargin -.25in % for ``manual size'' documents
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	119 \marginparwidth 0.5in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	120
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	121 \textwidth \paperwidth
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	122 \advance\textwidth by -2in
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	123
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	124
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	125 % 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	126 \raggedbottom
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	127 \sloppy
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	128 \parindent = 0mm
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	129 \parskip = 2mm
16966 38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	130 \hbadness = 5000 % don't print trivial gripes
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	131
16966 38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	132 \pagestyle{empty} % start this way; change for
38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	133 \pagenumbering{roman} % ToC & chapters
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	134
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	135 % 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	136 \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	137
25979 d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	138 % Set up abstract ways to get the normal and smaller font sizes that
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	139 % work even in footnote context.
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	140 \newif\ifpy@infootnote \py@infootnotefalse
26015 5be5c84dea23 Thinking on comp.text.tex seems to be that it's better to override Fred Drake <fdrake@acm.org> parents: 25979 diff changeset	141 \let\py@oldmakefntext\@makefntext
5be5c84dea23 Thinking on comp.text.tex seems to be that it's better to override Fred Drake <fdrake@acm.org> parents: 25979 diff changeset	142 \def\@makefntext#1{%
25979 d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	143 \bgroup%
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	144 \py@infootnotetrue
26015 5be5c84dea23 Thinking on comp.text.tex seems to be that it's better to override Fred Drake <fdrake@acm.org> parents: 25979 diff changeset	145 \py@oldmakefntext{#1}%
25979 d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	146 \egroup%
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	147 }
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	148 \def\py@defaultsize{%
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	149 \ifpy@infootnote\footnotesize\else\normalsize\fi%
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	150 }
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	151 \def\py@smallsize{%
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	152 \ifpy@infootnote\scriptsize\else\small\fi%
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	153 }
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	154
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	155 % 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	156 \@ifundefined{fancyhf}{}{
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	157 % 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	158 \fancypagestyle{normal}{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	159 \fancyhf{}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	160 \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	161 \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	162 \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	163 \renewcommand{\headrulewidth}{0pt}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	164 \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	165 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	166 % 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	167 % 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	168 % 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	169 \fancypagestyle{plain}{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	170 \fancyhf{}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	171 \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	172 \renewcommand{\headrulewidth}{0pt}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	173 \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	174 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	175 % 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	176 % 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	177 % 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	178 \@ifundefined{chapter}{}{
7548 7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	179 \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	180 \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	181 \hbox{}
7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	182 \thispagestyle{plain}
7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	183 \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	184 \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	185 }
7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	186 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	187 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	188
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	189 % 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	190 % 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	191 % code samples.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	192
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	193 \let\py@OldVerbatim=\verbatim
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	194 \let\py@OldEndVerbatim=\endverbatim
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	195 \RequirePackage{verbatim}
22637 d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	196 \let\py@OldVerbatimInput=\verbatiminput
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	197
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	198 % Variable used by begin code command
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	199 \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	200
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	201 \renewcommand{\verbatim}{%
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	202 \setlength{\parindent}{1cm}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	203 % 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	204 \setlength{\py@codewidth}{\linewidth}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	205 \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	206 %
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	207 \par\indent%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	208 \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	209 \small%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	210 \py@OldVerbatim%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	211 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	212 \renewcommand{\endverbatim}{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	213 \py@OldEndVerbatim%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	214 \end{minipage}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	215 }
22637 d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	216 \renewcommand{\verbatiminput}[1]{%
d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	217 {\setlength{\parindent}{1cm}%
d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	218 % Calculate the text width for the minipage:
d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	219 \setlength{\py@codewidth}{\linewidth}%
d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	220 \addtolength{\py@codewidth}{-\parindent}%
d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	221 %
d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	222 \small%
d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	223 \begin{list}{}{\setlength{\leftmargin}{1cm}}
d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	224 \item%
d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	225 \py@OldVerbatimInput{#1}%
d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	226 \end{list}
d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	227 }%
d778ea9de780 Extend \verbatiminput so that the typeset version provides the same appearance Fred Drake <fdrake@acm.org> parents: 22589 diff changeset	228 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	229
17380 4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	230 % This does a similar thing for the {alltt} environment:
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	231 \RequirePackage{alltt}
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	232 \let\py@OldAllTT=\alltt
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	233 \let\py@OldEndAllTT=\endalltt
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	234
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	235 \renewcommand{\alltt}{%
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	236 \setlength{\parindent}{1cm}%
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	237 % Calculate the text width for the minipage:
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	238 \setlength{\py@codewidth}{\linewidth}%
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	239 \addtolength{\py@codewidth}{-\parindent}%
31507 354129143809 add support for \e to the {alltt} environment Fred Drake <fdrake@acm.org> parents: 31498 diff changeset	240 \let\e=\textbackslash%
17380 4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	241 %
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	242 \par\indent%
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	243 \begin{minipage}[t]{\py@codewidth}%
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	244 \small%
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	245 \py@OldAllTT%
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	246 }
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	247 \renewcommand{\endalltt}{%
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	248 \py@OldEndAllTT%
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	249 \end{minipage}%
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	250 }
4622af4da9e2 Import the alltt package and wrap that environment in a similar way to Fred Drake <fdrake@acm.org> parents: 16966 diff changeset	251
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	252
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	253 \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	254
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	255
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	256 %% 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	257
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	258 % 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	259 % 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	260 % 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	261 % 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	262 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	263 \newcommand{\py@idxcode}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	264 %\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	265
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	266 % 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	267 \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	268
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	269 % 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	270 \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	271
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	272 % 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	273 \newcommand{\indexiv}[4]{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	274 \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	275 \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	276 \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	277 \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	278 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	279
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	280 % 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	281 % operator.
8229 df752c08b462 \itembreak, Fred Drake <fdrake@acm.org> parents: 8190 diff changeset	282 \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	283 \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	284 \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	285 \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	286 \newcommand{\obindex}[1]{\indexii{object}{#1}}
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	287 \newcommand{\bifuncindex}[1]{%
74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	288 \index{#1@{\py@idxcode{#1()}} (built-in function)}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	289
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	290 % 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	291 \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	292 \newcommand{\refmodindex}[1]{\py@refmodule{#1}{}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	293 \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	294 \newcommand{\refexmodindex}[1]{\py@refmodule{#1}{extension }}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	295 \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	296
9868 a58f36352c4f \seemodule: Fix so that each \seemodule entry gets its own paragraph, Fred Drake <fdrake@acm.org> parents: 9542 diff changeset	297 % Refer to a module's documentation using a hyperlink of the module's
a58f36352c4f \seemodule: Fix so that each \seemodule entry gets its own paragraph, Fred Drake <fdrake@acm.org> parents: 9542 diff changeset	298 % name, at least if we're building PDF:
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	299 \ifpdf
9968 485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	300 \newcommand{\refmodule}[2][\py@modulebadkey]{%
9868 a58f36352c4f \seemodule: Fix so that each \seemodule entry gets its own paragraph, Fred Drake <fdrake@acm.org> parents: 9542 diff changeset	301 \ifx\py@modulebadkey#1\def\py@modulekey{#2}\else\def\py@modulekey{#1}\fi%
9968 485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	302 \py@linkToName{label-module-\py@modulekey}{\module{#2}}%
9868 a58f36352c4f \seemodule: Fix so that each \seemodule entry gets its own paragraph, Fred Drake <fdrake@acm.org> parents: 9542 diff changeset	303 }
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	304 \else
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	305 \newcommand{\refmodule}[2][\py@modulebadkey]{\module{#2}}
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	306 \fi
9868 a58f36352c4f \seemodule: Fix so that each \seemodule entry gets its own paragraph, Fred Drake <fdrake@acm.org> parents: 9542 diff changeset	307
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	308 % support for the module index
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	309 \newif\ifpy@UseModuleIndex
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	310 \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	311
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	312 \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	313 \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	314 \openout\modindexfile=mod\jobname.idx
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	315 \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	316 }
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	317
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	318 % 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	319 \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	320 \renewcommand{\py@thismodule}{#1}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	321 \setindexsubitem{(in module #1)}%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	322 \index{#1@{\py@idxcode{#1}} (#2module)\|textbf}%
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	323 \ifpy@UseModuleIndex%
10328 f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	324 \@ifundefined{py@modplat@\py@thismodulekey}{
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	325 \write\modindexfile{\protect\indexentry{#1@{\texttt{#1}}}{\thepage}}%
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	326 }{\write\modindexfile{\protect\indexentry{#1@{\texttt{#1} %
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	327 \emph{(\py@platformof[\py@thismodulekey]{})}}}{\thepage}}%
10328 f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	328 }
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	329 \fi%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	330 }
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	331
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	332 % * XXX * THE NEXT FOUR MACROS ARE NOW OBSOLETE !!! ***
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	333
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	334 % built-in & Python modules in the main distribution
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	335 \newcommand{\bimodindex}[1]{\py@modindex{#1}{built-in }%
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	336 \typeout{*** MACRO bimodindex IS OBSOLETE -- USE declaremodule INSTEAD!}}
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	337 \newcommand{\stmodindex}[1]{\py@modindex{#1}{standard }%
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	338 \typeout{*** MACRO stmodindex IS OBSOLETE -- USE declaremodule INSTEAD!}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	339
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	340 % Python & extension modules outside the main distribution
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	341 \newcommand{\modindex}[1]{\py@modindex{#1}{}%
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	342 \typeout{*** MACRO modindex IS OBSOLETE -- USE declaremodule INSTEAD!}}
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	343 \newcommand{\exmodindex}[1]{\py@modindex{#1}{extension }%
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	344 \typeout{*** MACRO exmodindex IS OBSOLETE -- USE declaremodule INSTEAD!}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	345
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	346 % Additional string for an index entry
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	347 \newif\ifpy@usingsubitem\py@usingsubitemfalse
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	348 \newcommand{\py@indexsubitem}{}
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	349 \newcommand{\setindexsubitem}[1]{\renewcommand{\py@indexsubitem}{ #1}%
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	350 \py@usingsubitemtrue}
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	351 \newcommand{\ttindex}[1]{%
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	352 \ifpy@usingsubitem
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	353 \index{#1@{\py@idxcode{#1}}\py@indexsubitem}%
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	354 \else%
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	355 \index{#1@{\py@idxcode{#1}}}%
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	356 \fi%
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	357 }
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	358 \newcommand{\withsubitem}[2]{%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	359 \begingroup%
15362 9a17cdcd3320 Fix \withsubitem so that it actually works if the only indexing macro in Fred Drake <fdrake@acm.org> parents: 15360 diff changeset	360 \def\ttindex##1{\index{##1@{\py@idxcode{##1}} #1}}%
9a17cdcd3320 Fix \withsubitem so that it actually works if the only indexing macro in Fred Drake <fdrake@acm.org> parents: 15360 diff changeset	361 #2%
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	362 \endgroup%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	363 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	364
7801 047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	365
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	366 % Module synopsis processing -----------------------------------------------
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	367 %
10328 f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	368 \newcommand{\py@thisclass}{}
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	369 \newcommand{\py@thismodule}{}
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	370 \newcommand{\py@thismodulekey}{}
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	371 \newcommand{\py@thismoduletype}{}
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	372
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	373 \newcommand{\py@standardIndexModule}[1]{\py@modindex{#1}{standard }}
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	374 \newcommand{\py@builtinIndexModule}[1]{\py@modindex{#1}{built-in }}
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	375 \newcommand{\py@extensionIndexModule}[1]{\py@modindex{#1}{extension }}
9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	376 \newcommand{\py@IndexModule}[1]{\py@modindex{#1}{}}
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	377
10328 f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	378 \newif\ifpy@HaveModSynopsis \py@HaveModSynopsisfalse
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	379 \newif\ifpy@ModSynopsisFileIsOpen \py@ModSynopsisFileIsOpenfalse
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	380 \newif\ifpy@HaveModPlatform \py@HaveModPlatformfalse
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	381
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	382 % \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	383 \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	384 \py@openModSynopsisFile
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	385 \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	386 \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	387 \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	388 \else
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	389 \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	390 \fi
10855 28887f40e344 \declaremodule: Make this more robust. Only attempt to add an index Fred Drake <fdrake@acm.org> parents: 10846 diff changeset	391 \@ifundefined{py@#2IndexModule}{%
28887f40e344 \declaremodule: Make this more robust. Only attempt to add an index Fred Drake <fdrake@acm.org> parents: 10846 diff changeset	392 \typeout{*** MACRO declaremodule called with unknown module type: `#2'}
10856 be0ac5abe83b \declaremodule: Typo. Fred Drake <fdrake@acm.org> parents: 10855 diff changeset	393 \py@IndexModule{#3}%
10855 28887f40e344 \declaremodule: Make this more robust. Only attempt to add an index Fred Drake <fdrake@acm.org> parents: 10846 diff changeset	394 }{%
28887f40e344 \declaremodule: Make this more robust. Only attempt to add an index Fred Drake <fdrake@acm.org> parents: 10846 diff changeset	395 \csname py@#2IndexModule\endcsname{#3}%
28887f40e344 \declaremodule: Make this more robust. Only attempt to add an index Fred Drake <fdrake@acm.org> parents: 10846 diff changeset	396 }
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	397 \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	398 }
10328 f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	399 \newif\ifpy@ModPlatformFileIsOpen \py@ModPlatformFileIsOpenfalse
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	400 \newcommand{\py@ModPlatformFilename}{\jobname.pla}
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	401 \newcommand{\platform}[1]{
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	402 \ifpy@ModPlatformFileIsOpen\else
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	403 \newwrite\py@ModPlatformFile
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	404 \openout\py@ModPlatformFile=\py@ModPlatformFilename
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	405 \py@ModPlatformFileIsOpentrue
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	406 \fi
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	407 }
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	408 \InputIfFileExists{\jobname.pla}{}{}
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	409 \newcommand{\py@platformof}[2][\py@modulebadkey]{%
10328 f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	410 \ifx\py@modulebadkey#1 \def\py@key{#2}%
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	411 \else \def\py@key{#1}%
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	412 \fi%
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	413 \csname py@modplat@\py@key\endcsname%
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	414 }
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	415 \newcommand{\ignorePlatformAnnotation}[1]{}
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	416
8916 6b633df41e59 \moduleauthor, Fred Drake <fdrake@acm.org> parents: 8779 diff changeset	417 % \moduleauthor{name}{email}
6b633df41e59 \moduleauthor, Fred Drake <fdrake@acm.org> parents: 8779 diff changeset	418 \newcommand{\moduleauthor}[2]{}
6b633df41e59 \moduleauthor, Fred Drake <fdrake@acm.org> parents: 8779 diff changeset	419
6b633df41e59 \moduleauthor, Fred Drake <fdrake@acm.org> parents: 8779 diff changeset	420 % \sectionauthor{name}{email}
6b633df41e59 \moduleauthor, Fred Drake <fdrake@acm.org> parents: 8779 diff changeset	421 \newcommand{\sectionauthor}[2]{}
6b633df41e59 \moduleauthor, Fred Drake <fdrake@acm.org> parents: 8779 diff changeset	422
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	423
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	424 \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	425 \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	426 \newcommand{\modulesynopsis}[1]{
10328 f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	427 \py@HaveModSynopsistrue
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	428 \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	429 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	430
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	431 % define the file
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	432 \newwrite\py@ModSynopsisFile
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	433
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	434 % 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	435 \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	436 \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	437 {\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	438 {\string#1}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	439 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	440 \newcommand{\py@closeModSynopsisFile}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	441 \ifpy@ModSynopsisFileIsOpen
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	442 \closeout\py@ModSynopsisFile
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	443 \py@ModSynopsisFileIsOpenfalse
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	444 \fi
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	445 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	446 \newcommand{\py@openModSynopsisFile}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	447 \ifpy@ModSynopsisFileIsOpen\else
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	448 \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	449 \py@ModSynopsisFileIsOpentrue
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	450 \fi
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	451 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	452
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	453 \newcommand{\py@ProcessModSynopsis}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	454 \ifpy@HaveModSynopsis
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	455 \py@writeModSynopsisFile{\modulesynopsis%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	456 {\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	457 {\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	458 \py@HaveModSynopsisfalse
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	459 \fi
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	460 \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	461 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	462 \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	463
10328 f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	464
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	465 \long\def\py@writeModPlatformFile#1{%
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	466 \protected@write\py@ModPlatformFile%
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	467 {\let\label\@gobble \let\index\@gobble \let\glossary\@gobble}%
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	468 {\string#1}%
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	469 }
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	470
f438c6e2b6c1 Added support for \platform, \platformof, and \ignorePlatformAnnotation. Fred Drake <fdrake@acm.org> parents: 10077 diff changeset	471
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	472 \newcommand{\localmoduletable}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	473 \IfFileExists{\py@ModSynopsisFilename}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	474 \begin{synopsistable}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	475 \input{\py@ModSynopsisFilename}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	476 \end{synopsistable}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	477 }{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	478 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	479
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	480 \ifpdf
9968 485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	481 \newcommand{\py@ModSynopsisSummary}[4]{%
485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	482 \py@linkToName{label-module-#1}{\bfcode{#2}} & #4\\
485502c42d89 \py@linkToName: New macro to consolidate support for most internal Fred Drake <fdrake@acm.org> parents: 9958 diff changeset	483 }
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	484 \else
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	485 \newcommand{\py@ModSynopsisSummary}[4]{\bfcode{#2} & #4\\}
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	486 \fi
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	487 \newenvironment{synopsistable}{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	488 % 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	489 \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	490 \begin{tabular}{ll}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	491 }{
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	492 \end{tabular}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	493 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	494 %
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	495 % --------------------------------------------------------------------------
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	496
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	497
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	498 \newcommand{\py@reset}{
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	499 \py@usingsubitemfalse
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	500 \py@ProcessModSynopsis
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	501 \renewcommand{\py@thisclass}{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	502 \renewcommand{\py@thismodule}{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	503 \renewcommand{\py@thismodulekey}{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	504 \renewcommand{\py@thismoduletype}{}
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	505 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	506
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	507 % 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	508 % 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	509 \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	510 \@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	511 {-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	512 {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	513 {\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	514 \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	515 {-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	516 {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	517 {\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	518 \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	519 {-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	520 {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	521 {\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	522 \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	523 {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	524 {-1em}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	525 {\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	526 \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	527 {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	528 {-1em}%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	529 {\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	530
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	531
8726 74ea4dfda82d \textunderscore: Re-define with a width that's more appropriate for the Fred Drake <fdrake@acm.org> parents: 8713 diff changeset	532 % 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	533 % 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	534
74ea4dfda82d \textunderscore: Re-define with a width that's more appropriate for the Fred Drake <fdrake@acm.org> parents: 8713 diff changeset	535 \DeclareTextCommandDefault{\textunderscore}{%
74ea4dfda82d \textunderscore: Re-define with a width that's more appropriate for the Fred Drake <fdrake@acm.org> parents: 8713 diff changeset	536 \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	537
8713 ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	538 % 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	539 %
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	540 % 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	541 % Latex 2e.
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	542
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	543 \DeclareRobustCommand\hackscore{%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	544 \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	545 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	546 \begingroup
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	547 \catcode`\_\active
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	548 \def\next{%
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	549 \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	550 }
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	551 \expandafter\endgroup\next
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	552
ed8f4e2eb11a Lots of new stuff for "module synopsis support." Public interface consists Fred Drake <fdrake@acm.org> parents: 8609 diff changeset	553
7801 047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	554 % 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	555 % 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	556 % 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	557
047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	558
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	559 % {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	560 % 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	561 %
9078 18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	562 \newcommand{\py@itemnewline}[1]{%
18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	563 \@tempdima\linewidth%
18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	564 \advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}%
18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	565 }
18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	566
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	567 \newenvironment{fulllineitems}{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	568 \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	569 \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	570 \itemsep -\parsep
9078 18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	571 \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	572 }{\end{list}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	573
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	574 % \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	575 % {*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	576 % be used in the debugger chapter.
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	577 %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	578 % Typical usage:
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	579 %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	580 % \begin{funcdesc}{myfunc}{reqparm\optional{, optparm}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	581 % ^^^ ^^^
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	582 % No space here No space here
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	583 %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	584 % 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	585 % nested, not chained. This is right:
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	586 %
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	587 % \begin{funcdesc}{myfunc}{\optional{parm1\optional{, parm2}}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	588 %
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	589 \let\py@badkey=\@undefined
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	590
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	591 \newcommand{\optional}[1]{%
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	592 {\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	593
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	594 % This can be used when a function or method accepts an varying number
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	595 % of arguments, such as by using the *args syntax in the parameter list.
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	596 \newcommand{\py@moreargs}{...}
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	597
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	598 % This can be used when you don't want to document the parameters to a
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	599 % function or method, but simply state that it's an alias for
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	600 % something else.
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	601 \newcommand{\py@unspecified}{...}
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	602
24090 bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	603
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	604 \newlength{\py@argswidth}
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	605 \newcommand{\py@sigparams}[1]{%
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	606 \parbox[t]{\py@argswidth}{\py@varvars{#1}\code{)}}}
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	607 \newcommand{\py@sigline}[2]{%
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	608 \settowidth{\py@argswidth}{#1\code{(}}%
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	609 \addtolength{\py@argswidth}{-2\py@argswidth}%
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	610 \addtolength{\py@argswidth}{\textwidth}%
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	611 \item[#1\code{(}\py@sigparams{#2}]}
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	612
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	613 % C functions ------------------------------------------------------------
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	614 % \begin{cfuncdesc}[refcount]{type}{name}{arglist}
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	615 % Note that the [refcount] slot should only be filled in by
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	616 % tools/anno-api.py; it pulls the value from the refcounts database.
23063 530aba3116a4 Separate out a \cfuncline macro from the cfuncdesc environment. Fred Drake <fdrake@acm.org> parents: 23013 diff changeset	617 \newcommand{\cfuncline}[3]{
24090 bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	618 \py@sigline{\code{#1 \bfcode{#2}}}{#3}%
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	619 \index{#2@{\py@idxcode{#2()}}}
23063 530aba3116a4 Separate out a \cfuncline macro from the cfuncdesc environment. Fred Drake <fdrake@acm.org> parents: 23013 diff changeset	620 }
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	621 \newenvironment{cfuncdesc}[4][\py@badkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	622 \begin{fulllineitems}
23063 530aba3116a4 Separate out a \cfuncline macro from the cfuncdesc environment. Fred Drake <fdrake@acm.org> parents: 23013 diff changeset	623 \cfuncline{#2}{#3}{#4}
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	624 \ifx#1\@undefined\else%
12346 24d4116897dd cfuncdesc environment: Fred Drake <fdrake@acm.org> parents: 12215 diff changeset	625 \emph{Return value: \textbf{#1}.}\\
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	626 \fi
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	627 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	628
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	629 % C variables ------------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	630 % \begin{cvardesc}{type}{name}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	631 \newenvironment{cvardesc}[2]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	632 \begin{fulllineitems}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	633 \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	634 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	635
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	636 % C data types -----------------------------------------------------------
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	637 % \begin{ctypedesc}[index name]{typedef name}
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	638 \newenvironment{ctypedesc}[2][\py@badkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	639 \begin{fulllineitems}
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	640 \item[\bfcode{#2}%
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	641 \ifx#1\@undefined%
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	642 \index{#2@{\py@idxcode{#2}} (C type)}
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	643 \else%
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	644 \index{#2@{\py@idxcode{#1}} (C type)}
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	645 \fi]
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	646 }{\end{fulllineitems}}
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	647
23013 d6322983069e Additional support for describing C structure members. Fred Drake <fdrake@acm.org> parents: 22921 diff changeset	648 % C type fields ----------------------------------------------------------
d6322983069e Additional support for describing C structure members. Fred Drake <fdrake@acm.org> parents: 22921 diff changeset	649 % \begin{cmemberdesc}{container type}{ctype}{membername}
d6322983069e Additional support for describing C structure members. Fred Drake <fdrake@acm.org> parents: 22921 diff changeset	650 \newcommand{\cmemberline}[3]{
d6322983069e Additional support for describing C structure members. Fred Drake <fdrake@acm.org> parents: 22921 diff changeset	651 \item[\code{#2 \bfcode{#3}}]
d6322983069e Additional support for describing C structure members. Fred Drake <fdrake@acm.org> parents: 22921 diff changeset	652 \index{#3@{\py@idxcode{#3}} (#1 member)}
d6322983069e Additional support for describing C structure members. Fred Drake <fdrake@acm.org> parents: 22921 diff changeset	653 }
d6322983069e Additional support for describing C structure members. Fred Drake <fdrake@acm.org> parents: 22921 diff changeset	654 \newenvironment{cmemberdesc}[3]{
d6322983069e Additional support for describing C structure members. Fred Drake <fdrake@acm.org> parents: 22921 diff changeset	655 \begin{fulllineitems}
d6322983069e Additional support for describing C structure members. Fred Drake <fdrake@acm.org> parents: 22921 diff changeset	656 \cmemberline{#1}{#2}{#3}
d6322983069e Additional support for describing C structure members. Fred Drake <fdrake@acm.org> parents: 22921 diff changeset	657 }{\end{fulllineitems}}
d6322983069e Additional support for describing C structure members. Fred Drake <fdrake@acm.org> parents: 22921 diff changeset	658
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	659 % Funky macros -----------------------------------------------------------
22921 3c876ff29a83 Add \csimplemacro to parallel the csimplemacrodesc environment. Fred Drake <fdrake@acm.org> parents: 22637 diff changeset	660 % \begin{csimplemacrodesc}{name}
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	661 % -- "simple" because it has no args; NOT for constant definitions!
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	662 \newenvironment{csimplemacrodesc}[1]{
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	663 \begin{fulllineitems}
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	664 \item[\bfcode{#1}\index{#1@{\py@idxcode{#1}} (macro)}]
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	665 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	666
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	667 % simple functions (not methods) -----------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	668 % \begin{funcdesc}{name}{args}
15362 9a17cdcd3320 Fix \withsubitem so that it actually works if the only indexing macro in Fred Drake <fdrake@acm.org> parents: 15360 diff changeset	669 \newcommand{\funcline}[2]{%
9a17cdcd3320 Fix \withsubitem so that it actually works if the only indexing macro in Fred Drake <fdrake@acm.org> parents: 15360 diff changeset	670 \funclineni{#1}{#2}%
9a17cdcd3320 Fix \withsubitem so that it actually works if the only indexing macro in Fred Drake <fdrake@acm.org> parents: 15360 diff changeset	671 \index{#1@{\py@idxcode{#1()}} (in module \py@thismodule)}}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	672 \newenvironment{funcdesc}[2]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	673 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	674 \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	675 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	676
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	677 % similar to {funcdesc}, but doesn't add to the index
24090 bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	678 \newcommand{\funclineni}[2]{%
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	679 \py@sigline{\bfcode{#1}}{#2}}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	680 \newenvironment{funcdescni}[2]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	681 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	682 \funclineni{#1}{#2}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	683 }{\end{fulllineitems}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	684
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	685 % classes ----------------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	686 % \begin{classdesc}{name}{constructor args}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	687 \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	688 % 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	689 \global\def\py@thisclass{#1}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	690 \begin{fulllineitems}
24090 bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	691 \py@sigline{\strong{class }\bfcode{#1}}{#2}%
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	692 \index{#1@{\py@idxcode{#1}} (class in \py@thismodule)}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	693 }{\end{fulllineitems}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	694
17778 b4b3657cb1fa Define a new environment, classdesc, which can be used to document a Fred Drake <fdrake@acm.org>* parents: 17560 diff changeset	695 % \begin{classdesc*}{name}
b4b3657cb1fa Define a new environment, classdesc, which can be used to document a Fred Drake <fdrake@acm.org>* parents: 17560 diff changeset	696 \newenvironment{classdesc*}[1]{
b4b3657cb1fa Define a new environment, classdesc, which can be used to document a Fred Drake <fdrake@acm.org>* parents: 17560 diff changeset	697 % Using \renewcommand doesn't work for this, for unknown reasons:
b4b3657cb1fa Define a new environment, classdesc, which can be used to document a Fred Drake <fdrake@acm.org>* parents: 17560 diff changeset	698 \global\def\py@thisclass{#1}
b4b3657cb1fa Define a new environment, classdesc, which can be used to document a Fred Drake <fdrake@acm.org>* parents: 17560 diff changeset	699 \begin{fulllineitems}
b4b3657cb1fa Define a new environment, classdesc, which can be used to document a Fred Drake <fdrake@acm.org>* parents: 17560 diff changeset	700 \item[\strong{class }\code{\bfcode{#1}}%
b4b3657cb1fa Define a new environment, classdesc, which can be used to document a Fred Drake <fdrake@acm.org>* parents: 17560 diff changeset	701 \index{#1@{\py@idxcode{#1}} (class in \py@thismodule)}]
b4b3657cb1fa Define a new environment, classdesc, which can be used to document a Fred Drake <fdrake@acm.org>* parents: 17560 diff changeset	702 }{\end{fulllineitems}}
b4b3657cb1fa Define a new environment, classdesc, which can be used to document a Fred Drake <fdrake@acm.org>* parents: 17560 diff changeset	703
14490 f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	704 % \begin{excclassdesc}{name}{constructor args}
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	705 % but indexes as an exception
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	706 \newenvironment{excclassdesc}[2]{
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	707 % Using \renewcommand doesn't work for this, for unknown reasons:
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	708 \global\def\py@thisclass{#1}
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	709 \begin{fulllineitems}
24090 bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	710 \py@sigline{\strong{exception }\bfcode{#1}}{#2}%
bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	711 \index{#1@{\py@idxcode{#1}} (exception in \py@thismodule)}
14490 f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	712 }{\end{fulllineitems}}
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	713
17778 b4b3657cb1fa Define a new environment, classdesc, which can be used to document a Fred Drake <fdrake@acm.org>* parents: 17560 diff changeset	714 % There is no corresponding {excclassdesc*} environment. To describe
b4b3657cb1fa Define a new environment, classdesc, which can be used to document a Fred Drake <fdrake@acm.org>* parents: 17560 diff changeset	715 % a class exception without parameters, use the {excdesc} environment.
b4b3657cb1fa Define a new environment, classdesc, which can be used to document a Fred Drake <fdrake@acm.org>* parents: 17560 diff changeset	716
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	717
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	718 \let\py@classbadkey=\@undefined
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	719
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	720 % object method ----------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	721 % \begin{methoddesc}[classname]{methodname}{args}
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	722 \newcommand{\methodline}[3][\@undefined]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	723 \methodlineni{#2}{#3}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	724 \ifx#1\@undefined
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	725 \index{#2@{\py@idxcode{#2()}} (\py@thisclass\ method)}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	726 \else
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	727 \index{#2@{\py@idxcode{#2()}} (#1 method)}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	728 \fi
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	729 }
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	730 \newenvironment{methoddesc}[3][\@undefined]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	731 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	732 \ifx#1\@undefined
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	733 \methodline{#2}{#3}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	734 \else
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	735 \def\py@thisclass{#1}
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	736 \methodline{#2}{#3}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	737 \fi
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	738 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	739
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	740 % 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	741 % (never actually uses the optional argument)
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	742 \newcommand{\methodlineni}[3][\py@classbadkey]{%
24090 bc00eeef0ac7 Abstract the creation of signature lines for callable things; the new Fred Drake <fdrake@acm.org> parents: 23063 diff changeset	743 \py@sigline{\bfcode{#2}}{#3}}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	744 \newenvironment{methoddescni}[3][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	745 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	746 \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	747 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	748
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	749 % object data attribute --------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	750 % \begin{memberdesc}[classname]{membername}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	751 \newcommand{\memberline}[2][\py@classbadkey]{%
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	752 \ifx#1\@undefined
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	753 \memberlineni{#2}
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	754 \index{#2@{\py@idxcode{#2}} (\py@thisclass\ attribute)}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	755 \else
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	756 \memberlineni{#2}
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	757 \index{#2@{\py@idxcode{#2}} (#1 attribute)}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	758 \fi
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	759 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	760 \newenvironment{memberdesc}[2][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	761 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	762 \ifx#1\@undefined
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	763 \memberline{#2}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	764 \else
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	765 \def\py@thisclass{#1}
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	766 \memberline{#2}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	767 \fi
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	768 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	769
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	770 % 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	771 % (never actually uses the optional argument)
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	772 \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	773 \newenvironment{memberdescni}[2][\py@classbadkey]{
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	774 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	775 \memberlineni{#2}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	776 }{\end{fulllineitems}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	777
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	778 % For exceptions: --------------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	779 % \begin{excdesc}{name}
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	780 % -- for constructor information, use excclassdesc instead
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	781 \newenvironment{excdesc}[1]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	782 \begin{fulllineitems}
16966 38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	783 \item[\strong{exception }\bfcode{#1}%
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	784 \index{#1@{\py@idxcode{#1}} (exception in \py@thismodule)}]
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	785 }{\end{fulllineitems}}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	786
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	787 % Module data or constants: ----------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	788 % \begin{datadesc}{name}
15360 74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	789 \newcommand{\dataline}[1]{%
74e1d79520fd Avoid using \withsubitem and \ttindex internally; they have not proven Fred Drake <fdrake@acm.org> parents: 15310 diff changeset	790 \datalineni{#1}\index{#1@{\py@idxcode{#1}} (data in \py@thismodule)}}
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	791 \newenvironment{datadesc}[1]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	792 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	793 \dataline{#1}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	794 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	795
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	796 % 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	797 \newcommand{\datalineni}[1]{\item[\bfcode{#1}]\nopagebreak}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	798 \newenvironment{datadescni}[1]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	799 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	800 \datalineni{#1}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	801 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	802
7764 9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	803 % bytecode instruction ---------------------------------------------------
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	804 % \begin{opcodedesc}{name}{var}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	805 % -- {var} may be {}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	806 \newenvironment{opcodedesc}[2]{
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	807 \begin{fulllineitems}
9d0dc11775a4 Add comments about several of the environments. Fred Drake <fdrake@acm.org> parents: 7740 diff changeset	808 \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	809 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	810
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	811
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	812 \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	813
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	814 % 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	815 % {\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	816 \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	817 \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	818 \newcommand{\POSIX}{POSIX}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	819 \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	820 \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	821 \newcommand{\C}{C}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	822 \newcommand{\EOF}{{\sc eof}}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	823 \newcommand{\NULL}{\constant{NULL}}
18230 b893d12045cb \infinity, Fred Drake <fdrake@acm.org> parents: 18180 diff changeset	824 \newcommand{\infinity}{\ensuremath{\infty}}
b893d12045cb \infinity, Fred Drake <fdrake@acm.org> parents: 18180 diff changeset	825 \newcommand{\plusminus}{\ensuremath{\pm}}
31417 603a9eaa74e1 add \guilabel macro to mark labels that occur in user interfaces Fred Drake <fdrake@acm.org> parents: 31359 diff changeset	826
603a9eaa74e1 add \guilabel macro to mark labels that occur in user interfaces Fred Drake <fdrake@acm.org> parents: 31359 diff changeset	827 % \guilabel{Start}
603a9eaa74e1 add \guilabel macro to mark labels that occur in user interfaces Fred Drake <fdrake@acm.org> parents: 31359 diff changeset	828 \newcommand{\guilabel}[1]{\textsf{#1}}
24496 2670a5db6843 Add a comment showing how one of the macros should be used. Fred Drake <fdrake@acm.org> parents: 24090 diff changeset	829 % \menuselection{Start \sub Programs \sub Python}
31417 603a9eaa74e1 add \guilabel macro to mark labels that occur in user interfaces Fred Drake <fdrake@acm.org> parents: 31359 diff changeset	830 \newcommand{\menuselection}[1]{\guilabel{{\def\sub{ \ensuremath{>} }#1}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	831
7801 047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	832 % 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	833
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	834 % code is the most difficult one...
13234 79f8f6b963c2 Try to make sure \code always uses roman (non-italic) text. Fred Drake <fdrake@acm.org> parents: 12638 diff changeset	835 \newcommand{\code}[1]{\textrm{\@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	836 \texttt{#1}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	837
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	838 \newcommand{\bfcode}[1]{\code{\bfseries#1}} % bold-faced code font
22921 3c876ff29a83 Add \csimplemacro to parallel the csimplemacrodesc environment. Fred Drake <fdrake@acm.org> parents: 22637 diff changeset	839 \newcommand{\csimplemacro}[1]{\code{#1}}
8609 ce295bfacef3 Fix the \kbd definition so it didn't leave the courier face on. Fred Drake <fdrake@acm.org> parents: 8396 diff changeset	840 \newcommand{\kbd}[1]{\code{#1}}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	841 \newcommand{\samp}[1]{`\code{#1}'}
9542 1437c2335b3b Make \var work correctly in math mode. Fred Drake <fdrake@acm.org> parents: 9524 diff changeset	842 \newcommand{\var}[1]{%
1437c2335b3b Make \var work correctly in math mode. Fred Drake <fdrake@acm.org> parents: 9524 diff changeset	843 \ifmmode%
25979 d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	844 \hbox{\py@defaultsize\textrm{\textit{#1\/}}}%
9542 1437c2335b3b Make \var work correctly in math mode. Fred Drake <fdrake@acm.org> parents: 9524 diff changeset	845 \else%
25979 d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	846 \py@defaultsize\textrm{\textit{#1\/}}%
9542 1437c2335b3b Make \var work correctly in math mode. Fred Drake <fdrake@acm.org> parents: 9524 diff changeset	847 \fi%
1437c2335b3b Make \var work correctly in math mode. Fred Drake <fdrake@acm.org> parents: 9524 diff changeset	848 }
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	849 \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	850 \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	851 \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	852 % let's experiment with a new font:
25979 d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	853 \newcommand{\file}[1]{`\filenq{#1}'}
31498 51c3d452af2f support \e in \file and \filenq; this is useful for Windows paths Fred Drake <fdrake@acm.org> parents: 31417 diff changeset	854 \newcommand{\filenq}[1]{{\py@smallsize\textsf{\let\e=\textbackslash#1}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	855
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	856 % 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	857 % but only if we actually used hyperref:
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	858 \ifpdf
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	859 \newcommand{\url}[1]{{%
22589 66e85a732ddd Make \url to force horizontal mode. Fred Drake <fdrake@acm.org> parents: 22320 diff changeset	860 \noindent%
22316 cc788b3b21b6 Revise the markup related to the grammar productions to increase the Fred Drake <fdrake@acm.org> parents: 21418 diff changeset	861 \pdfstartlink attr{/Border [0 0 0]} user{/S /URI /URI (#1)}%
16966 38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	862 \py@LinkColor% color of the link text
25979 d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	863 \py@smallsize\sf #1%
16966 38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	864 \py@NormalColor% Turn it back off; these are declarative
38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	865 \pdfendlink}% and don't appear bound to the current
38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	866 }% formatting "box".
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	867 \else
25979 d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	868 \newcommand{\url}[1]{\mbox{\py@smallsize\textsf{#1}}}
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	869 \fi
25979 d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	870 \newcommand{\email}[1]{{\py@smallsize\textsf{#1}}}
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	871 \newcommand{\newsgroup}[1]{{\py@smallsize\textsf{#1}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	872
13834 4aebd0f2a062 \py@varvars: Merge the various definitions to be the simplist one that Fred Drake <fdrake@acm.org> parents: 13234 diff changeset	873 \newcommand{\py@varvars}[1]{{%
12215 774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	874 {\let\unspecified=\py@unspecified%
774817285b8c Merged changes from the 1.5.2p2 release. Fred Drake <fdrake@acm.org> parents: 11450 diff changeset	875 \let\moreargs=\py@moreargs%
13834 4aebd0f2a062 \py@varvars: Merge the various definitions to be the simplist one that Fred Drake <fdrake@acm.org> parents: 13234 diff changeset	876 \var{#1}}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	877
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	878 % 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	879 \newif\iftexi\texifalse
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	880
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	881 % 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	882 % 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	883 \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	884
9138272c1fe6 Define stuff to allow simple HTML-only selection using TeX's \if<foo>...\fi Fred Drake <fdrake@acm.org> parents: 8762 diff changeset	885
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	886 % 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	887 % 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	888 % 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	889 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	890 % 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	891 % 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	892 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	893 \newcommand{\module}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	894 \newcommand{\keyword}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	895 \newcommand{\exception}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	896 \newcommand{\class}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	897 \newcommand{\function}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	898 \newcommand{\member}[1]{\texttt{#1}}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	899 \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	900
16966 38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	901 \newcommand{\pytype}[1]{#1} % built-in Python type
7801 047996666c81 Removed an obsolete hack that's been commented out for a long time. Fred Drake <fdrake@acm.org> parents: 7792 diff changeset	902
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	903 \newcommand{\cfunction}[1]{\texttt{#1}}
16966 38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	904 \newcommand{\ctype}[1]{\texttt{#1}} % C struct or typedef name
38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	905 \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	906
25979 d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	907 \newcommand{\mailheader}[1]{{\py@smallsize\textsf{#1:}}}
d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	908 \newcommand{\mimetype}[1]{{\py@smallsize\textsf{#1}}}
7670 8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	909 % 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	910 \newcommand{\regexp}[1]{%
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	911 {\tiny$^{^\lceil}\!\!$%
25979 d812b8aaefb3 Define abstract way to get the normal and smaller font sizes that work Fred Drake <fdrake@acm.org> parents: 25972 diff changeset	912 {\py@defaultsize\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	913 $\!\rfloor\!$%
7670 8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	914 }}
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	915 \newcommand{\envvar}[1]{%
16118 64545c986b98 Remove the dollar sign from the formatting of environment variables -- Fred Drake <fdrake@acm.org> parents: 15362 diff changeset	916 #1%
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	917 \index{#1}%
16118 64545c986b98 Remove the dollar sign from the formatting of environment variables -- Fred Drake <fdrake@acm.org> parents: 15362 diff changeset	918 \index{environment variables!{#1}}%
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	919 }
16966 38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	920 \newcommand{\makevar}[1]{#1} % variable in a Makefile
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	921 \newcommand{\character}[1]{\samp{#1}}
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	922
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	923 % constants defined in Python modules or C headers, not language constants:
16966 38e17a089492 Label classes and exceptions explicitly in the documentation (for their Fred Drake <fdrake@acm.org> parents: 16118 diff changeset	924 \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	925
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	926 \newcommand{\manpage}[2]{{\emph{#1}(#2)}}
14490 f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	927 \newcommand{\pep}[1]{PEP #1\index{Python Enhancement Proposals!PEP #1}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	928 \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	929 \newcommand{\program}[1]{\strong{#1}}
11450 0a3bb403a430 \programopt: New macro, used to mark command-line parameters in the Fred Drake <fdrake@acm.org> parents: 11082 diff changeset	930 \newcommand{\programopt}[1]{\strong{#1}}
12377 052fbd931492 \longprogramopt: New macro. Fred Drake <fdrake@acm.org> parents: 12346 diff changeset	931 % Note that \longprogramopt provides the '--'!
052fbd931492 \longprogramopt: New macro. Fred Drake <fdrake@acm.org> parents: 12346 diff changeset	932 \newcommand{\longprogramopt}[1]{\strong{-{}-#1}}
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	933
18427 6a5ef1994153 Add \ulink, grammar production markup. Fred Drake <fdrake@acm.org> parents: 18230 diff changeset	934 % \ulink{link text}{URL}
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	935 \ifpdf
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	936 % The \noindent here is a hack -- we're forcing pdfTeX into
22316 cc788b3b21b6 Revise the markup related to the grammar productions to increase the Fred Drake <fdrake@acm.org> parents: 21418 diff changeset	937 % horizontal mode since \pdfstartlink requires that.
30345 00453a0508df add a note about how \ulink should be different than it actually is Fred Drake <fdrake@acm.org> parents: 29897 diff changeset	938 % For PDF, we should only generate a link when the URL is absolute.
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	939 \newcommand{\ulink}[2]{\noindent{%
22316 cc788b3b21b6 Revise the markup related to the grammar productions to increase the Fred Drake <fdrake@acm.org> parents: 21418 diff changeset	940 \pdfstartlink attr{/Border [0 0 0]} user{/S /URI /URI (#2)}%
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	941 \py@LinkColor% color of the link text
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	942 #1%
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	943 \py@NormalColor% Turn it back off; these are declarative
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	944 \pdfendlink}% and don't appear bound to the current
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	945 }% formatting "box".
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	946 \else
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	947 \newcommand{\ulink}[2]{#1}
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	948 \fi
11450 0a3bb403a430 \programopt: New macro, used to mark command-line parameters in the Fred Drake <fdrake@acm.org> parents: 11082 diff changeset	949
0a3bb403a430 \programopt: New macro, used to mark command-line parameters in the Fred Drake <fdrake@acm.org> parents: 11082 diff changeset	950 % cited titles: \citetitle{Title of Work}
0a3bb403a430 \programopt: New macro, used to mark command-line parameters in the Fred Drake <fdrake@acm.org> parents: 11082 diff changeset	951 % online: \citetitle[url-to-resource]{Title of Work}
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	952 \ifpdf
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	953 \newcommand{\citetitle}[2][\py@modulebadkey]{%
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	954 \ifx\py@modulebadkey#1\emph{#2}\else\ulink{\emph{#2}}{#1}\fi%
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	955 }
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	956 \else
20841 eacf81df6c42 Fix stupid bug recently introduced for DVI version of the docs (used to Fred Drake <fdrake@acm.org> parents: 20751 diff changeset	957 \newcommand{\citetitle}[2][URL]{\emph{#2}}
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	958 \fi
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	959
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	960
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	961
21347 f59c6b5dd122 Save a new version of the productionlist environment for safe-keeping; this Fred Drake <fdrake@acm.org> parents: 21116 diff changeset	962 % This version is being checked in for the historical record; it shows
f59c6b5dd122 Save a new version of the productionlist environment for safe-keeping; this Fred Drake <fdrake@acm.org> parents: 21116 diff changeset	963 % how I've managed to get some aspects of this to work. It will not
f59c6b5dd122 Save a new version of the productionlist environment for safe-keeping; this Fred Drake <fdrake@acm.org> parents: 21116 diff changeset	964 % be used in practice, so a subsequent revision will change things
f59c6b5dd122 Save a new version of the productionlist environment for safe-keeping; this Fred Drake <fdrake@acm.org> parents: 21116 diff changeset	965 % again. This version has problems, but shows how to do something
f59c6b5dd122 Save a new version of the productionlist environment for safe-keeping; this Fred Drake <fdrake@acm.org> parents: 21116 diff changeset	966 % that proved more tedious than I'd expected, so I don't want to lose
f59c6b5dd122 Save a new version of the productionlist environment for safe-keeping; this Fred Drake <fdrake@acm.org> parents: 21116 diff changeset	967 % the example completely.
f59c6b5dd122 Save a new version of the productionlist environment for safe-keeping; this Fred Drake <fdrake@acm.org> parents: 21116 diff changeset	968 %
19412 d4ba6e2aaae3 New \grammartoken markup, similar to \token but allowed everywhere. Fred Drake <fdrake@acm.org> parents: 18981 diff changeset	969 \newcommand{\grammartoken}[1]{\texttt{#1}}
18427 6a5ef1994153 Add \ulink, grammar production markup. Fred Drake <fdrake@acm.org> parents: 18230 diff changeset	970 \newenvironment{productionlist}[1][\py@badkey]{
6a5ef1994153 Add \ulink, grammar production markup. Fred Drake <fdrake@acm.org> parents: 18230 diff changeset	971 \def\optional##1{{\Large[}##1{\Large]}}
6a5ef1994153 Add \ulink, grammar production markup. Fred Drake <fdrake@acm.org> parents: 18230 diff changeset	972 \def\production##1##2{\code{##1}&::=&\code{##2}\\}
22316 cc788b3b21b6 Revise the markup related to the grammar productions to increase the Fred Drake <fdrake@acm.org> parents: 21418 diff changeset	973 \def\productioncont##1{& &\code{##1}\\}
18427 6a5ef1994153 Add \ulink, grammar production markup. Fred Drake <fdrake@acm.org> parents: 18230 diff changeset	974 \def\token##1{##1}
19412 d4ba6e2aaae3 New \grammartoken markup, similar to \token but allowed everywhere. Fred Drake <fdrake@acm.org> parents: 18981 diff changeset	975 \let\grammartoken=\token
21347 f59c6b5dd122 Save a new version of the productionlist environment for safe-keeping; this Fred Drake <fdrake@acm.org> parents: 21116 diff changeset	976 \parindent=2em
f59c6b5dd122 Save a new version of the productionlist environment for safe-keeping; this Fred Drake <fdrake@acm.org> parents: 21116 diff changeset	977 \indent
f59c6b5dd122 Save a new version of the productionlist environment for safe-keeping; this Fred Drake <fdrake@acm.org> parents: 21116 diff changeset	978 \begin{tabular}{lcl}
18427 6a5ef1994153 Add \ulink, grammar production markup. Fred Drake <fdrake@acm.org> parents: 18230 diff changeset	979 }{%
21347 f59c6b5dd122 Save a new version of the productionlist environment for safe-keeping; this Fred Drake <fdrake@acm.org> parents: 21116 diff changeset	980 \end{tabular}
18427 6a5ef1994153 Add \ulink, grammar production markup. Fred Drake <fdrake@acm.org> parents: 18230 diff changeset	981 }
6a5ef1994153 Add \ulink, grammar production markup. Fred Drake <fdrake@acm.org> parents: 18230 diff changeset	982
31845 64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	983 \newlength{\py@noticelength}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	984
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	985 \newcommand{\py@heavybox}{
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	986 \setlength{\fboxrule}{2pt}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	987 \setlength{\fboxsep}{7pt}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	988 \setlength{\py@noticelength}{\linewidth}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	989 \addtolength{\py@noticelength}{-2\fboxsep}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	990 \addtolength{\py@noticelength}{-2\fboxrule}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	991 \setlength{\shadowsize}{3pt}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	992 \Sbox
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	993 \minipage{\py@noticelength}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	994 }
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	995 \newcommand{\py@endheavybox}{
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	996 \endminipage
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	997 \endSbox
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	998 \fbox{\TheSbox}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	999 }
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	1000
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	1001 % a 'note' is as plain as it gets:
21418 571d5b7b746c Add a new environment for whole-paragraph (or longer) notes & warnings. Fred Drake <fdrake@acm.org> parents: 21347 diff changeset	1002 \newcommand{\py@noticelabel@note}{Note:}
31845 64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	1003 \newcommand{\py@noticestart@note}{}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	1004 \newcommand{\py@noticeend@note}{}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	1005
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	1006 % a 'warning' gets more visible distinction:
21418 571d5b7b746c Add a new environment for whole-paragraph (or longer) notes & warnings. Fred Drake <fdrake@acm.org> parents: 21347 diff changeset	1007 \newcommand{\py@noticelabel@warning}{Warning:}
31845 64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	1008 \newcommand{\py@noticestart@warning}{\py@heavybox}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	1009 \newcommand{\py@noticeend@warning}{\py@endheavybox}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	1010
21418 571d5b7b746c Add a new environment for whole-paragraph (or longer) notes & warnings. Fred Drake <fdrake@acm.org> parents: 21347 diff changeset	1011 \newenvironment{notice}[1][note]{
31845 64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	1012 \def\py@noticetype{#1}
64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	1013 \csname py@noticestart@#1\endcsname
21418 571d5b7b746c Add a new environment for whole-paragraph (or longer) notes & warnings. Fred Drake <fdrake@acm.org> parents: 21347 diff changeset	1014 \par\strong{\csname py@noticelabel@#1\endcsname}
31845 64cc163eeaf1 add a heavy box around warning notices to make them really stand out in the Fred Drake <fdrake@acm.org> parents: 31507 diff changeset	1015 }{\csname py@noticeend@\py@noticetype\endcsname}
21418 571d5b7b746c Add a new environment for whole-paragraph (or longer) notes & warnings. Fred Drake <fdrake@acm.org> parents: 21347 diff changeset	1016 \newcommand{\note}[1]{\strong{\py@noticelabel@note} #1}
571d5b7b746c Add a new environment for whole-paragraph (or longer) notes & warnings. Fred Drake <fdrake@acm.org> parents: 21347 diff changeset	1017 \newcommand{\warning}[1]{\strong{\py@noticelabel@warning} #1}
20336 1b3ffdf12150 New markup: \note{...} and \warning{...} Fred Drake <fdrake@acm.org> parents: 20113 diff changeset	1018
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1019 % Deprecation stuff.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1020 % 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	1021 % 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	1022 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1023 % 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	1024 % 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	1025 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1026 % Example:
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	1027 % \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	1028 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1029 \newcommand{\deprecated}[2]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1030 \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	1031
8762 4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	1032 % New stuff.
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	1033 % This should be used to mark things which have been added to the
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	1034 % development tree but that aren't in the release, but are documented.
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	1035 % This allows release of documentation that already includes updated
10077 80b215249b17 Make \versionadded and \versionchanged less prominant -- neither bold Fred Drake <fdrake@acm.org> parents: 9968 diff changeset	1036 % descriptions. Place at end of descriptor environment.
8762 4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	1037 %
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	1038 % Example:
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	1039 % \versionadded{1.5.2}
13234 79f8f6b963c2 Try to make sure \code always uses roman (non-italic) text. Fred Drake <fdrake@acm.org> parents: 12638 diff changeset	1040 % \versionchanged[short explanation]{2.0}
8762 4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	1041 %
17560 db928a277f8b \versionadded: Add support for including an explanatory note along with Fred Drake <fdrake@acm.org> parents: 17380 diff changeset	1042 \newcommand{\versionadded}[2][\py@badkey]{%
db928a277f8b \versionadded: Add support for including an explanatory note along with Fred Drake <fdrake@acm.org> parents: 17380 diff changeset	1043 \ifx#1\@undefined%
db928a277f8b \versionadded: Add support for including an explanatory note along with Fred Drake <fdrake@acm.org> parents: 17380 diff changeset	1044 { New in version #2. }%
db928a277f8b \versionadded: Add support for including an explanatory note along with Fred Drake <fdrake@acm.org> parents: 17380 diff changeset	1045 \else%
db928a277f8b \versionadded: Add support for including an explanatory note along with Fred Drake <fdrake@acm.org> parents: 17380 diff changeset	1046 { New in version #2:\ #1. }%
db928a277f8b \versionadded: Add support for including an explanatory note along with Fred Drake <fdrake@acm.org> parents: 17380 diff changeset	1047 \fi%
db928a277f8b \versionadded: Add support for including an explanatory note along with Fred Drake <fdrake@acm.org> parents: 17380 diff changeset	1048 }
12549 efd1e5d2284a \versionchanged: Added optional parameter for explanation of change. Fred Drake <fdrake@acm.org> parents: 12500 diff changeset	1049 \newcommand{\versionchanged}[2][\py@badkey]{%
efd1e5d2284a \versionchanged: Added optional parameter for explanation of change. Fred Drake <fdrake@acm.org> parents: 12500 diff changeset	1050 \ifx#1\@undefined%
efd1e5d2284a \versionchanged: Added optional parameter for explanation of change. Fred Drake <fdrake@acm.org> parents: 12500 diff changeset	1051 { Changed in version #2. }%
efd1e5d2284a \versionchanged: Added optional parameter for explanation of change. Fred Drake <fdrake@acm.org> parents: 12500 diff changeset	1052 \else%
efd1e5d2284a \versionchanged: Added optional parameter for explanation of change. Fred Drake <fdrake@acm.org> parents: 12500 diff changeset	1053 { Changed in version #2:\ #1. }%
efd1e5d2284a \versionchanged: Added optional parameter for explanation of change. Fred Drake <fdrake@acm.org> parents: 12500 diff changeset	1054 \fi%
efd1e5d2284a \versionchanged: Added optional parameter for explanation of change. Fred Drake <fdrake@acm.org> parents: 12500 diff changeset	1055 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1056
8762 4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	1057
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	1058 % Tables.
4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	1059 %
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1060 \newenvironment{tableii}[4]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1061 \begin{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1062 \def\lineii##1##2{\csname#2\endcsname{##1}&##2\\}%
15310 5d2a2185c651 Remove second horizontal line below table headers; it is just too Fred Drake <fdrake@acm.org> parents: 14722 diff changeset	1063 \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	1064 }{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1065 \end{tabular}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1066 \end{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1067 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1068
14722 4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1069 \newenvironment{longtableii}[4]{%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1070 \begin{center}%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1071 \def\lineii##1##2{\csname#2\endcsname{##1}&##2\\}%
15310 5d2a2185c651 Remove second horizontal line below table headers; it is just too Fred Drake <fdrake@acm.org> parents: 14722 diff changeset	1072 \begin{longtable}[c]{#1}\strong{#3}&\strong{#4} \\* \hline\endhead%
14722 4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1073 }{%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1074 \end{longtable}%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1075 \end{center}%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1076 }
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1077
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1078 \newenvironment{tableiii}[5]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1079 \begin{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1080 \def\lineiii##1##2##3{\csname#2\endcsname{##1}&##2&##3\\}%
14722 4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1081 \begin{tabular}{#1}\strong{#3}&\strong{#4}&\strong{#5} \\%
15310 5d2a2185c651 Remove second horizontal line below table headers; it is just too Fred Drake <fdrake@acm.org> parents: 14722 diff changeset	1082 \hline%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1083 }{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1084 \end{tabular}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1085 \end{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1086 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1087
14722 4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1088 \newenvironment{longtableiii}[5]{%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1089 \begin{center}%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1090 \def\lineiii##1##2##3{\csname#2\endcsname{##1}&##2&##3\\}%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1091 \begin{longtable}[c]{#1}\strong{#3}&\strong{#4}&\strong{#5} \\%
15310 5d2a2185c651 Remove second horizontal line below table headers; it is just too Fred Drake <fdrake@acm.org> parents: 14722 diff changeset	1092 \hline\endhead%
14722 4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1093 }{%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1094 \end{longtable}%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1095 \end{center}%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1096 }
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1097
8751 99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	1098 \newenvironment{tableiv}[6]{%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	1099 \begin{center}%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	1100 \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	1101 \begin{tabular}{#1}\strong{#3}&\strong{#4}&\strong{#5}&\strong{#6} \\%
15310 5d2a2185c651 Remove second horizontal line below table headers; it is just too Fred Drake <fdrake@acm.org> parents: 14722 diff changeset	1102 \hline%
8751 99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	1103 }{%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	1104 \end{tabular}%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	1105 \end{center}%
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	1106 }
99793302d10d {tableiv} environment: Four-column table. Fred Drake <fdrake@acm.org> parents: 8726 diff changeset	1107
14722 4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1108 \newenvironment{longtableiv}[6]{%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1109 \begin{center}%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1110 \def\lineiv##1##2##3##4{\csname#2\endcsname{##1}&##2&##3&##4\\}%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1111 \begin{longtable}[c]{#1}\strong{#3}&\strong{#4}&\strong{#5}&\strong{#6}%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1112 \\%
15310 5d2a2185c651 Remove second horizontal line below table headers; it is just too Fred Drake <fdrake@acm.org> parents: 14722 diff changeset	1113 \hline\endhead%
14722 4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1114 }{%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1115 \end{longtable}%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1116 \end{center}%
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1117 }
4d2e9cf1eb20 Add new environments: longtableii, longtableiii, and longtableiv, to Fred Drake <fdrake@acm.org> parents: 14555 diff changeset	1118
18683 8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1119 \newenvironment{tablev}[7]{%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1120 \begin{center}%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1121 \def\linev##1##2##3##4##5{\csname#2\endcsname{##1}&##2&##3&##4&##5\\}%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1122 \begin{tabular}{#1}\strong{#3}&\strong{#4}&\strong{#5}&\strong{#6}&\strong{#7} \\%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1123 \hline%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1124 }{%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1125 \end{tabular}%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1126 \end{center}%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1127 }
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1128
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1129 \newenvironment{longtablev}[7]{%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1130 \begin{center}%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1131 \def\linev##1##2##3##4##5{\csname#2\endcsname{##1}&##2&##3&##4&##5\\}%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1132 \begin{longtable}[c]{#1}\strong{#3}&\strong{#4}&\strong{#5}&\strong{#6}&\strong{#7}%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1133 \\%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1134 \hline\endhead%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1135 }{%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1136 \end{longtable}%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1137 \end{center}%
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1138 }
8ca70c9c1971 Define new markup for 5-column tables. Fred Drake <fdrake@acm.org> parents: 18427 diff changeset	1139
26875 d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1140 % XXX Don't think we can use this yet, though it cleans up some
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1141 % tedious markup. There's no equivalent for the HTML transform yet,
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1142 % and that needs to exist. I don't know how to write it.
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1143 %
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1144 % This should really have something that makes it easier to bind a
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1145 % table's ``Notes'' column and an associated tablenotes environment,
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1146 % and generates the right magic for getting the numbers right in the
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1147 % table.
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1148 %
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1149 % So this is quite incomplete.
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1150 %
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1151 \newcounter{py@tablenotescounter}
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1152 \newenvironment{tablenotes}{%
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1153 \noindent Notes:
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1154 \par
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1155 \setcounter{py@tablenotescounter}{0}
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1156 \begin{list}{(\arabic{py@tablenotescounter})}%
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1157 {\usecounter{py@tablenotescounter}}
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1158 }{\end{list}}
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1159
d177dd0ca8f7 Start something that might make table notes easier to deal with, Fred Drake <fdrake@acm.org> parents: 26015 diff changeset	1160
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	1161 % 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	1162 % Sample usage:
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1163 % \begin{seealso}
10846 b7378df3db56 Change the look of \seemodule output to fit in better. Fred Drake <fdrake@acm.org> parents: 10770 diff changeset	1164 % \seemodule{rand}{Uniform random number generator.}; % Module xref
b7378df3db56 Change the look of \seemodule output to fit in better. Fred Drake <fdrake@acm.org> parents: 10770 diff changeset	1165 % \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	1166 %
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	1167 % % A funky case: module name contains '_'; have to supply an optional key
10846 b7378df3db56 Change the look of \seemodule output to fit in better. Fred Drake <fdrake@acm.org> parents: 10770 diff changeset	1168 % \seemodule[copyreg]{copy_reg}{Interface constructor registration for
b7378df3db56 Change the look of \seemodule output to fit in better. Fred Drake <fdrake@acm.org> parents: 10770 diff changeset	1169 % \module{pickle}.}
b7378df3db56 Change the look of \seemodule output to fit in better. Fred Drake <fdrake@acm.org> parents: 10770 diff changeset	1170 % \end{seealso}
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	1171 %
10846 b7378df3db56 Change the look of \seemodule output to fit in better. Fred Drake <fdrake@acm.org> parents: 10770 diff changeset	1172 % Note that the last parameter for \seemodule and \seetext should be complete
b7378df3db56 Change the look of \seemodule output to fit in better. Fred Drake <fdrake@acm.org> parents: 10770 diff changeset	1173 % sentences and be terminated with the proper punctuation.
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1174
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1175 \ifpdf
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1176 \newcommand{\py@seemodule}[3][\py@modulebadkey]{%
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1177 \par%
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1178 \ifx\py@modulebadkey#1\def\py@modulekey{#2}\else\def\py@modulekey{#1}\fi%
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1179 \begin{fulllineitems}
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1180 \item[\py@linkToName{label-module-\py@modulekey}{Module \module{#2}}
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1181 (section \ref{module-\py@modulekey}):]
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1182 #3
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1183 \end{fulllineitems}
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1184 }
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1185 \else
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	1186 \newcommand{\py@seemodule}[3][\py@modulebadkey]{%
9868 a58f36352c4f \seemodule: Fix so that each \seemodule entry gets its own paragraph, Fred Drake <fdrake@acm.org> parents: 9542 diff changeset	1187 \par%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	1188 \ifx\py@modulebadkey#1\def\py@modulekey{#2}\else\def\py@modulekey{#1}\fi%
10846 b7378df3db56 Change the look of \seemodule output to fit in better. Fred Drake <fdrake@acm.org> parents: 10770 diff changeset	1189 \begin{fulllineitems}
b7378df3db56 Change the look of \seemodule output to fit in better. Fred Drake <fdrake@acm.org> parents: 10770 diff changeset	1190 \item[Module \module{#2} (section \ref{module-\py@modulekey}):]
b7378df3db56 Change the look of \seemodule output to fit in better. Fred Drake <fdrake@acm.org> parents: 10770 diff changeset	1191 #3
b7378df3db56 Change the look of \seemodule output to fit in better. Fred Drake <fdrake@acm.org> parents: 10770 diff changeset	1192 \end{fulllineitems}
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	1193 }
20751 85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1194 \fi
85109a6099b5 Revise the PDF support in the LaTeX style sheet. This still isn't quite Fred Drake <fdrake@acm.org> parents: 20336 diff changeset	1195
31359 17ca347303d3 add new reference macro: \seelink Fred Drake <fdrake@acm.org> parents: 30722 diff changeset	1196 % \seelink{url}{link text}
17ca347303d3 add new reference macro: \seelink Fred Drake <fdrake@acm.org> parents: 30722 diff changeset	1197 \newcommand{\py@seelink}[3]{%
17ca347303d3 add new reference macro: \seelink Fred Drake <fdrake@acm.org> parents: 30722 diff changeset	1198 \par
17ca347303d3 add new reference macro: \seelink Fred Drake <fdrake@acm.org> parents: 30722 diff changeset	1199 \begin{fulllineitems}
17ca347303d3 add new reference macro: \seelink Fred Drake <fdrake@acm.org> parents: 30722 diff changeset	1200 \item[\ulink{#2}{#1}]
17ca347303d3 add new reference macro: \seelink Fred Drake <fdrake@acm.org> parents: 30722 diff changeset	1201 #3
17ca347303d3 add new reference macro: \seelink Fred Drake <fdrake@acm.org> parents: 30722 diff changeset	1202 \end{fulllineitems}
17ca347303d3 add new reference macro: \seelink Fred Drake <fdrake@acm.org> parents: 30722 diff changeset	1203 }
14521 9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1204 % \seetitle[url]{title}{why it's interesting}
9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1205 \newcommand{\py@seetitle}[3][\py@modulebadkey]{%
9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1206 \par
9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1207 \begin{fulllineitems}
9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1208 \item[\citetitle{#2}]
9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1209 \ifx\py@modulebadkey#1\else
9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1210 \item[{\small{(\url{#1})}}]
9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1211 \fi
9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1212 #3
9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1213 \end{fulllineitems}
9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1214 }
14490 f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	1215 % \seepep{number}{title}{why it's interesting}
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	1216 \newcommand{\py@seepep}[3]{%
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	1217 \par%
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	1218 \begin{fulllineitems}
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	1219 \item[\pep{#1}, ``\emph{#2}'']
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	1220 #3
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	1221 \end{fulllineitems}
f78f287b3add excclassdesc: New environment. For use in documenting class-based Fred Drake <fdrake@acm.org> parents: 14020 diff changeset	1222 }
12500 eb433efa24de Define \seerfc within the seealso environment. Fred Drake <fdrake@acm.org> parents: 12377 diff changeset	1223 % \seerfc{number}{title}{why it's interesting}
eb433efa24de Define \seerfc within the seealso environment. Fred Drake <fdrake@acm.org> parents: 12377 diff changeset	1224 \newcommand{\py@seerfc}[3]{%
eb433efa24de Define \seerfc within the seealso environment. Fred Drake <fdrake@acm.org> parents: 12377 diff changeset	1225 \par%
eb433efa24de Define \seerfc within the seealso environment. Fred Drake <fdrake@acm.org> parents: 12377 diff changeset	1226 \begin{fulllineitems}
eb433efa24de Define \seerfc within the seealso environment. Fred Drake <fdrake@acm.org> parents: 12377 diff changeset	1227 \item[\rfc{#1}, ``\emph{#2}'']
eb433efa24de Define \seerfc within the seealso environment. Fred Drake <fdrake@acm.org> parents: 12377 diff changeset	1228 #3
eb433efa24de Define \seerfc within the seealso environment. Fred Drake <fdrake@acm.org> parents: 12377 diff changeset	1229 \end{fulllineitems}
eb433efa24de Define \seerfc within the seealso environment. Fred Drake <fdrake@acm.org> parents: 12377 diff changeset	1230 }
12638 def959352422 Define \seeurl in the seealso environment. Two parameters: url, why. Fred Drake <fdrake@acm.org> parents: 12549 diff changeset	1231 % \seeurl{url}{why it's interesting}
def959352422 Define \seeurl in the seealso environment. Two parameters: url, why. Fred Drake <fdrake@acm.org> parents: 12549 diff changeset	1232 \newcommand{\py@seeurl}[2]{%
def959352422 Define \seeurl in the seealso environment. Two parameters: url, why. Fred Drake <fdrake@acm.org> parents: 12549 diff changeset	1233 \par%
def959352422 Define \seeurl in the seealso environment. Two parameters: url, why. Fred Drake <fdrake@acm.org> parents: 12549 diff changeset	1234 \begin{fulllineitems}
def959352422 Define \seeurl in the seealso environment. Two parameters: url, why. Fred Drake <fdrake@acm.org> parents: 12549 diff changeset	1235 \item[\url{#1}]
def959352422 Define \seeurl in the seealso environment. Two parameters: url, why. Fred Drake <fdrake@acm.org> parents: 12549 diff changeset	1236 #2
def959352422 Define \seeurl in the seealso environment. Two parameters: url, why. Fred Drake <fdrake@acm.org> parents: 12549 diff changeset	1237 \end{fulllineitems}
def959352422 Define \seeurl in the seealso environment. Two parameters: url, why. Fred Drake <fdrake@acm.org> parents: 12549 diff changeset	1238 }
21116 0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1239
0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1240 \newenvironment{seealso*}{
10423 9a4baf0c57ea Add some (commented out) macros to change the page size to the size of Fred Drake <fdrake@acm.org> parents: 10328 diff changeset	1241 \par
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1242 \def\seetext##1{\par{##1}}
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	1243 \let\seemodule=\py@seemodule
14521 9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1244 \let\seepep=\py@seepep
12500 eb433efa24de Define \seerfc within the seealso environment. Fred Drake <fdrake@acm.org> parents: 12377 diff changeset	1245 \let\seerfc=\py@seerfc
14521 9fed4eebc586 \seetitle: New macro for building reference list content. Fred Drake <fdrake@acm.org> parents: 14490 diff changeset	1246 \let\seetitle=\py@seetitle
12638 def959352422 Define \seeurl in the seealso environment. Two parameters: url, why. Fred Drake <fdrake@acm.org> parents: 12549 diff changeset	1247 \let\seeurl=\py@seeurl
31359 17ca347303d3 add new reference macro: \seelink Fred Drake <fdrake@acm.org> parents: 30722 diff changeset	1248 \let\seelink=\py@seelink
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1249 }{\par}
21116 0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1250 \newenvironment{seealso}{
0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1251 \par
0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1252 \strong{See Also:}
0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1253 \par
0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1254 \def\seetext##1{\par{##1}}
0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1255 \let\seemodule=\py@seemodule
0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1256 \let\seepep=\py@seepep
0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1257 \let\seerfc=\py@seerfc
0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1258 \let\seetitle=\py@seetitle
0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1259 \let\seeurl=\py@seeurl
31359 17ca347303d3 add new reference macro: \seelink Fred Drake <fdrake@acm.org> parents: 30722 diff changeset	1260 \let\seelink=\py@seelink
21116 0a67463f8b7d Add a new environment in the Python docs markup: seealso. This is similar Fred Drake <fdrake@acm.org>* parents: 20841 diff changeset	1261 }{\par}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1262
8762 4192a73ca430 \versionadded, Fred Drake <fdrake@acm.org> parents: 8751 diff changeset	1263 % 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	1264 % \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	1265 % 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	1266 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	1267 \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	1268 \newcommand{\version}{}
14555 219e00221c84 \shortversion, Fred Drake <fdrake@acm.org> parents: 14521 diff changeset	1269 \newcommand{\shortversion}{}
18180 c25876a51f1b Add a little more support for describing version information. This Fred Drake <fdrake@acm.org> parents: 17778 diff changeset	1270 \newcommand{\releaseinfo}{}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1271 \newcommand{\releasename}{Release}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1272 \newcommand{\release}[1]{%
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	1273 \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	1274 \renewcommand{\version}{#1}}
14555 219e00221c84 \shortversion, Fred Drake <fdrake@acm.org> parents: 14521 diff changeset	1275 \newcommand{\setshortversion}[1]{%
219e00221c84 \shortversion, Fred Drake <fdrake@acm.org> parents: 14521 diff changeset	1276 \renewcommand{\shortversion}{#1}}
18180 c25876a51f1b Add a little more support for describing version information. This Fred Drake <fdrake@acm.org> parents: 17778 diff changeset	1277 \newcommand{\setreleaseinfo}[1]{%
c25876a51f1b Add a little more support for describing version information. This Fred Drake <fdrake@acm.org> parents: 17778 diff changeset	1278 \renewcommand{\releaseinfo}{#1}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1279
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1280 % 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	1281 % 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	1282 % 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	1283 %
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	1284 \newcommand{\py@authoraddress}{}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	1285 \newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}}
8341 ebfde06fdb8d Added definitions for \developer, \developers, \developersaddress. Fred Drake <fdrake@acm.org> parents: 8306 diff changeset	1286 \let\developersaddress=\authoraddress
ebfde06fdb8d Added definitions for \developer, \developers, \developersaddress. Fred Drake <fdrake@acm.org> parents: 8306 diff changeset	1287 \let\developer=\author
ebfde06fdb8d Added definitions for \developer, \developers, \developersaddress. Fred Drake <fdrake@acm.org> parents: 8306 diff changeset	1288 \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	1289
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1290 % 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	1291 % 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	1292 %
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	1293 \@ifundefined{ChTitleVar}{}{
8190 25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	1294 \ChNameVar{\raggedleft\normalsize\py@HeaderFamily}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	1295 \ChNumVar{\raggedleft \bfseries\Large\py@HeaderFamily}
25c2aea64501 Fixed \code so word wrapping is allowed. Fred Drake <fdrake@acm.org> parents: 8076 diff changeset	1296 \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	1297 % 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	1298 \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	1299 {\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	1300 \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	1301 \DOCH
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1302 \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	1303 \interlinepenalty\@M
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1304 \DOTI{#1}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1305 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1306 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1307 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1308
8396 79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	1309
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	1310 % 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	1311 % 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	1312 %
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	1313 \newenvironment{definitions}{%
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	1314 \begin{description}%
9078 18f81faf4bd9 \itembreak, Fred Drake <fdrake@acm.org> parents: 8916 diff changeset	1315 \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	1316 }{%
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	1317 \end{description}%
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	1318 }
79071a4e0eca Added {definitions} environment, which has \term to define indivual terms. Fred Drake <fdrake@acm.org> parents: 8341 diff changeset	1319
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	1320 % 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	1321 \hyphenation{Base-HTTP-Re-quest-Hand-ler}

Mercurial > cpython-lru_cache-weakref

annotate Doc/texinputs/python.sty @ 33216:6b743cbc4171 legacy-trunk