Mercurial > cpython-lru_cache-weakref
annotate Doc/texinputs/python.sty @ 15362:9a17cdcd3320 legacy-trunk
Fix \withsubitem so that it actually works if the only indexing macro in
the content body is the \ttindex macro, which seems to match actual usage.
Adjust \funcline to restore the "index sub-item" for functions to be
" (in module <name>)" instead of " (in <name>)". This is need to match
uses of \withsubitem throughout the documentation. (Not ideal, but
gets achieves consistency.)
| author | Fred Drake <fdrake@acm.org> |
|---|---|
| date | Mon, 30 Oct 2000 06:22:22 +0000 |
| parents | 74e1d79520fd |
| children | 64545c986b98 |
| rev | line source |
|---|---|
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1 % |
|
7592
09440606aac5
Oops; file copy error somewhere along the way....
Fred Drake <fdrake@acm.org>
parents:
7585
diff
changeset
|
2 % python.sty for the Python docummentation [works only with with Latex2e] |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
3 % |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
4 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
5 \NeedsTeXFormat{LaTeX2e}[1995/12/01] |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
6 \ProvidesPackage{python} |
|
7737
5d7e4d20c89e
Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the
Fred Drake <fdrake@acm.org>
parents:
7706
diff
changeset
|
7 [1998/01/11 LaTeX package (Python markup)] |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
8 |
|
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 | 17 % These packages can be used to add marginal annotations which indicate |
| 18 % index entries and labels; useful for reviewing this messy documentation! | |
| 19 % | |
| 20 %\RequirePackage{showkeys} | |
| 21 %\RequirePackage{showidx} | |
| 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 |
|
7737
5d7e4d20c89e
Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the
Fred Drake <fdrake@acm.org>
parents:
7706
diff
changeset
|
29 \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
|
30 \else |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
31 \input{pdfcolor} |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
32 \let\py@LinkColor=\NavyBlue |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
33 \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
|
34 \pdfcompresslevel=9 |
|
8306
4674cd2f6f07
Set the right page size in the PDF output.
Fred Drake <fdrake@acm.org>
parents:
8229
diff
changeset
|
35 \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
|
36 \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
|
37 % |
|
8067
48e2349d11c6
Fix the broken PDF links, really this time!
Fred Drake <fdrake@acm.org>
parents:
8066
diff
changeset
|
38 % 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
|
39 % of any other. |
|
48e2349d11c6
Fix the broken PDF links, really this time!
Fred Drake <fdrake@acm.org>
parents:
8066
diff
changeset
|
40 % |
|
8713
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
41 \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
|
42 \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
|
43 % |
|
7585
2ef0aca96f2d
Revise some of the PDF support to get at least preliminary outline support.
Fred Drake <fdrake@acm.org>
parents:
7561
diff
changeset
|
44 % 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
|
45 % 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
|
46 % |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
47 \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
|
48 % |
|
485502c42d89
\py@linkToName: New macro to consolidate support for most internal
Fred Drake <fdrake@acm.org>
parents:
9958
diff
changeset
|
49 % 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
|
50 % 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
|
51 % 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
|
52 % this style file. |
|
485502c42d89
\py@linkToName: New macro to consolidate support for most internal
Fred Drake <fdrake@acm.org>
parents:
9958
diff
changeset
|
53 \newcommand{\py@linkToName}[2]{% |
|
485502c42d89
\py@linkToName: New macro to consolidate support for most internal
Fred Drake <fdrake@acm.org>
parents:
9958
diff
changeset
|
54 \pdfannotlink attr{/Border [0 0 0]} goto name{#1}% |
|
485502c42d89
\py@linkToName: New macro to consolidate support for most internal
Fred Drake <fdrake@acm.org>
parents:
9958
diff
changeset
|
55 \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
|
56 \pdfendlink% |
|
485502c42d89
\py@linkToName: New macro to consolidate support for most internal
Fred Drake <fdrake@acm.org>
parents:
9958
diff
changeset
|
57 } |
|
8067
48e2349d11c6
Fix the broken PDF links, really this time!
Fred Drake <fdrake@acm.org>
parents:
8066
diff
changeset
|
58 % 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
|
59 % \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
|
60 \renewcommand{\contentsline}[3]{% |
|
8067
48e2349d11c6
Fix the broken PDF links, really this time!
Fred Drake <fdrake@acm.org>
parents:
8066
diff
changeset
|
61 \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
|
62 \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
|
63 } |
|
7585
2ef0aca96f2d
Revise some of the PDF support to get at least preliminary outline support.
Fred Drake <fdrake@acm.org>
parents:
7561
diff
changeset
|
64 \AtEndDocument{ |
|
7737
5d7e4d20c89e
Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the
Fred Drake <fdrake@acm.org>
parents:
7706
diff
changeset
|
65 \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
|
66 } |
|
8067
48e2349d11c6
Fix the broken PDF links, really this time!
Fred Drake <fdrake@acm.org>
parents:
8066
diff
changeset
|
67 \newcommand{\py@target}[1]{% |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
68 \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
|
69 {\pdfdest name{#1} xyz}% |
|
8067
48e2349d11c6
Fix the broken PDF links, really this time!
Fred Drake <fdrake@acm.org>
parents:
8066
diff
changeset
|
70 \fi% |
|
48e2349d11c6
Fix the broken PDF links, really this time!
Fred Drake <fdrake@acm.org>
parents:
8066
diff
changeset
|
71 } |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
72 \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
|
73 \renewcommand{\label}[1]{% |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
74 \py@OldLabel{#1}% |
|
8067
48e2349d11c6
Fix the broken PDF links, really this time!
Fred Drake <fdrake@acm.org>
parents:
8066
diff
changeset
|
75 \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
|
76 } |
|
8306
4674cd2f6f07
Set the right page size in the PDF output.
Fred Drake <fdrake@acm.org>
parents:
8229
diff
changeset
|
77 % 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
|
78 % 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
|
79 % 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
|
80 % |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
81 % 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
|
82 % |
|
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
|
83 \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
|
84 \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
|
85 \@hyperfixhead |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
86 } |
|
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
|
87 \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
|
88 \let\H@old@thehead\@thehead |
|
8067
48e2349d11c6
Fix the broken PDF links, really this time!
Fred Drake <fdrake@acm.org>
parents:
8066
diff
changeset
|
89 \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
|
90 \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
|
91 \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
|
92 \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
|
93 } |
|
7737
5d7e4d20c89e
Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the
Fred Drake <fdrake@acm.org>
parents:
7706
diff
changeset
|
94 \fi\fi |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
95 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
96 % 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
|
97 \topmargin 0pt |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
98 \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
|
99 \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
|
100 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
101 % 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
|
102 \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
|
103 \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
|
104 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
105 \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
|
106 \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
|
107 %\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
|
108 \marginparwidth 0.5in |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
109 |
|
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
|
110 \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
|
111 \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
|
112 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
113 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
114 % 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
|
115 \raggedbottom |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
116 \sloppy |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
117 \parindent = 0mm |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
118 \parskip = 2mm |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
119 \hbadness = 5000 % don't print trivial gripes |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
120 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
121 \pagestyle{empty} % start this way; change for |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
122 \pagenumbering{roman} % ToC & chapters |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
123 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
124 % 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
|
125 \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
|
126 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
127 % 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
|
128 \@ifundefined{fancyhf}{}{ |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
129 % 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
|
130 \fancypagestyle{normal}{ |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
131 \fancyhf{} |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
132 \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
133 \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
134 \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
|
135 \renewcommand{\headrulewidth}{0pt} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
136 \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
|
137 } |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
138 % 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
|
139 % 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
|
140 % 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
|
141 \fancypagestyle{plain}{ |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
142 \fancyhf{} |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
143 \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
|
144 \renewcommand{\headrulewidth}{0pt} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
145 \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
|
146 } |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
147 % 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
|
148 % 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
|
149 % 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
|
150 \@ifundefined{chapter}{}{ |
|
7548
7eb19b1ce84d
Improve separation of document class and python semantic constructs. This
Fred Drake <fdrake@acm.org>
parents:
7527
diff
changeset
|
151 \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
|
152 \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
|
153 \hbox{} |
|
7eb19b1ce84d
Improve separation of document class and python semantic constructs. This
Fred Drake <fdrake@acm.org>
parents:
7527
diff
changeset
|
154 \thispagestyle{plain} |
|
7eb19b1ce84d
Improve separation of document class and python semantic constructs. This
Fred Drake <fdrake@acm.org>
parents:
7527
diff
changeset
|
155 \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
|
156 \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
|
157 } |
|
7eb19b1ce84d
Improve separation of document class and python semantic constructs. This
Fred Drake <fdrake@acm.org>
parents:
7527
diff
changeset
|
158 } |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
159 } |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
160 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
161 % 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
|
162 % 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
|
163 % code samples. |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
164 |
|
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
|
165 \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
|
166 \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
|
167 \RequirePackage{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
|
168 |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
169 % Variable used by begin code command |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
170 \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
|
171 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
172 \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
|
173 \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
|
174 % 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
|
175 \setlength{\py@codewidth}{\linewidth}% |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
176 \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
|
177 % |
|
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
|
178 \par\indent% |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
179 \begin{minipage}[t]{\py@codewidth}% |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
180 \small% |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
181 \py@OldVerbatim% |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
182 } |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
183 \renewcommand{\endverbatim}{% |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
184 \py@OldEndVerbatim% |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
185 \end{minipage}% |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
186 } |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
187 |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
188 |
|
8713
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
189 \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
|
190 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
191 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
192 %% 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
|
193 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
194 % 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
|
195 % 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
|
196 % 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
|
197 % 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
|
198 % |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
199 \newcommand{\py@idxcode}[1]{\texttt{#1}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
200 %\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
|
201 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
202 % 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
|
203 \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
|
204 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
205 % 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
|
206 \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
|
207 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
208 % 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
|
209 \newcommand{\indexiv}[4]{ |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
210 \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
|
211 \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
|
212 \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
|
213 \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
|
214 } |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
215 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
216 % 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
|
217 % operator. |
| 8229 | 218 \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
|
219 \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
|
220 \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
|
221 \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
|
222 \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
|
223 \newcommand{\bifuncindex}[1]{% |
|
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
224 \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
|
225 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
226 % 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
|
227 \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
|
228 \newcommand{\refmodindex}[1]{\py@refmodule{#1}{}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
229 \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
|
230 \newcommand{\refexmodindex}[1]{\py@refmodule{#1}{extension }} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
231 \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
|
232 |
|
9868
a58f36352c4f
\seemodule: Fix so that each \seemodule entry gets its own paragraph,
Fred Drake <fdrake@acm.org>
parents:
9542
diff
changeset
|
233 % 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
|
234 % name, at least if we're building PDF: |
|
a58f36352c4f
\seemodule: Fix so that each \seemodule entry gets its own paragraph,
Fred Drake <fdrake@acm.org>
parents:
9542
diff
changeset
|
235 \@ifundefined{pdfannotlink}{% |
|
a58f36352c4f
\seemodule: Fix so that each \seemodule entry gets its own paragraph,
Fred Drake <fdrake@acm.org>
parents:
9542
diff
changeset
|
236 \newcommand{\refmodule}[2][\py@modulebadkey]{\module{#2}} |
|
9968
485502c42d89
\py@linkToName: New macro to consolidate support for most internal
Fred Drake <fdrake@acm.org>
parents:
9958
diff
changeset
|
237 }{% |
|
485502c42d89
\py@linkToName: New macro to consolidate support for most internal
Fred Drake <fdrake@acm.org>
parents:
9958
diff
changeset
|
238 \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
|
239 \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
|
240 \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
|
241 } |
|
a58f36352c4f
\seemodule: Fix so that each \seemodule entry gets its own paragraph,
Fred Drake <fdrake@acm.org>
parents:
9542
diff
changeset
|
242 } |
|
a58f36352c4f
\seemodule: Fix so that each \seemodule entry gets its own paragraph,
Fred Drake <fdrake@acm.org>
parents:
9542
diff
changeset
|
243 |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
244 % support for the module index |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
245 \newif\ifpy@UseModuleIndex |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
246 \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
|
247 |
|
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
|
248 \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
|
249 \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
|
250 \openout\modindexfile=mod\jobname.idx |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
251 \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
|
252 } |
|
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
|
253 |
|
7659
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
254 % 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
|
255 \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
|
256 \renewcommand{\py@thismodule}{#1} |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
257 \setindexsubitem{(in module #1)}% |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
258 \index{#1@{\py@idxcode{#1}} (#2module)|textbf}% |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
259 \ifpy@UseModuleIndex% |
|
10328
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
260 \@ifundefined{py@modplat@\py@thismodulekey}{ |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
261 \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
|
262 }{\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
|
263 \emph{(\py@platformof[\py@thismodulekey]{})}}}{\thepage}}% |
|
10328
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
264 } |
|
7659
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
265 \fi% |
|
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
266 } |
|
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
267 |
|
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
|
268 % *** 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
|
269 |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
270 % 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
|
271 \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
|
272 \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
|
273 \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
|
274 \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
|
275 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
276 % 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
|
277 \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
|
278 \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
|
279 \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
|
280 \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
|
281 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
282 % 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
|
283 \newif\ifpy@usingsubitem\py@usingsubitemfalse |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
284 \newcommand{\py@indexsubitem}{} |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
285 \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
|
286 \py@usingsubitemtrue} |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
287 \newcommand{\ttindex}[1]{% |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
288 \ifpy@usingsubitem |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
289 \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
|
290 \else% |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
291 \index{#1@{\py@idxcode{#1}}}% |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
292 \fi% |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
293 } |
|
7659
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
294 \newcommand{\withsubitem}[2]{% |
|
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
295 \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
|
296 \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
|
297 #2% |
|
7659
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
298 \endgroup% |
|
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
299 } |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
300 |
|
7801
047996666c81
Removed an obsolete hack that's been commented out for a long time.
Fred Drake <fdrake@acm.org>
parents:
7792
diff
changeset
|
301 |
|
8713
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
302 % Module synopsis processing ----------------------------------------------- |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
303 % |
|
10328
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
304 \newcommand{\py@thisclass}{} |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
305 \newcommand{\py@thismodule}{} |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
306 \newcommand{\py@thismodulekey}{} |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
307 \newcommand{\py@thismoduletype}{} |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
308 |
|
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
|
309 \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
|
310 \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
|
311 \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
|
312 \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
|
313 |
|
10328
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
314 \newif\ifpy@HaveModSynopsis \py@HaveModSynopsisfalse |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
315 \newif\ifpy@ModSynopsisFileIsOpen \py@ModSynopsisFileIsOpenfalse |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
316 \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
|
317 |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
318 % \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
|
319 \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
|
320 \py@openModSynopsisFile |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
321 \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
|
322 \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
|
323 \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
|
324 \else |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
325 \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
|
326 \fi |
|
10855
28887f40e344
\declaremodule: Make this more robust. Only attempt to add an index
Fred Drake <fdrake@acm.org>
parents:
10846
diff
changeset
|
327 \@ifundefined{py@#2IndexModule}{% |
|
28887f40e344
\declaremodule: Make this more robust. Only attempt to add an index
Fred Drake <fdrake@acm.org>
parents:
10846
diff
changeset
|
328 \typeout{*** MACRO declaremodule called with unknown module type: `#2'} |
| 10856 | 329 \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
|
330 }{% |
|
28887f40e344
\declaremodule: Make this more robust. Only attempt to add an index
Fred Drake <fdrake@acm.org>
parents:
10846
diff
changeset
|
331 \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
|
332 } |
|
8713
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
333 \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
|
334 } |
|
10328
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
335 \newif\ifpy@ModPlatformFileIsOpen \py@ModPlatformFileIsOpenfalse |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
336 \newcommand{\py@ModPlatformFilename}{\jobname.pla} |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
337 \newcommand{\platform}[1]{ |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
338 \ifpy@ModPlatformFileIsOpen\else |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
339 \newwrite\py@ModPlatformFile |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
340 \openout\py@ModPlatformFile=\py@ModPlatformFilename |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
341 \py@ModPlatformFileIsOpentrue |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
342 \fi |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
343 } |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
344 \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
|
345 \newcommand{\py@platformof}[2][\py@modulebadkey]{% |
|
10328
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
346 \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
|
347 \else \def\py@key{#1}% |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
348 \fi% |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
349 \csname py@modplat@\py@key\endcsname% |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
350 } |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
351 \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
|
352 |
| 8916 | 353 % \moduleauthor{name}{email} |
| 354 \newcommand{\moduleauthor}[2]{} | |
| 355 | |
| 356 % \sectionauthor{name}{email} | |
| 357 \newcommand{\sectionauthor}[2]{} | |
| 358 | |
|
8713
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
359 |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
360 \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
|
361 \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
|
362 \newcommand{\modulesynopsis}[1]{ |
|
10328
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
363 \py@HaveModSynopsistrue |
|
8713
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
364 \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
|
365 } |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
366 |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
367 % define the file |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
368 \newwrite\py@ModSynopsisFile |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
369 |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
370 % 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
|
371 \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
|
372 \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
|
373 {\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
|
374 {\string#1}% |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
375 } |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
376 \newcommand{\py@closeModSynopsisFile}{ |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
377 \ifpy@ModSynopsisFileIsOpen |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
378 \closeout\py@ModSynopsisFile |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
379 \py@ModSynopsisFileIsOpenfalse |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
380 \fi |
|
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 \newcommand{\py@openModSynopsisFile}{ |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
383 \ifpy@ModSynopsisFileIsOpen\else |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
384 \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
|
385 \py@ModSynopsisFileIsOpentrue |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
386 \fi |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
387 } |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
388 |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
389 \newcommand{\py@ProcessModSynopsis}{ |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
390 \ifpy@HaveModSynopsis |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
391 \py@writeModSynopsisFile{\modulesynopsis% |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
392 {\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
|
393 {\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
|
394 \py@HaveModSynopsisfalse |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
395 \fi |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
396 \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
|
397 } |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
398 \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
|
399 |
|
10328
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
400 |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
401 \long\def\py@writeModPlatformFile#1{% |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
402 \protected@write\py@ModPlatformFile% |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
403 {\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
|
404 {\string#1}% |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
405 } |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
406 |
|
f438c6e2b6c1
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
Fred Drake <fdrake@acm.org>
parents:
10077
diff
changeset
|
407 |
|
8713
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
408 \newcommand{\localmoduletable}{ |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
409 \IfFileExists{\py@ModSynopsisFilename}{ |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
410 \begin{synopsistable} |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
411 \input{\py@ModSynopsisFilename} |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
412 \end{synopsistable} |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
413 }{} |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
414 } |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
415 |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
416 \@ifundefined{pdfoutput}{ |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
417 \newcommand{\py@ModSynopsisSummary}[4]{\bfcode{#2} & #4\\} |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
418 }{ |
|
9968
485502c42d89
\py@linkToName: New macro to consolidate support for most internal
Fred Drake <fdrake@acm.org>
parents:
9958
diff
changeset
|
419 \newcommand{\py@ModSynopsisSummary}[4]{% |
|
485502c42d89
\py@linkToName: New macro to consolidate support for most internal
Fred Drake <fdrake@acm.org>
parents:
9958
diff
changeset
|
420 \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
|
421 } |
|
8713
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
422 } |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
423 \newenvironment{synopsistable}{ |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
424 % 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
|
425 \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
|
426 \begin{tabular}{ll} |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
427 }{ |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
428 \end{tabular} |
|
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 % -------------------------------------------------------------------------- |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
432 |
|
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 \newcommand{\py@reset}{ |
|
12215
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
435 \py@usingsubitemfalse |
|
8713
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
436 \py@ProcessModSynopsis |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
437 \renewcommand{\py@thisclass}{} |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
438 \renewcommand{\py@thismodule}{} |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
439 \renewcommand{\py@thismodulekey}{} |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
440 \renewcommand{\py@thismoduletype}{} |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
441 } |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
442 |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
443 % 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
|
444 % 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
|
445 \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
|
446 \@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
|
447 {-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
|
448 {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
|
449 {\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
|
450 \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
|
451 {-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
|
452 {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
|
453 {\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
|
454 \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
|
455 {-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
|
456 {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
|
457 {\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
|
458 \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
|
459 {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
|
460 {-1em}% |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
461 {\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
|
462 \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
|
463 {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
|
464 {-1em}% |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
465 {\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
|
466 |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
467 |
|
8726
74ea4dfda82d
\textunderscore: Re-define with a width that's more appropriate for the
Fred Drake <fdrake@acm.org>
parents:
8713
diff
changeset
|
468 % 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
|
469 % 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
|
470 |
|
74ea4dfda82d
\textunderscore: Re-define with a width that's more appropriate for the
Fred Drake <fdrake@acm.org>
parents:
8713
diff
changeset
|
471 \DeclareTextCommandDefault{\textunderscore}{% |
|
74ea4dfda82d
\textunderscore: Re-define with a width that's more appropriate for the
Fred Drake <fdrake@acm.org>
parents:
8713
diff
changeset
|
472 \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
|
473 |
|
8713
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
474 % 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
|
475 % |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
476 % 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
|
477 % Latex 2e. |
|
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 \DeclareRobustCommand\hackscore{% |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
480 \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
|
481 } |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
482 \begingroup |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
483 \catcode`\_\active |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
484 \def\next{% |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
485 \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
|
486 } |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
487 \expandafter\endgroup\next |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
488 |
|
ed8f4e2eb11a
Lots of new stuff for "module synopsis support." Public interface consists
Fred Drake <fdrake@acm.org>
parents:
8609
diff
changeset
|
489 |
|
7801
047996666c81
Removed an obsolete hack that's been commented out for a long time.
Fred Drake <fdrake@acm.org>
parents:
7792
diff
changeset
|
490 % 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
|
491 % 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
|
492 % 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
|
493 |
|
047996666c81
Removed an obsolete hack that's been commented out for a long time.
Fred Drake <fdrake@acm.org>
parents:
7792
diff
changeset
|
494 |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
495 % {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
|
496 % 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
|
497 % |
| 9078 | 498 \newcommand{\py@itemnewline}[1]{% |
| 499 \@tempdima\linewidth% | |
| 500 \advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}% | |
| 501 } | |
| 502 | |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
503 \newenvironment{fulllineitems}{ |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
504 \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
|
505 \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
|
506 \itemsep -\parsep |
| 9078 | 507 \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
|
508 }{\end{list}} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
509 |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
510 % \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
|
511 % {*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
|
512 % be used in the debugger chapter. |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
513 % |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
514 % Typical usage: |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
515 % |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
516 % \begin{funcdesc}{myfunc}{reqparm\optional{, optparm}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
517 % ^^^ ^^^ |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
518 % No space here No space here |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
519 % |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
520 % 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
|
521 % nested, not chained. This is right: |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
522 % |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
523 % \begin{funcdesc}{myfunc}{\optional{parm1\optional{, parm2}}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
524 % |
|
12215
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
525 \let\py@badkey=\@undefined |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
526 |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
527 \newcommand{\optional}[1]{% |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
528 {\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
|
529 |
|
12215
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
530 % 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
|
531 % 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
|
532 \newcommand{\py@moreargs}{...} |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
533 |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
534 % 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
|
535 % 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
|
536 % something else. |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
537 \newcommand{\py@unspecified}{...} |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
538 |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
539 % C functions ------------------------------------------------------------ |
|
12215
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
540 % \begin{cfuncdesc}[refcount]{type}{name}{arglist} |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
541 % 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
|
542 % tools/anno-api.py; it pulls the value from the refcounts database. |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
543 \newenvironment{cfuncdesc}[4][\py@badkey]{ |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
544 \begin{fulllineitems} |
|
12215
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
545 \item[\code{#2 \bfcode{#3}(\py@varvars{#4})}\index{#3@{\py@idxcode{#3()}}}] |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
546 \ifx#1\@undefined\else% |
| 12346 | 547 \emph{Return value: \textbf{#1}.}\\ |
|
12215
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
548 \fi |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
549 }{\end{fulllineitems}} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
550 |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
551 % C variables ------------------------------------------------------------ |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
552 % \begin{cvardesc}{type}{name} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
553 \newenvironment{cvardesc}[2]{ |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
554 \begin{fulllineitems} |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
555 \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
|
556 }{\end{fulllineitems}} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
557 |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
558 % C data types ----------------------------------------------------------- |
|
12215
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
559 % \begin{ctypedesc}[index name]{typedef name} |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
560 \newenvironment{ctypedesc}[2][\py@badkey]{ |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
561 \begin{fulllineitems} |
|
12215
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
562 \item[\bfcode{#2}% |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
563 \ifx#1\@undefined% |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
564 \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
|
565 \else% |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
566 \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
|
567 \fi] |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
568 }{\end{fulllineitems}} |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
569 |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
570 % Funky macros ----------------------------------------------------------- |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
571 % \begin{csimplemacro}{name} |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
572 % -- "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
|
573 \newenvironment{csimplemacrodesc}[1]{ |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
574 \begin{fulllineitems} |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
575 \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
|
576 }{\end{fulllineitems}} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
577 |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
578 % simple functions (not methods) ----------------------------------------- |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
579 % \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
|
580 \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
|
581 \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
|
582 \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
|
583 \newenvironment{funcdesc}[2]{ |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
584 \begin{fulllineitems} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
585 \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
|
586 }{\end{fulllineitems}} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
587 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
588 % similar to {funcdesc}, but doesn't add to the index |
|
8075
e39145a13096
Hide \varvars from "public" interface.
Fred Drake <fdrake@acm.org>
parents:
8067
diff
changeset
|
589 \newcommand{\funclineni}[2]{\item[\code{\bfcode{#1}(\py@varvars{#2})}]} |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
590 \newenvironment{funcdescni}[2]{ |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
591 \begin{fulllineitems} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
592 \funclineni{#1}{#2} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
593 }{\end{fulllineitems}} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
594 |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
595 % classes ---------------------------------------------------------------- |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
596 % \begin{classdesc}{name}{constructor args} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
597 \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
|
598 % 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
|
599 \global\def\py@thisclass{#1} |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
600 \begin{fulllineitems} |
|
8075
e39145a13096
Hide \varvars from "public" interface.
Fred Drake <fdrake@acm.org>
parents:
8067
diff
changeset
|
601 \item[\code{\bfcode{#1}(\py@varvars{#2})}% |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
602 \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
|
603 }{\end{fulllineitems}} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
604 |
|
14490
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
605 % \begin{excclassdesc}{name}{constructor args} |
|
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
606 % but indexes as an exception |
|
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
607 \newenvironment{excclassdesc}[2]{ |
|
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
608 % 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
|
609 \global\def\py@thisclass{#1} |
|
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
610 \begin{fulllineitems} |
|
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
611 \item[\code{\bfcode{#1}(\py@varvars{#2})}% |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
612 \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
|
613 }{\end{fulllineitems}} |
|
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
614 |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
615 |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
616 \let\py@classbadkey=\@undefined |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
617 |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
618 % object method ---------------------------------------------------------- |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
619 % \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
|
620 \newcommand{\methodline}[3][\@undefined]{ |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
621 \methodlineni{#2}{#3} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
622 \ifx#1\@undefined |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
623 \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
|
624 \else |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
625 \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
|
626 \fi |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
627 } |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
628 \newenvironment{methoddesc}[3][\@undefined]{ |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
629 \begin{fulllineitems} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
630 \ifx#1\@undefined |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
631 \methodline{#2}{#3} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
632 \else |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
633 \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
|
634 \methodline{#2}{#3} |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
635 \fi |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
636 }{\end{fulllineitems}} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
637 |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
638 % 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
|
639 % (never actually uses the optional argument) |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
640 \newcommand{\methodlineni}[3][\py@classbadkey]{% |
|
8075
e39145a13096
Hide \varvars from "public" interface.
Fred Drake <fdrake@acm.org>
parents:
8067
diff
changeset
|
641 \item[\code{\bfcode{#2}(\py@varvars{#3})}]} |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
642 \newenvironment{methoddescni}[3][\py@classbadkey]{ |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
643 \begin{fulllineitems} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
644 \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
|
645 }{\end{fulllineitems}} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
646 |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
647 % object data attribute -------------------------------------------------- |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
648 % \begin{memberdesc}[classname]{membername} |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
649 \newcommand{\memberline}[2][\py@classbadkey]{% |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
650 \ifx#1\@undefined |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
651 \memberlineni{#2} |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
652 \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
|
653 \else |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
654 \memberlineni{#2} |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
655 \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
|
656 \fi |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
657 } |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
658 \newenvironment{memberdesc}[2][\py@classbadkey]{ |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
659 \begin{fulllineitems} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
660 \ifx#1\@undefined |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
661 \memberline{#2} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
662 \else |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
663 \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
|
664 \memberline{#2} |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
665 \fi |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
666 }{\end{fulllineitems}} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
667 |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
668 % 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
|
669 % (never actually uses the optional argument) |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
670 \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
|
671 \newenvironment{memberdescni}[2][\py@classbadkey]{ |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
672 \begin{fulllineitems} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
673 \memberlineni{#2} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
674 }{\end{fulllineitems}} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
675 |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
676 % For exceptions: -------------------------------------------------------- |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
677 % \begin{excdesc}{name} |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
678 % -- for constructor information, use excclassdesc instead |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
679 \newenvironment{excdesc}[1]{ |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
680 \begin{fulllineitems} |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
681 \item[\bfcode{#1}% |
|
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
682 \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
|
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 % Module data or constants: ---------------------------------------------- |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
686 % \begin{datadesc}{name} |
|
15360
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
687 \newcommand{\dataline}[1]{% |
|
74e1d79520fd
Avoid using \withsubitem and \ttindex internally; they have not proven
Fred Drake <fdrake@acm.org>
parents:
15310
diff
changeset
|
688 \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
|
689 \newenvironment{datadesc}[1]{ |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
690 \begin{fulllineitems} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
691 \dataline{#1} |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
692 }{\end{fulllineitems}} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
693 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
694 % 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
|
695 \newcommand{\datalineni}[1]{\item[\bfcode{#1}]\nopagebreak} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
696 \newenvironment{datadescni}[1]{ |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
697 \begin{fulllineitems} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
698 \datalineni{#1} |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
699 }{\end{fulllineitems}} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
700 |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
701 % bytecode instruction --------------------------------------------------- |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
702 % \begin{opcodedesc}{name}{var} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
703 % -- {var} may be {} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
704 \newenvironment{opcodedesc}[2]{ |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
705 \begin{fulllineitems} |
|
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
706 \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
|
707 }{\end{fulllineitems}} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
708 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
709 |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
710 \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
|
711 |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
712 % 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
|
713 % {\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
|
714 \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
|
715 \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
|
716 \newcommand{\POSIX}{POSIX} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
717 \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
|
718 \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
|
719 \newcommand{\C}{C} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
720 \newcommand{\EOF}{{\sc eof}} |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
721 \newcommand{\NULL}{\constant{NULL}} |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
722 |
|
7801
047996666c81
Removed an obsolete hack that's been commented out for a long time.
Fred Drake <fdrake@acm.org>
parents:
7792
diff
changeset
|
723 % 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
|
724 |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
725 % 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
|
726 \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
|
727 \texttt{#1}}} |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
728 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
729 \newcommand{\bfcode}[1]{\code{\bfseries#1}} % bold-faced code font |
|
8609
ce295bfacef3
Fix the \kbd definition so it didn't leave the courier face on.
Fred Drake <fdrake@acm.org>
parents:
8396
diff
changeset
|
730 \newcommand{\kbd}[1]{\code{#1}} |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
731 \newcommand{\samp}[1]{`\code{#1}'} |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
732 % This weird definition of \var{} allows it to always appear in roman |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
733 % italics, and won't get funky in code fragments when we play around |
|
9542
1437c2335b3b
Make \var work correctly in math mode.
Fred Drake <fdrake@acm.org>
parents:
9524
diff
changeset
|
734 % with fonts. This also works directly in math mode. |
|
1437c2335b3b
Make \var work correctly in math mode.
Fred Drake <fdrake@acm.org>
parents:
9524
diff
changeset
|
735 \newcommand{\var}[1]{% |
|
1437c2335b3b
Make \var work correctly in math mode.
Fred Drake <fdrake@acm.org>
parents:
9524
diff
changeset
|
736 \ifmmode% |
|
1437c2335b3b
Make \var work correctly in math mode.
Fred Drake <fdrake@acm.org>
parents:
9524
diff
changeset
|
737 \hbox{\normalsize\textrm{\textit{#1\/}}}% |
|
1437c2335b3b
Make \var work correctly in math mode.
Fred Drake <fdrake@acm.org>
parents:
9524
diff
changeset
|
738 \else% |
|
1437c2335b3b
Make \var work correctly in math mode.
Fred Drake <fdrake@acm.org>
parents:
9524
diff
changeset
|
739 \normalsize\textrm{\textit{#1\/}}% |
|
1437c2335b3b
Make \var work correctly in math mode.
Fred Drake <fdrake@acm.org>
parents:
9524
diff
changeset
|
740 \fi% |
|
1437c2335b3b
Make \var work correctly in math mode.
Fred Drake <fdrake@acm.org>
parents:
9524
diff
changeset
|
741 } |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
742 \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
|
743 \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
|
744 \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
|
745 % let's experiment with a new font: |
|
7659
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
746 \newcommand{\file}[1]{`{\small\textsf{#1}}'} |
|
10770
fb1733b6bef5
\filenq: Like \file, but don't use single-quotes; this looks better
Fred Drake <fdrake@acm.org>
parents:
10451
diff
changeset
|
747 \newcommand{\filenq}[1]{{\small\textsf{#1}}} |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
748 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
749 % 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
|
750 % but only if we actually used hyperref: |
|
7764
9d0dc11775a4
Add comments about several of the environments.
Fred Drake <fdrake@acm.org>
parents:
7740
diff
changeset
|
751 \@ifundefined{pdfannotlink}{ |
|
8067
48e2349d11c6
Fix the broken PDF links, really this time!
Fred Drake <fdrake@acm.org>
parents:
8066
diff
changeset
|
752 \newcommand{\py@url}[1]{\mbox{\small\textsf{#1}}} |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
753 }{ |
|
8067
48e2349d11c6
Fix the broken PDF links, really this time!
Fred Drake <fdrake@acm.org>
parents:
8066
diff
changeset
|
754 \newcommand{\py@url}[1]{{% |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
755 \pdfannotlink attr{/Border [0 0 0]} user{/S /URI /URI (#1)}% |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
756 \py@LinkColor% color of the link text |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
757 \mbox{\small\textsf{#1}}% |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
758 \py@NormalColor% Turn it back off; these are declarative |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
759 \pdfendlink}% and don't appear bound to the current |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
760 }% formatting "box". |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
761 } |
|
8067
48e2349d11c6
Fix the broken PDF links, really this time!
Fred Drake <fdrake@acm.org>
parents:
8066
diff
changeset
|
762 \let\url=\py@url |
|
7659
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
763 \newcommand{\email}[1]{{\small\textsf{#1}}} |
| 7778 | 764 \newcommand{\newsgroup}[1]{{\small\textsf{#1}}} |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
765 |
|
13834
4aebd0f2a062
\py@varvars: Merge the various definitions to be the simplist one that
Fred Drake <fdrake@acm.org>
parents:
13234
diff
changeset
|
766 \newcommand{\py@varvars}[1]{{% |
|
12215
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
767 {\let\unspecified=\py@unspecified% |
|
774817285b8c
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
11450
diff
changeset
|
768 \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
|
769 \var{#1}}}} |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
770 |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
771 % 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
|
772 \newif\iftexi\texifalse |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
773 |
|
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
|
774 % 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
|
775 % 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
|
776 \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
|
777 |
|
9138272c1fe6
Define stuff to allow simple HTML-only selection using TeX's \if<foo>...\fi
Fred Drake <fdrake@acm.org>
parents:
8762
diff
changeset
|
778 |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
779 % 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
|
780 % 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
|
781 % 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
|
782 % |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
783 % 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
|
784 % 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
|
785 % |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
786 \newcommand{\module}[1]{\texttt{#1}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
787 \newcommand{\keyword}[1]{\texttt{#1}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
788 \newcommand{\exception}[1]{\texttt{#1}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
789 \newcommand{\class}[1]{\texttt{#1}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
790 \newcommand{\function}[1]{\texttt{#1}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
791 \newcommand{\member}[1]{\texttt{#1}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
792 \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
|
793 |
|
7801
047996666c81
Removed an obsolete hack that's been commented out for a long time.
Fred Drake <fdrake@acm.org>
parents:
7792
diff
changeset
|
794 \newcommand{\pytype}[1]{#1} % built-in Python type |
|
047996666c81
Removed an obsolete hack that's been commented out for a long time.
Fred Drake <fdrake@acm.org>
parents:
7792
diff
changeset
|
795 |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
796 \newcommand{\cfunction}[1]{\texttt{#1}} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
797 \newcommand{\ctype}[1]{\texttt{#1}} % C struct or typedef name |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
798 \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
|
799 |
|
7659
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
800 \newcommand{\mimetype}[1]{{\small\textsf{#1}}} |
|
7670
8e6a58019887
\regexp{}: Rewritten to look like Freidl's book. Too rip-off?
Fred Drake <fdrake@acm.org>
parents:
7659
diff
changeset
|
801 % 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
|
802 \newcommand{\regexp}[1]{% |
|
8e6a58019887
\regexp{}: Rewritten to look like Freidl's book. Too rip-off?
Fred Drake <fdrake@acm.org>
parents:
7659
diff
changeset
|
803 {\tiny$^{^\lceil}\!\!$% |
|
8e6a58019887
\regexp{}: Rewritten to look like Freidl's book. Too rip-off?
Fred Drake <fdrake@acm.org>
parents:
7659
diff
changeset
|
804 {\normalsize\code{#1}}% |
|
7850
db1e49d51fe1
Increase space between the end of a regexp and the little right floor symbol
Fred Drake <fdrake@acm.org>
parents:
7801
diff
changeset
|
805 $\!\rfloor\!$% |
|
7670
8e6a58019887
\regexp{}: Rewritten to look like Freidl's book. Too rip-off?
Fred Drake <fdrake@acm.org>
parents:
7659
diff
changeset
|
806 }} |
|
7659
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
807 \newcommand{\envvar}[1]{% |
|
7670
8e6a58019887
\regexp{}: Rewritten to look like Freidl's book. Too rip-off?
Fred Drake <fdrake@acm.org>
parents:
7659
diff
changeset
|
808 \$#1% $ <-- bow to font-lock 3 times! |
|
8e6a58019887
\regexp{}: Rewritten to look like Freidl's book. Too rip-off?
Fred Drake <fdrake@acm.org>
parents:
7659
diff
changeset
|
809 \index{#1@{\$#1}}% $ |
|
8e6a58019887
\regexp{}: Rewritten to look like Freidl's book. Too rip-off?
Fred Drake <fdrake@acm.org>
parents:
7659
diff
changeset
|
810 \index{environment variables!{\$#1}}% $ |
|
7659
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
811 } |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
812 \newcommand{\makevar}[1]{#1} % variable in a Makefile |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
813 \newcommand{\character}[1]{\samp{#1}} |
|
7659
869373fa0bf8
\withsubitem{}: New macro. Change indexsubitem temporarily for another
Fred Drake <fdrake@acm.org>
parents:
7617
diff
changeset
|
814 |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
815 % constants defined in Python modules or C headers, not language constants: |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
816 \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
|
817 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
818 \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
|
819 \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
|
820 \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
|
821 \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
|
822 \newcommand{\programopt}[1]{\strong{#1}} |
| 12377 | 823 % Note that \longprogramopt provides the '--'! |
| 824 \newcommand{\longprogramopt}[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
|
825 |
|
0a3bb403a430
\programopt: New macro, used to mark command-line parameters in the
Fred Drake <fdrake@acm.org>
parents:
11082
diff
changeset
|
826 % 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
|
827 % online: \citetitle[url-to-resource]{Title of Work} |
|
14020
b4b2612ea333
\citetitle: Format the title, not the optional URL!
Fred Drake <fdrake@acm.org>
parents:
13834
diff
changeset
|
828 \newcommand{\citetitle}[2][URL]{\emph{#2}} |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
829 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
830 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
831 % Deprecation stuff. |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
832 % 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
|
833 % 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
|
834 % |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
835 % 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
|
836 % 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
|
837 % |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
838 % Example: |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
839 % \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
|
840 % |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
841 \newcommand{\deprecated}[2]{% |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
842 \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
|
843 |
| 8762 | 844 % New stuff. |
| 845 % This should be used to mark things which have been added to the | |
| 846 % development tree but that aren't in the release, but are documented. | |
| 847 % 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
|
848 % descriptions. Place at end of descriptor environment. |
| 8762 | 849 % |
| 850 % Example: | |
| 851 % \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
|
852 % \versionchanged[short explanation]{2.0} |
| 8762 | 853 % |
| 854 \newcommand{\versionadded}[1]{% | |
|
10077
80b215249b17
Make \versionadded and \versionchanged less prominant -- neither bold
Fred Drake <fdrake@acm.org>
parents:
9968
diff
changeset
|
855 { New in version #1. }} |
|
12549
efd1e5d2284a
\versionchanged: Added optional parameter for explanation of change.
Fred Drake <fdrake@acm.org>
parents:
12500
diff
changeset
|
856 \newcommand{\versionchanged}[2][\py@badkey]{% |
|
efd1e5d2284a
\versionchanged: Added optional parameter for explanation of change.
Fred Drake <fdrake@acm.org>
parents:
12500
diff
changeset
|
857 \ifx#1\@undefined% |
|
efd1e5d2284a
\versionchanged: Added optional parameter for explanation of change.
Fred Drake <fdrake@acm.org>
parents:
12500
diff
changeset
|
858 { Changed in version #2. }% |
|
efd1e5d2284a
\versionchanged: Added optional parameter for explanation of change.
Fred Drake <fdrake@acm.org>
parents:
12500
diff
changeset
|
859 \else% |
|
efd1e5d2284a
\versionchanged: Added optional parameter for explanation of change.
Fred Drake <fdrake@acm.org>
parents:
12500
diff
changeset
|
860 { Changed in version #2:\ #1. }% |
|
efd1e5d2284a
\versionchanged: Added optional parameter for explanation of change.
Fred Drake <fdrake@acm.org>
parents:
12500
diff
changeset
|
861 \fi% |
|
efd1e5d2284a
\versionchanged: Added optional parameter for explanation of change.
Fred Drake <fdrake@acm.org>
parents:
12500
diff
changeset
|
862 } |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
863 |
| 8762 | 864 |
| 865 % Tables. | |
| 866 % | |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
867 \newenvironment{tableii}[4]{% |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
868 \begin{center}% |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
869 \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
|
870 \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
|
871 }{% |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
872 \end{tabular}% |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
873 \end{center}% |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
874 } |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
875 |
|
14722
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
876 \newenvironment{longtableii}[4]{% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
877 \begin{center}% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
878 \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
|
879 \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
|
880 }{% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
881 \end{longtable}% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
882 \end{center}% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
883 } |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
884 |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
885 \newenvironment{tableiii}[5]{% |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
886 \begin{center}% |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
887 \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
|
888 \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
|
889 \hline% |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
890 }{% |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
891 \end{tabular}% |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
892 \end{center}% |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
893 } |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
894 |
|
14722
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
895 \newenvironment{longtableiii}[5]{% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
896 \begin{center}% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
897 \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
|
898 \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
|
899 \hline\endhead% |
|
14722
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
900 }{% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
901 \end{longtable}% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
902 \end{center}% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
903 } |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
904 |
|
8751
99793302d10d
{tableiv} environment: Four-column table.
Fred Drake <fdrake@acm.org>
parents:
8726
diff
changeset
|
905 \newenvironment{tableiv}[6]{% |
|
99793302d10d
{tableiv} environment: Four-column table.
Fred Drake <fdrake@acm.org>
parents:
8726
diff
changeset
|
906 \begin{center}% |
|
99793302d10d
{tableiv} environment: Four-column table.
Fred Drake <fdrake@acm.org>
parents:
8726
diff
changeset
|
907 \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
|
908 \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
|
909 \hline% |
|
8751
99793302d10d
{tableiv} environment: Four-column table.
Fred Drake <fdrake@acm.org>
parents:
8726
diff
changeset
|
910 }{% |
|
99793302d10d
{tableiv} environment: Four-column table.
Fred Drake <fdrake@acm.org>
parents:
8726
diff
changeset
|
911 \end{tabular}% |
|
99793302d10d
{tableiv} environment: Four-column table.
Fred Drake <fdrake@acm.org>
parents:
8726
diff
changeset
|
912 \end{center}% |
|
99793302d10d
{tableiv} environment: Four-column table.
Fred Drake <fdrake@acm.org>
parents:
8726
diff
changeset
|
913 } |
|
99793302d10d
{tableiv} environment: Four-column table.
Fred Drake <fdrake@acm.org>
parents:
8726
diff
changeset
|
914 |
|
14722
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
915 \newenvironment{longtableiv}[6]{% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
916 \begin{center}% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
917 \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
|
918 \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
|
919 \\% |
|
15310
5d2a2185c651
Remove second horizontal line below table headers; it is just too
Fred Drake <fdrake@acm.org>
parents:
14722
diff
changeset
|
920 \hline\endhead% |
|
14722
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
921 }{% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
922 \end{longtable}% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
923 \end{center}% |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
924 } |
|
4d2e9cf1eb20
Add new environments: longtableii, longtableiii, and longtableiv, to
Fred Drake <fdrake@acm.org>
parents:
14555
diff
changeset
|
925 |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
926 % 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
|
927 % Sample usage: |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
928 % \begin{seealso} |
|
10846
b7378df3db56
Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents:
10770
diff
changeset
|
929 % \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
|
930 % \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
|
931 % |
|
2ef0aca96f2d
Revise some of the PDF support to get at least preliminary outline support.
Fred Drake <fdrake@acm.org>
parents:
7561
diff
changeset
|
932 % % 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
|
933 % \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
|
934 % \module{pickle}.} |
|
b7378df3db56
Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents:
10770
diff
changeset
|
935 % \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
|
936 % |
|
10846
b7378df3db56
Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents:
10770
diff
changeset
|
937 % 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
|
938 % 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
|
939 |
|
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
|
940 \@ifundefined{pdfannotlink}{% |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
941 \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
|
942 \par% |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
943 \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
|
944 \begin{fulllineitems} |
|
b7378df3db56
Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents:
10770
diff
changeset
|
945 \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
|
946 #3 |
|
b7378df3db56
Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents:
10770
diff
changeset
|
947 \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
|
948 } |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
949 }{\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
|
950 \par% |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
951 \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
|
952 \begin{fulllineitems} |
|
b7378df3db56
Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents:
10770
diff
changeset
|
953 \item[\py@linkToName{label-module-\py@modulekey}{Module \module{#2}} |
|
b7378df3db56
Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents:
10770
diff
changeset
|
954 (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
|
955 #3 |
|
b7378df3db56
Change the look of \seemodule output to fit in better.
Fred Drake <fdrake@acm.org>
parents:
10770
diff
changeset
|
956 \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
|
957 } |
|
2ef0aca96f2d
Revise some of the PDF support to get at least preliminary outline support.
Fred Drake <fdrake@acm.org>
parents:
7561
diff
changeset
|
958 } |
|
14521
9fed4eebc586
\seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents:
14490
diff
changeset
|
959 % \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
|
960 \newcommand{\py@seetitle}[3][\py@modulebadkey]{% |
|
9fed4eebc586
\seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents:
14490
diff
changeset
|
961 \par |
|
9fed4eebc586
\seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents:
14490
diff
changeset
|
962 \begin{fulllineitems} |
|
9fed4eebc586
\seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents:
14490
diff
changeset
|
963 \item[\citetitle{#2}] |
|
9fed4eebc586
\seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents:
14490
diff
changeset
|
964 \ifx\py@modulebadkey#1\else |
|
9fed4eebc586
\seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents:
14490
diff
changeset
|
965 \item[{\small{(\url{#1})}}] |
|
9fed4eebc586
\seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents:
14490
diff
changeset
|
966 \fi |
|
9fed4eebc586
\seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents:
14490
diff
changeset
|
967 #3 |
|
9fed4eebc586
\seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents:
14490
diff
changeset
|
968 \end{fulllineitems} |
|
9fed4eebc586
\seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents:
14490
diff
changeset
|
969 } |
|
14490
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
970 % \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
|
971 \newcommand{\py@seepep}[3]{% |
|
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
972 \par% |
|
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
973 \begin{fulllineitems} |
|
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
974 \item[\pep{#1}, ``\emph{#2}''] |
|
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
975 #3 |
|
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
976 \end{fulllineitems} |
|
f78f287b3add
excclassdesc: New environment. For use in documenting class-based
Fred Drake <fdrake@acm.org>
parents:
14020
diff
changeset
|
977 } |
|
12500
eb433efa24de
Define \seerfc within the seealso environment.
Fred Drake <fdrake@acm.org>
parents:
12377
diff
changeset
|
978 % \seerfc{number}{title}{why it's interesting} |
|
eb433efa24de
Define \seerfc within the seealso environment.
Fred Drake <fdrake@acm.org>
parents:
12377
diff
changeset
|
979 \newcommand{\py@seerfc}[3]{% |
|
eb433efa24de
Define \seerfc within the seealso environment.
Fred Drake <fdrake@acm.org>
parents:
12377
diff
changeset
|
980 \par% |
|
eb433efa24de
Define \seerfc within the seealso environment.
Fred Drake <fdrake@acm.org>
parents:
12377
diff
changeset
|
981 \begin{fulllineitems} |
|
eb433efa24de
Define \seerfc within the seealso environment.
Fred Drake <fdrake@acm.org>
parents:
12377
diff
changeset
|
982 \item[\rfc{#1}, ``\emph{#2}''] |
|
eb433efa24de
Define \seerfc within the seealso environment.
Fred Drake <fdrake@acm.org>
parents:
12377
diff
changeset
|
983 #3 |
|
eb433efa24de
Define \seerfc within the seealso environment.
Fred Drake <fdrake@acm.org>
parents:
12377
diff
changeset
|
984 \end{fulllineitems} |
|
eb433efa24de
Define \seerfc within the seealso environment.
Fred Drake <fdrake@acm.org>
parents:
12377
diff
changeset
|
985 } |
|
12638
def959352422
Define \seeurl in the seealso environment. Two parameters: url, why.
Fred Drake <fdrake@acm.org>
parents:
12549
diff
changeset
|
986 % \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
|
987 \newcommand{\py@seeurl}[2]{% |
|
def959352422
Define \seeurl in the seealso environment. Two parameters: url, why.
Fred Drake <fdrake@acm.org>
parents:
12549
diff
changeset
|
988 \par% |
|
def959352422
Define \seeurl in the seealso environment. Two parameters: url, why.
Fred Drake <fdrake@acm.org>
parents:
12549
diff
changeset
|
989 \begin{fulllineitems} |
|
def959352422
Define \seeurl in the seealso environment. Two parameters: url, why.
Fred Drake <fdrake@acm.org>
parents:
12549
diff
changeset
|
990 \item[\url{#1}] |
|
def959352422
Define \seeurl in the seealso environment. Two parameters: url, why.
Fred Drake <fdrake@acm.org>
parents:
12549
diff
changeset
|
991 #2 |
|
def959352422
Define \seeurl in the seealso environment. Two parameters: url, why.
Fred Drake <fdrake@acm.org>
parents:
12549
diff
changeset
|
992 \end{fulllineitems} |
|
def959352422
Define \seeurl in the seealso environment. Two parameters: url, why.
Fred Drake <fdrake@acm.org>
parents:
12549
diff
changeset
|
993 } |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
994 \newenvironment{seealso}[0]{ |
|
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
|
995 \par |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
996 \strong{See Also:}\par |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
997 \def\seetext##1{\par{##1}} |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
998 \let\seemodule=\py@seemodule |
|
14521
9fed4eebc586
\seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents:
14490
diff
changeset
|
999 \let\seepep=\py@seepep |
|
12500
eb433efa24de
Define \seerfc within the seealso environment.
Fred Drake <fdrake@acm.org>
parents:
12377
diff
changeset
|
1000 \let\seerfc=\py@seerfc |
|
14521
9fed4eebc586
\seetitle: New macro for building reference list content.
Fred Drake <fdrake@acm.org>
parents:
14490
diff
changeset
|
1001 \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
|
1002 \let\seeurl=\py@seeurl |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1003 }{\par} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1004 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1005 |
| 8762 | 1006 % 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
|
1007 % \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
|
1008 % 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
|
1009 % |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
1010 \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
|
1011 \newcommand{\version}{} |
| 14555 | 1012 \newcommand{\shortversion}{} |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1013 \newcommand{\releasename}{Release} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1014 \newcommand{\release}[1]{% |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
1015 \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
|
1016 \renewcommand{\version}{#1}} |
| 14555 | 1017 \newcommand{\setshortversion}[1]{% |
| 1018 \renewcommand{\shortversion}{#1}} | |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1019 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1020 % 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
|
1021 % 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
|
1022 % 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
|
1023 % |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
1024 \newcommand{\py@authoraddress}{} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
1025 \newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}} |
|
8341
ebfde06fdb8d
Added definitions for \developer, \developers, \developersaddress.
Fred Drake <fdrake@acm.org>
parents:
8306
diff
changeset
|
1026 \let\developersaddress=\authoraddress |
|
ebfde06fdb8d
Added definitions for \developer, \developers, \developersaddress.
Fred Drake <fdrake@acm.org>
parents:
8306
diff
changeset
|
1027 \let\developer=\author |
|
ebfde06fdb8d
Added definitions for \developer, \developers, \developersaddress.
Fred Drake <fdrake@acm.org>
parents:
8306
diff
changeset
|
1028 \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
|
1029 |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1030 % 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
|
1031 % 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
|
1032 % |
|
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
|
1033 \@ifundefined{ChTitleVar}{}{ |
|
8190
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
1034 \ChNameVar{\raggedleft\normalsize\py@HeaderFamily} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
1035 \ChNumVar{\raggedleft \bfseries\Large\py@HeaderFamily} |
|
25c2aea64501
Fixed \code so word wrapping is allowed.
Fred Drake <fdrake@acm.org>
parents:
8076
diff
changeset
|
1036 \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
|
1037 % 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
|
1038 \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
|
1039 {\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
|
1040 \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
|
1041 \DOCH |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1042 \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
|
1043 \interlinepenalty\@M |
|
7527
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1044 \DOTI{#1} |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1045 } |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1046 } |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1047 } |
|
26a8771a4cfd
Convert LaTeX support to create a new class of documents. HTML generation
Fred Drake <fdrake@acm.org>
parents:
diff
changeset
|
1048 |
|
8396
79071a4e0eca
Added {definitions} environment, which has \term to define indivual terms.
Fred Drake <fdrake@acm.org>
parents:
8341
diff
changeset
|
1049 |
|
79071a4e0eca
Added {definitions} environment, which has \term to define indivual terms.
Fred Drake <fdrake@acm.org>
parents:
8341
diff
changeset
|
1050 % 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
|
1051 % 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
|
1052 % |
|
79071a4e0eca
Added {definitions} environment, which has \term to define indivual terms.
Fred Drake <fdrake@acm.org>
parents:
8341
diff
changeset
|
1053 \newenvironment{definitions}{% |
|
79071a4e0eca
Added {definitions} environment, which has \term to define indivual terms.
Fred Drake <fdrake@acm.org>
parents:
8341
diff
changeset
|
1054 \begin{description}% |
| 9078 | 1055 \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
|
1056 }{% |
|
79071a4e0eca
Added {definitions} environment, which has \term to define indivual terms.
Fred Drake <fdrake@acm.org>
parents:
8341
diff
changeset
|
1057 \end{description}% |
|
79071a4e0eca
Added {definitions} environment, which has \term to define indivual terms.
Fred Drake <fdrake@acm.org>
parents:
8341
diff
changeset
|
1058 } |
|
79071a4e0eca
Added {definitions} environment, which has \term to define indivual terms.
Fred Drake <fdrake@acm.org>
parents:
8341
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 % 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
|
1061 \hyphenation{Base-HTTP-Re-quest-Hand-ler} |
