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

annotate Doc/texinputs/python.sty @ 7740:423be7cd0479 legacy-trunk

Don't use the fncychap package for HOWTO documents; appendices break. Still use them for manuals.

author	Fred Drake <fdrake@acm.org>
date	Wed, 25 Mar 1998 15:41:23 +0000
parents	5d7e4d20c89e
children	9d0dc11775a4

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
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	9 % 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	10 % (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	11 %
5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	12 \ifx\pdfoutput\undefined\else\ifcase\pdfoutput
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	13 \let\LinkColor=\relax
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	14 \let\NormalColor=\relax
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	15 \else
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	16 \input{pdfcolor}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	17 \let\LinkColor=\NavyBlue
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	18 \let\NormalColor=\Black
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	19 \pdfcompresslevel=9
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	20 %
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	21 % 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	22 % 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	23 %
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	24 \let\OldContentsline=\contentsline
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	25 \renewcommand{\contentsline}[3]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	26 \OldContentsline{#1}{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	27 \pdfannotlink attr{/Border [0 0 0]} goto name{page.#3}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	28 \LinkColor#2\NormalColor%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	29 \pdfendlink%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	30 }{#3}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	31 }
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	32 %
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	33 % This is supposed to build the "outline" view of the document; it seems
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	34 % quite fragile. The breakages are the same as in the ToC.
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	35 %
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	36 \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	37 \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	38 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	39 \let\OldLabel=\label
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	40 \renewcommand{\label}[1]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	41 \OldLabel{#1}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	42 {\pdfdest name{label.#1} fit}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	43 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	44 % This stuff adds a page.# destination to every PDF page, where # has
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	45 % the same formatting as the displayed page number. This doesn't really
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	46 % help with the frontmatter, but does fine with the body.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	47 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	48 % 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	49 %
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	50 \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	51 \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	52 \@hyperfixhead
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	53 }
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	54 \def\hyperpageanchor{\pdfdest name{page.\thepage}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	55 \let\HYPERPAGEANCHOR\hyperpageanchor
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	56 \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	57 \let\H@old@thehead\@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	58 \gdef\@foo{\pdfdest name{page.\thepage} fit}%
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	59 \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	60 \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	61 \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	62 }
7737 5d7e4d20c89e Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the Fred Drake <fdrake@acm.org> parents: 7706 diff changeset	63 \fi\fi
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	64
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	65 % 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	66 \topmargin 0pt
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	67 \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	68 \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	69
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	70 % attempt to work a little better for A4 users
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	71 \@ifundefined{paperheight}{
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	72 \textheight 9in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	73 }{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	74 \textheight \paperheight
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	75 \advance\textheight by -2in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	76 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	77
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	78 \oddsidemargin 0pt
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	79 \evensidemargin \oddsidemargin
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	80 \marginparwidth 0.5in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	81
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	82 \@ifundefined{paperwidth}{
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	83 \textwidth 6.5in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	84 }{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	85 \textwidth \paperwidth
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	86 \advance\textwidth by -2in
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	87 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	88
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	89
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	90 % 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	91 \raggedbottom
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	92 \sloppy
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	93 \parindent = 0mm
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	94 \parskip = 2mm
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	95 \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	96
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	97 \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	98 \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	99 \setcounter{secnumdepth}{1}
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 % Use this to set the font family for headers and other decor:
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	102 \newcommand{\HeaderFamily}{\sffamily}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	103
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	104 % 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	105 \@ifundefined{fancyhf}{}{
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	106 % 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	107 \fancypagestyle{normal}{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	108 \fancyhf{}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	109 \fancyfoot[LE,RO]{{\HeaderFamily\thepage}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	110 \fancyfoot[LO]{{\HeaderFamily\nouppercase{\rightmark}}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	111 \fancyfoot[RE]{{\HeaderFamily\nouppercase{\leftmark}}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	112 \renewcommand{\headrulewidth}{0pt}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	113 \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	114 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	115 % 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	116 % 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	117 % 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	118 \fancypagestyle{plain}{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	119 \fancyhf{}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	120 \fancyfoot[LE,RO]{{\HeaderFamily\thepage}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	121 \renewcommand{\headrulewidth}{0pt}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	122 \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	123 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	124 % 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	125 % 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	126 % 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	127 \@ifundefined{chapter}{}{
7548 7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	128 \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	129 \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	130 \hbox{}
7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	131 \thispagestyle{plain}
7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	132 \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	133 \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	134 }
7eb19b1ce84d Improve separation of document class and python semantic constructs. This Fred Drake <fdrake@acm.org> parents: 7527 diff changeset	135 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	136 }
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 % old code font selections:
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	139 \let\codefont=\tt
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	140 \let\sectcodefont=\tt
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	141
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	142 % (Haven't found a new one that gets <, >, and _ right without being
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	143 % monospaced.)
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	144
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	145
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	146 % 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	147 % 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	148 % code samples.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	149
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	150 % Variable used by begin code command
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	151 \newlength{\codewidth}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	152
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	153 \newcommand{\examplevspace}{2mm}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	154 \newcommand{\exampleindent}{1cm}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	155
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	156 \let\OldVerbatim=\verbatim
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	157 \let\OldEndVerbatim=\endverbatim
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	158 \renewcommand{\verbatim}{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	159 \begingroup%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	160 \setlength{\parindent}\exampleindent%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	161 % Calculate the text width for the minipage:
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	162 \setlength{\codewidth}{\linewidth}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	163 \addtolength{\codewidth}{-\parindent}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	164 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	165 \par%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	166 \vspace\examplevspace%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	167 \indent%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	168 \begin{minipage}[t]{\codewidth}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	169 \small%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	170 \OldVerbatim%
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{\endverbatim}{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	173 \OldEndVerbatim%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	174 \end{minipage}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	175 \endgroup%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	176 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	177
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	178 % Augment the sectioning commands used to get our own font family in place:
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	179 \renewcommand{\section}{\@startsection {section}{1}{\z@}%
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	180 {-3.5ex \@plus -1ex \@minus -.2ex}%
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	181 {2.3ex \@plus.2ex}%
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	182 {\reset@font\Large\HeaderFamily}}
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	183 \renewcommand{\subsection}{\@startsection{subsection}{2}{\z@}%
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	184 {-3.25ex\@plus -1ex \@minus -.2ex}%
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	185 {1.5ex \@plus .2ex}%
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	186 {\reset@font\large\HeaderFamily}}
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	187 \renewcommand{\subsubsection}{\@startsection{subsubsection}{3}{\z@}%
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	188 {-3.25ex\@plus -1ex \@minus -.2ex}%
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	189 {1.5ex \@plus .2ex}%
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	190 {\reset@font\normalsize\HeaderFamily}}
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	191 \renewcommand{\paragraph}{\@startsection{paragraph}{4}{\z@}%
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	192 {3.25ex \@plus1ex \@minus.2ex}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	193 {-1em}%
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	194 {\reset@font\normalsize\HeaderFamily}}
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	195 \renewcommand{\subparagraph}{\@startsection{subparagraph}{5}{\parindent}%
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	196 {3.25ex \@plus1ex \@minus .2ex}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	197 {-1em}%
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	198 {\reset@font\normalsize\HeaderFamily}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	199
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	200
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	201 % Underscore hack (only act like subscript operator if in math mode)
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	202 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	203 % The following is due to Mark Wooding (the old version didn't work with
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	204 % Latex 2e.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	205
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	206 \DeclareRobustCommand\hackscore{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	207 \ifmmode_\else\textunderscore\fi%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	208 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	209 \begingroup
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	210 \catcode`\_\active
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	211 \def\next{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	212 \AtBeginDocument{\catcode`\_\active\def_{\hackscore{}}}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	213 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	214 \expandafter\endgroup\next
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 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	217 % This is the old hack, which didn't work with 2e.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	218 % You should not need this since the rest of the documentation is now
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	219 % LaTeX2e-only.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	220 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	221 %\def\_{\ifnum\fam=\ttfamily \char'137\else{\tt\char'137}\fi}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	222 %\catcode`\_=12
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	223 %\catcode`\_=\active\def_{\ifnum\fam=\ttfamily \char'137 \else{\tt\char'137}\fi}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	224
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	225
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	226
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	227 %% 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	228
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	229 % 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	230 % 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	231 % just keep the index entries in the roman font, uncomment the second
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	232 % definition to use instead; it matches O'Reilly style more.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	233 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	234 \newcommand{\idxcode}[1]{\codefont{#1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	235 %\renewcommand{\idxcode}[1]{#1}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	236
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	237 % 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	238 \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	239
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	240 % 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	241 \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	242
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	243 % 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	244 \newcommand{\indexiv}[4]{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	245 \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	246 \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	247 \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	248 \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	249 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	250
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	251 % 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	252 % operator.
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	253 \newcommand{\stindex}[1]{\indexii{statement}{#1@{\idxcode{#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	254 \newcommand{\opindex}[1]{\indexii{operator}{#1@{\idxcode{#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	255 \newcommand{\exindex}[1]{\indexii{exception}{#1@{\idxcode{#1}}}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	256 \newcommand{\obindex}[1]{\indexii{object}{#1}}
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	257 \newcommand{\bifuncindex}[1]{\index{#1@{\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	258
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	259 % Add an index entry for a module
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	260 \newcommand{\refmodule}[2]{\index{#1@{\idxcode{#1}} (#2module)}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	261 \newcommand{\refmodindex}[1]{\refmodule{#1}{}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	262 \newcommand{\refbimodindex}[1]{\refmodule{#1}{built-in }}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	263 \newcommand{\refexmodindex}[1]{\refmodule{#1}{extension }}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	264 \newcommand{\refstmodindex}[1]{\refmodule{#1}{standard }}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	265
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	266 % support for the module index
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	267 \newif\if@UseModuleIndex
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	268 \@UseModuleIndexfalse
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	269
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	270 % Fix the theindex environment to add an entry to the Table of
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	271 % Contents; this is much nicer than just having to jump to the end of
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	272 % the book and flip around, especially with multiple indexes.
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	273 %
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	274 \let\OldTheindex=\theindex
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	275 \renewcommand{\theindex}{
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	276 \cleardoublepage
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	277 \OldTheindex
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	278 \addcontentsline{toc}{chapter}{\indexname}
068a6942fe1a Adjust the index support a bit to make it easier to deal with module index. Fred Drake <fdrake@acm.org> parents: 7597 diff changeset	279 }
068a6942fe1a Adjust the index support a bit to make it easier to deal with module index. Fred Drake <fdrake@acm.org> parents: 7597 diff changeset	280
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	281 % these should dump an error or warning to the transcript
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	282 \newcommand{\@thismodule}{$<<$ ERROR - NO CURRENT MODULE $>>$}
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	283 \newcommand{\@thisclass}{$<<$ ERROR - NO CURRENT CLASS $>>$}
7617 068a6942fe1a Adjust the index support a bit to make it easier to deal with module index. Fred Drake <fdrake@acm.org> parents: 7597 diff changeset	284
068a6942fe1a Adjust the index support a bit to make it easier to deal with module index. Fred Drake <fdrake@acm.org> parents: 7597 diff changeset	285 \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	286 \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	287 \openout\modindexfile=mod\jobname.idx
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	288 \@UseModuleIndextrue
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	289 }
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	290
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	291 % Add the defining entry for a module
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	292 \newcommand{\@modindex}[2]{%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	293 \renewcommand{\@thismodule}{#1}
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	294 \setindexsubitem{(in module \@thismodule)}%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	295 \index{#1@{\idxcode{#1}} (#2module)\|textbf}%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	296 \if@UseModuleIndex%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	297 \write\modindexfile{\protect\indexentry{#1@{\tt #1}}{\thepage}}%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	298 \fi%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	299 }
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	300
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	301 % built-in & Python modules in the main distribution
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	302 \newcommand{\bimodindex}[1]{\@modindex{#1}{built-in }}
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	303 \newcommand{\stmodindex}[1]{\@modindex{#1}{standard }}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	304
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	305 % Python & extension modules outside the main distribution
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	306 \newcommand{\modindex}[1]{\@modindex{#1}{}}
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	307 \newcommand{\exmodindex}[1]{\@modindex{#1}{extension }}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	308
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	309 % Additional string for an index entry
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	310 \newcommand{\index@subitem}{}
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	311 \newcommand{\setindexsubitem}[1]{\renewcommand{\index@subitem}{#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	312 \newcommand{\ttindex}[1]{\index{#1@{\idxcode{#1}} \index@subitem}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	313
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	314 \newcommand{\withsubitem}[2]{%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	315 \begingroup%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	316 \def\index@subitem{#1}#2%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	317 \endgroup%
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	318 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	319
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	320 % {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	321 % 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	322 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	323 \newenvironment{fulllineitems}{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	324 \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	325 \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	326 \itemsep -\parsep
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	327 \let\makelabel=\itemnewline}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	328 }{\end{list}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	329
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	330
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	331 % cfuncdesc should be called as
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	332 % \begin{cfuncdesc}{type}{name}{arglist}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	333 % ... description ...
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	334 % \end{cfuncdesc}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	335 \newenvironment{cfuncdesc}[3]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	336 \begin{fulllineitems}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	337 \item[\code{#1 \bfcode{#2}(\varvars{#3})}]%
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	338 \index{#2@{\idxcode{#2()}}}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	339 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	340
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	341 \newenvironment{cvardesc}[2]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	342 \begin{fulllineitems}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	343 \item[\code{#1 \bfcode{#2}}]%
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	344 \index{#2@{\idxcode{#2}}}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	345 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	346
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	347 \newenvironment{ctypedesc}[1]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	348 \begin{fulllineitems}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	349 \item[\bfcode{#1}]\ttindex{#1}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	350 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	351
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	352 \newcommand{\funcline}[2]{\funclineni{#1}{#2}\ttindex{#1()}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	353 \newenvironment{funcdesc}[2]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	354 \begin{fulllineitems}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	355 \funcline{#1}{#2}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	356 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	357
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	358 \newcommand{\optional}[1]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	359 {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	360
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	361 % similar to {funcdesc}, but doesn't add to the index
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	362 \newcommand{\funclineni}[2]{\item[\code{\bfcode{#1}(\varvars{#2})}]}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	363 \newenvironment{funcdescni}[2]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	364 \begin{fulllineitems}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	365 \funclineni{#1}{#2}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	366 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	367
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	368 \newenvironment{classdesc}[2]{%
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	369 \renewcommand{\@thisclass}{#1}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	370 \begin{fulllineitems}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	371 \item[\code{\bfcode{#1}(\varvars{#2})}]%
7696 d23bfe06175e {classdesc} environment: Index as "Foo (class in foolib)" instead of Fred Drake <fdrake@acm.org> parents: 7670 diff changeset	372 \withsubitem{(class in \@thismodule)}{\ttindex{#1}}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	373 \def\baseclasses##1{}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	374 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	375
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	376 \newenvironment{excdesc}[1]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	377 \begin{fulllineitems}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	378 \item[\bfcode{#1}]\ttindex{#1}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	379 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	380
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	381 \newcommand{\dataline}[1]{\datalineni{#1}\ttindex{#1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	382 \newenvironment{datadesc}[1]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	383 \begin{fulllineitems}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	384 \dataline{#1}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	385 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	386
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	387 % similar to {datadesc}, but doesn't add to the index
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	388 \newcommand{\datalineni}[1]{\item[\bfcode{#1}]}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	389 \newenvironment{datadescni}[1]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	390 \begin{fulllineitems}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	391 \datalineni{#1}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	392 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	393
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	394 \newenvironment{opcodedesc}[2]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	395 \begin{fulllineitems}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	396 \item[\bfcode{#1}\quad\var{#2}]%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	397 }{\end{fulllineitems}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	398
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	399
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	400 \let\nodename=\label
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	401
7740 423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	402 \newcommand{\sectcode}[1]{{\sectcodefont{#1}}}
423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	403
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	404 % 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	405 % {\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	406 \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	407 \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	408 \newcommand{\POSIX}{POSIX}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	409 \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	410 \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	411 \newcommand{\C}{C}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	412 \newcommand{\EOF}{{\sc eof}}
7740 423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	413 \newcommand{\NULL}{\sectcode{NULL}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	414
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	415 % code is the most difficult one...
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	416 \newcommand{\code}[1]{{\@vobeyspaces\@noligs\def\{{\char`\{}\def\}{\char`\}}\def\~{\char`\~}\def\^{\char`\^}\def\e{\char`\\}\def\${\char`\$}\def\#{\char`\#}\def\&{\char`\&}\def\%{\char`\%}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	417 \mbox{\codefont{#1}}}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	418
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	419 \newcommand{\bfcode}[1]{\code{\bfseries#1}} % bold-faced code font
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	420 \newcommand{\kbd}[1]{\mbox{\tt #1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	421 \newcommand{\key}[1]{\mbox{\tt #1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	422 \newcommand{\samp}[1]{\mbox{`\code{#1}'}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	423 % 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	424 % italics, and won't get funky in code fragments when we play around
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	425 % with fonts.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	426 \newcommand{\var}[1]{\mbox{\normalsize\textrm{\textit{#1\/}}}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	427 \renewcommand{\emph}[1]{{\em #1\/}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	428 \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	429 \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	430 % 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	431 \newcommand{\file}[1]{`{\small\textsf{#1}}'}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	432
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	433 % 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	434 % but only if we actually used hyperref:
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	435 \@ifundefined{pdfannotlink}{%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	436 \newcommand{\pythonurl}[1]{\mbox{\small\textsf{#1}}}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	437 }{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	438 \newcommand{\pythonurl}[1]{{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	439 \pdfannotlink attr{/Border [0 0 0]} user{/S /URI /URI (#1)}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	440 \LinkColor% color of the link text
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	441 \mbox{\small\textsf{#1}}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	442 \NormalColor% Turn it back off; these are declarative
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	443 \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	444 }% formatting "box".
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	445 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	446 \let\url=\pythonurl
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	447 \newcommand{\email}[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	448
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	449 \newcommand{\varvars}[1]{{\def\,{\/{\char`\,}}\var{#1}}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	450
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	451 \newif\iftexi\texifalse
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	452 \newif\iflatex\latextrue
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	453
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	454 % 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	455 % 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	456 % 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	457 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	458 % 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	459 % 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	460 %
7740 423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	461 \let\module=\sectcode
423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	462 \let\keyword=\sectcode
423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	463 \let\exception=\sectcode
423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	464 \let\class=\sectcode
423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	465 \let\function=\sectcode
423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	466 \let\member=\sectcode
423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	467 \let\method=\sectcode
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	468
7740 423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	469 \let\cfunction=\sectcode
423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	470 \let\ctype=\sectcode
423be7cd0479 Don't use the fncychap package for HOWTO documents; appendices break. Still Fred Drake <fdrake@acm.org> parents: 7737 diff changeset	471 \let\cdata=\sectcode
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	472
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	473 \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	474 % 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	475 \newcommand{\regexp}[1]{%
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	476 {\tiny$^{^\lceil}\!\!$%
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	477 {\normalsize\code{#1}}%
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	478 $\!\!\rfloor\!$%
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	479 }}
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	480 \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	481 \$#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	482 \index{#1@{\$#1}}% $
8e6a58019887 \regexp{}: Rewritten to look like Freidl's book. Too rip-off? Fred Drake <fdrake@acm.org> parents: 7659 diff changeset	483 \index{environment variables!{\$#1}}% $
7659 869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	484 }
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	485 \let\character=\samp
869373fa0bf8 \withsubitem{}: New macro. Change indexsubitem temporarily for another Fred Drake <fdrake@acm.org> parents: 7617 diff changeset	486
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	487 % constants defined in Python modules or C headers, not language constants:
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	488 \let\constant=\code
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	489
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	490 \newcommand{\manpage}[2]{{\emph{#1}(#2)}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	491 \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	492 \newcommand{\program}[1]{\strong{#1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	493
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	494
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	495 % Deprecation stuff.
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	496 % 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	497 % 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	498 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	499 % 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	500 % 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	501 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	502 % Example:
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	503 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	504 % \deprecated {1.5.1}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	505 % {Use \method{frobnicate()} instead.}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	506 %
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	507 \newcommand{\deprecated}[2]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	508 \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	509
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	510
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	511 \newenvironment{tableii}[4]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	512 \begin{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	513 \def\lineii##1##2{\csname#2\endcsname{##1}&##2\\}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	514 \begin{tabular}{#1}\hline \strong{#3}&\strong{#4} \\ \hline%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	515 }{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	516 \hline%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	517 \end{tabular}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	518 \end{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	519 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	520
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	521 \newenvironment{tableiii}[5]{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	522 \begin{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	523 \def\lineiii##1##2##3{\csname#2\endcsname{##1}&##2&##3\\}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	524 \begin{tabular}{#1}\hline \strong{#3}&\strong{#4}&\strong{#5} \\ \hline%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	525 }{%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	526 \hline%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	527 \end{tabular}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	528 \end{center}%
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	529 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	530
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	531 \newcommand{\itemnewline}[1]{%
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	532 \@tempdima\linewidth%
39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	533 \advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}%
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	534 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	535
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	536 % Cross-referencing (AMK)
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	537 % Sample usage:
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	538 % \begin{seealso}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	539 % \seemodule{rand}{Uniform random number generator}; % Module xref
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	540 % \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	541 %
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	542 % % A funky case: module name contains '_'; have to supply an optional key
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	543 % \seemodule[copyreg]{copy_reg}{pickle interface constructor registration}
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	544 %
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	545 % \end{seealso}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	546
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	547 \newif\if@keyedmodule\@keyedmodulefalse
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	548 \newcommand{\@modulebadkey}{{--just-some-junk--}}
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	549
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	550 \@ifundefined{pdfannotlink}{%
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	551 \newcommand{\seemodule}[3][\@modulebadkey]{%
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	552 \ifx\@modulebadkey#1\def\@modulekey{#2}\else\def\@modulekey{#1}\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	553 \ref{module-\@modulekey}:\quad %
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	554 Module \module{#2}%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	555 \quad (#3)%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	556 }
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	557 }{\newcommand{\seemodule}[3][\@modulebadkey]{%
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	558 \ifx\@modulebadkey#1\def\@modulekey{#2}\else\def\@modulekey{#1}\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	559 \ref{module-\@modulekey}:\quad %
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	560 {\pdfannotlink attr{/Border [0 0 0]} goto name{label.module-\@modulekey}%
7585 2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	561 \LinkColor Module \module{#2} \NormalColor%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	562 \pdfendlink%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	563 }%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	564 \quad (#3)%
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	565 }
2ef0aca96f2d Revise some of the PDF support to get at least preliminary outline support. Fred Drake <fdrake@acm.org> parents: 7561 diff changeset	566 }
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	567 \newenvironment{seealso}[0]{
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	568 \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	569 \def\seetext##1{\par{##1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	570 }{\par}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	571
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	572
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	573 % Allow the release number to be specified independently of the
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	574 % \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	575 % 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	576 %
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	577 \newcommand{\@release}{}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	578 \newcommand{\version}{}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	579 \newcommand{\releasename}{Release}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	580 \newcommand{\release}[1]{%
7597 39b84a3dceaa Never, NEVER try to recover a screwed up file by carving a chunk out of an Fred Drake <fdrake@acm.org> parents: 7592 diff changeset	581 \renewcommand{\@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	582 \renewcommand{\version}{#1}}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	583
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	584 % 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	585 % 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	586 % 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	587 %
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	588 \newcommand{\@authoraddress}{}
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	589 \newcommand{\authoraddress}[1]{\renewcommand{\@authoraddress}{#1}}
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	590
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	591 % 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	592 % 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	593 %
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	594 \@ifundefined{ChTitleVar}{}{
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	595 \ChNameVar{\raggedleft\normalsize\HeaderFamily}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	596 \ChNumVar{\raggedleft \bfseries\Large\HeaderFamily}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	597 \ChTitleVar{\raggedleft \rm\Huge\HeaderFamily}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	598 % 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	599 \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	600 {\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	601 \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	602 \DOCH
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	603 \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	604 \interlinepenalty\@M
7527 26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	605 \DOTI{#1}
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	606 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	607 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	608 }
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	609
26a8771a4cfd Convert LaTeX support to create a new class of documents. HTML generation Fred Drake <fdrake@acm.org> parents: diff changeset	610 % 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	611 \hyphenation{Base-HTTP-Re-quest-Hand-ler}

Mercurial > cpython-lru_cache-weakref

annotate Doc/texinputs/python.sty @ 7740:423be7cd0479 legacy-trunk