mirrors/cpython
0
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2024-11-30 05:15:14 +08:00
Code Issues Packages Projects Releases Wiki Activity
cf0fb8bfee
cpython/Doc/texinputs/python.sty

826 lines
26 KiB
Plaintext
Raw Normal View History

Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
%
Oops; file copy error somewhere along the way....
1998-03-07 06:33:06 +08:00
% python.sty for the Python docummentation [works only with with Latex2e]
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
%
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
\ProvidesPackage{python}
Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the latest pdftex. (Which we have here at CNRI.) This makes the PDF targets work again.
1998-03-25 22:53:43 +08:00
[1998/01/11 LaTeX package (Python markup)]
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
Added some comments.
1998-04-02 06:20:14 +08:00
% These packages can be used to add marginal annotations which indicate
% index entries and labels; useful for reviewing this messy documentation!
%
%\RequirePackage{showkeys}
%\RequirePackage{showidx}
Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the latest pdftex. (Which we have here at CNRI.) This makes the PDF targets work again.
1998-03-25 22:53:43 +08:00
% for PDF output, use maximal compression & a lot of other stuff
% (test for PDF recommended by Tanmoy Bhattacharya <tanmoy@qcd.lanl.gov>)
%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newif\ifpy@doing@page@targets
\py@doing@page@targetsfalse
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the latest pdftex. (Which we have here at CNRI.) This makes the PDF targets work again.
1998-03-25 22:53:43 +08:00
\ifx\pdfoutput\undefined\else\ifcase\pdfoutput
\else
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\input{pdfcolor}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\let\py@LinkColor=\NavyBlue
\let\py@NormalColor=\Black
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\pdfcompresslevel=9
Set the right page size in the PDF output.
1998-05-12 04:42:54 +08:00
\pdfpagewidth=\paperwidth % page width of PDF output
\pdfpageheight=\paperheight % page height of PDF output
Revise some of the PDF support to get at least preliminary outline support. Rewrite \seemodule (again) to allow an optional argument to support modules which include an underscore in the names. See example in comments.
1998-03-07 05:25:17 +08:00
%
Fix the broken PDF links, really this time! "." cannot be part of the target names either. Appending a junk char to the end doesn't quite do it, or doesn't seem to at any rate. Instead, pad the page numbers to always be 3 charaters wide, with leading zeros.
1998-04-16 01:50:01 +08:00
% Pad the number with '0' to 3 digits wide so no page name is a prefix
% of any other.
%
Lots of new stuff for "module synopsis support." Public interface consists of three macros, one which replaces some of the current conventions used in the module sections: \declaremodule: Requires two parameters: module type (standard, builtin, extension), and the module name. An optional parameter should be given as the basis for the module's "key" used for linking to or referencing the section. The "key" should only be given if the module's name contains underscores, and should be the name with the underscore's stripped. This should be the first thing after the \section used to introduce the module. \modulesynopsis: Requires a single parameter: a short, one-liner description of the module that can be used as part of the chapter introduction. This should probably be placed just after the \declaremodule, but may be placed anywhere in the same section. \localmoduletable: No parameters. If a .syn file exists for the current chapter (or for the entire document in howto docs), a synopsistable is created with the contents loaded from the .syn file. Some re-organization due to module synopsis support. Some \def's changed to \newcommand's.
1998-07-24 01:50:45 +08:00
\newcommand{\py@targetno}[1]{\ifnum#1<100 0\fi\ifnum#1<10 0\fi#1}
\newcommand{\py@pageno}{\py@targetno\thepage}
Fix the broken PDF links, really this time! "." cannot be part of the target names either. Appending a junk char to the end doesn't quite do it, or doesn't seem to at any rate. Instead, pad the page numbers to always be 3 charaters wide, with leading zeros.
1998-04-16 01:50:01 +08:00
%
Revise some of the PDF support to get at least preliminary outline support. Rewrite \seemodule (again) to allow an optional argument to support modules which include an underscore in the names. See example in comments.
1998-03-07 05:25:17 +08:00
% This definition allows the entries in the page-view of the ToC to be
% active links. Some work, some don't.
%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\let\py@OldContentsline=\contentsline
Fix the broken PDF links, really this time! "." cannot be part of the target names either. Appending a junk char to the end doesn't quite do it, or doesn't seem to at any rate. Instead, pad the page numbers to always be 3 charaters wide, with leading zeros.
1998-04-16 01:50:01 +08:00
% Compute the padded page number separately since we end up with a pair of
% \relax tokens; this gets the right string computed and works.
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\renewcommand{\contentsline}[3]{%
Fix the broken PDF links, really this time! "." cannot be part of the target names either. Appending a junk char to the end doesn't quite do it, or doesn't seem to at any rate. Instead, pad the page numbers to always be 3 charaters wide, with leading zeros.
1998-04-16 01:50:01 +08:00
\def\my@pageno{\py@targetno{#3}}%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\py@OldContentsline{#1}{%
Fix the broken PDF links, really this time! "." cannot be part of the target names either. Appending a junk char to the end doesn't quite do it, or doesn't seem to at any rate. Instead, pad the page numbers to always be 3 charaters wide, with leading zeros.
1998-04-16 01:50:01 +08:00
\pdfannotlink attr{/Border [0 0 0]} goto name{page\my@pageno}%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\py@LinkColor#2\py@NormalColor%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\pdfendlink%
}{#3}%
}
Revise some of the PDF support to get at least preliminary outline support. Rewrite \seemodule (again) to allow an optional argument to support modules which include an underscore in the names. See example in comments.
1998-03-07 05:25:17 +08:00
\AtEndDocument{
Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the latest pdftex. (Which we have here at CNRI.) This makes the PDF targets work again.
1998-03-25 22:53:43 +08:00
\InputIfFileExists{\jobname.bkm}{\pdfcatalog{/PageMode /UseOutlines}}{}
Revise some of the PDF support to get at least preliminary outline support. Rewrite \seemodule (again) to allow an optional argument to support modules which include an underscore in the names. See example in comments.
1998-03-07 05:25:17 +08:00
}
Fix the broken PDF links, really this time! "." cannot be part of the target names either. Appending a junk char to the end doesn't quite do it, or doesn't seem to at any rate. Instead, pad the page numbers to always be 3 charaters wide, with leading zeros.
1998-04-16 01:50:01 +08:00
\newcommand{\py@target}[1]{%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\ifpy@doing@page@targets%
Fix the broken PDF links, really this time! "." cannot be part of the target names either. Appending a junk char to the end doesn't quite do it, or doesn't seem to at any rate. Instead, pad the page numbers to always be 3 charaters wide, with leading zeros.
1998-04-16 01:50:01 +08:00
{\pdfdest name{#1} fit}%
\fi%
}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\let\py@OldLabel=\label
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\renewcommand{\label}[1]{%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\py@OldLabel{#1}%
Fix the broken PDF links, really this time! "." cannot be part of the target names either. Appending a junk char to the end doesn't quite do it, or doesn't seem to at any rate. Instead, pad the page numbers to always be 3 charaters wide, with leading zeros.
1998-04-16 01:50:01 +08:00
\py@target{label-#1}%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}
Set the right page size in the PDF output.
1998-05-12 04:42:54 +08:00
% This stuff adds a page# destination to every PDF page, where # is three
% digits wide, padded with leading zeros. This doesn't really help with
% the frontmatter, but does fine with the body.
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
%
% This is *heavily* based on the hyperref package.
%
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\def\@begindvi{%
\unvbox \@begindvibox
\@hyperfixhead
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\def\@hyperfixhead{%
\let\H@old@thehead\@thehead
Fix the broken PDF links, really this time! "." cannot be part of the target names either. Appending a junk char to the end doesn't quite do it, or doesn't seem to at any rate. Instead, pad the page numbers to always be 3 charaters wide, with leading zeros.
1998-04-16 01:50:01 +08:00
\global\def\@foo{\py@target{page\py@pageno}}%
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\expandafter\ifx\expandafter\@empty\H@old@thehead
\def\H@old@thehead{\hfil}\fi
\def\@thehead{\@foo\relax\H@old@thehead}%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}
Change uses of \pdfinfo and \pdfcatalog to use the new syntax from the latest pdftex. (Which we have here at CNRI.) This makes the PDF targets work again.
1998-03-25 22:53:43 +08:00
\fi\fi
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% Increase printable page size (copied from fullpage.sty)
\topmargin 0pt
\advance \topmargin by -\headheight
\advance \topmargin by -\headsep
% attempt to work a little better for A4 users
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\@ifundefined{paperheight}{
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\textheight 9in
}{
\textheight \paperheight
\advance\textheight by -2in
}
\oddsidemargin 0pt
\evensidemargin \oddsidemargin
\marginparwidth 0.5in
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\@ifundefined{paperwidth}{
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\textwidth 6.5in
}{
\textwidth \paperwidth
\advance\textwidth by -2in
}
% Style parameters and macros used by most documents here
\raggedbottom
\sloppy
\parindent = 0mm
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\parskip = 2mm
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\hbadness = 5000 % don't print trivial gripes
\pagestyle{empty} % start this way; change for
\pagenumbering{roman} % ToC & chapters
\setcounter{secnumdepth}{1}
% Use this to set the font family for headers and other decor:
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\py@HeaderFamily}{\sffamily}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% Redefine the 'normal' header/footer style when using "fancyhdr" package:
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\@ifundefined{fancyhf}{}{
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% Use \pagestyle{normal} as the primary pagestyle for text.
\fancypagestyle{normal}{
\fancyhf{}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
\fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}}
\fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\renewcommand{\headrulewidth}{0pt}
\renewcommand{\footrulewidth}{0.4pt}
}
% Update the plain style so we get the page number & footer line,
% but not a chapter or section title. This is to keep the first
% page of a chapter and the blank page between chapters `clean.'
\fancypagestyle{plain}{
\fancyhf{}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\renewcommand{\headrulewidth}{0pt}
\renewcommand{\footrulewidth}{0.4pt}
}
% Redefine \cleardoublepage so that the blank page between chapters
% gets the plain style and not the fancy style. This is described
% in the documentation for the fancyhdr package by Piet von Oostrum.
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\@ifundefined{chapter}{}{
Improve separation of document class and python semantic constructs. This will allow us to have a class of smaller documents as well.
1998-03-05 05:47:59 +08:00
\renewcommand{\cleardoublepage}{
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\clearpage\if@openright \ifodd\c@page\else
Improve separation of document class and python semantic constructs. This will allow us to have a class of smaller documents as well.
1998-03-05 05:47:59 +08:00
\hbox{}
\thispagestyle{plain}
\newpage
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\if@twocolumn\hbox{}\newpage\fi\fi\fi
Improve separation of document class and python semantic constructs. This will allow us to have a class of smaller documents as well.
1998-03-05 05:47:59 +08:00
}
}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}
% This sets up the {verbatim} environment to be indented and a minipage,
% and to have all the other mostly nice properties that we want for
% code samples.
% Variable used by begin code command
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newlength{\py@codewidth}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\py@examplevspace}{2mm}
\newcommand{\py@exampleindent}{1cm}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\let\py@OldVerbatim=\verbatim
\let\py@OldEndVerbatim=\endverbatim
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\renewcommand{\verbatim}{%
\begingroup%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\setlength{\parindent}\py@exampleindent%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% Calculate the text width for the minipage:
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\setlength{\py@codewidth}{\linewidth}%
\addtolength{\py@codewidth}{-\parindent}%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
%
\par%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\vspace\py@examplevspace%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\indent%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\begin{minipage}[t]{\py@codewidth}%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\small%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\py@OldVerbatim%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}
\renewcommand{\endverbatim}{%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\py@OldEndVerbatim%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\end{minipage}%
\endgroup%
}
Lots of new stuff for "module synopsis support." Public interface consists of three macros, one which replaces some of the current conventions used in the module sections: \declaremodule: Requires two parameters: module type (standard, builtin, extension), and the module name. An optional parameter should be given as the basis for the module's "key" used for linking to or referencing the section. The "key" should only be given if the module's name contains underscores, and should be the name with the underscore's stripped. This should be the first thing after the \section used to introduce the module. \modulesynopsis: Requires a single parameter: a short, one-liner description of the module that can be used as part of the chapter introduction. This should probably be placed just after the \declaremodule, but may be placed anywhere in the same section. \localmoduletable: No parameters. If a .syn file exists for the current chapter (or for the entire document in howto docs), a synopsistable is created with the contents loaded from the .syn file. Some re-organization due to module synopsis support. Some \def's changed to \newcommand's.
1998-07-24 01:50:45 +08:00
\newcommand{\py@modulebadkey}{{--just-some-junk--}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
%% Lots of index-entry generation support.
% Command to wrap around stuff that refers to function / module /
% attribute names in the index. Default behavior: like \code{}. To
% just keep the index entries in the roman font, uncomment the second
Lots of new stuff for "module synopsis support." Public interface consists of three macros, one which replaces some of the current conventions used in the module sections: \declaremodule: Requires two parameters: module type (standard, builtin, extension), and the module name. An optional parameter should be given as the basis for the module's "key" used for linking to or referencing the section. The "key" should only be given if the module's name contains underscores, and should be the name with the underscore's stripped. This should be the first thing after the \section used to introduce the module. \modulesynopsis: Requires a single parameter: a short, one-liner description of the module that can be used as part of the chapter introduction. This should probably be placed just after the \declaremodule, but may be placed anywhere in the same section. \localmoduletable: No parameters. If a .syn file exists for the current chapter (or for the entire document in howto docs), a synopsistable is created with the contents loaded from the .syn file. Some re-organization due to module synopsis support. Some \def's changed to \newcommand's.
1998-07-24 01:50:45 +08:00
% definition; it matches O'Reilly style more.
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\py@idxcode}[1]{\texttt{#1}}
%\renewcommand{\py@idxcode}[1]{#1}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% Command to generate two index entries (using subentries)
\newcommand{\indexii}[2]{\index{#1!#2}\index{#2!#1}}
% And three entries (using only one level of subentries)
\newcommand{\indexiii}[3]{\index{#1!#2 #3}\index{#2!#3, #1}\index{#3!#1 #2}}
% And four (again, using only one level of subentries)
\newcommand{\indexiv}[4]{
\index{#1!#2 #3 #4}
\index{#2!#3 #4, #1}
\index{#3!#4, #1 #2}
\index{#4!#1 #2 #3}
}
% Command to generate a reference to a function, statement, keyword,
% operator.
\itembreak, \itemjoin, \kwindex: Revived definitions to support the Python Reference Manual.
1998-05-07 03:36:01 +08:00
\newcommand{\kwindex}[1]{\indexii{keyword}{#1@{\py@idxcode{#1}}}}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\stindex}[1]{\indexii{statement}{#1@{\py@idxcode{#1}}}}
\newcommand{\opindex}[1]{\indexii{operator}{#1@{\py@idxcode{#1}}}}
\newcommand{\exindex}[1]{\indexii{exception}{#1@{\py@idxcode{#1}}}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\newcommand{\obindex}[1]{\indexii{object}{#1}}
\bifuncindex: Fix so entries combine correctly with those of the built-in functions section.
1998-04-03 02:48:32 +08:00
\newcommand{\bifuncindex}[1]{\withsubitem{(built-in function)}{\ttindex{#1()}}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% Add an index entry for a module
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\py@refmodule}[2]{\index{#1@{\py@idxcode{#1}} (#2module)}}
\newcommand{\refmodindex}[1]{\py@refmodule{#1}{}}
\newcommand{\refbimodindex}[1]{\py@refmodule{#1}{built-in }}
\newcommand{\refexmodindex}[1]{\py@refmodule{#1}{extension }}
\newcommand{\refstmodindex}[1]{\py@refmodule{#1}{standard }}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% support for the module index
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newif\ifpy@UseModuleIndex
\py@UseModuleIndexfalse
Adjust the index support a bit to make it easier to deal with module index. Don't generate the mod???.idx file if it wasn't requested with the new command \makemodindex. Change the format of mod???.idx to match that of "normal" .idx files. This lets us use makeindex for it and not need a special script.
1998-03-10 00:35:36 +08:00
\newcommand{\makemodindex}{
\newwrite\modindexfile
\openout\modindexfile=mod\jobname.idx
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\py@UseModuleIndextrue
Adjust the index support a bit to make it easier to deal with module index. Don't generate the mod???.idx file if it wasn't requested with the new command \makemodindex. Change the format of mod???.idx to match that of "normal" .idx files. This lets us use makeindex for it and not need a special script.
1998-03-10 00:35:36 +08:00
}
\withsubitem{}: New macro. Change indexsubitem temporarily for another macro. Intended usage: \withsubitem{(in module foo)}{\ttindex{myfunc()}} This allows indexing functions from other modules/class/whatnot without being dependent on the exact expansions of several macros internal to python.sty. It's also easier to read in the source! Some new "logical" macros that seem to be useful: \regexp{}: For regular expressions. To make it easier to keep the appearance consistent. \mimetype{}: Don't use \code{}! \envvar{}: Environment variable. This does some indexing as well. \character{}: Just a character we want to talk about in the text, but not a Python constant.
1998-03-12 14:41:40 +08:00
% Add the defining entry for a module
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\py@modindex}[2]{%
Lots of new stuff for "module synopsis support." Public interface consists of three macros, one which replaces some of the current conventions used in the module sections: \declaremodule: Requires two parameters: module type (standard, builtin, extension), and the module name. An optional parameter should be given as the basis for the module's "key" used for linking to or referencing the section. The "key" should only be given if the module's name contains underscores, and should be the name with the underscore's stripped. This should be the first thing after the \section used to introduce the module. \modulesynopsis: Requires a single parameter: a short, one-liner description of the module that can be used as part of the chapter introduction. This should probably be placed just after the \declaremodule, but may be placed anywhere in the same section. \localmoduletable: No parameters. If a .syn file exists for the current chapter (or for the entire document in howto docs), a synopsistable is created with the contents loaded from the .syn file. Some re-organization due to module synopsis support. Some \def's changed to \newcommand's.
1998-07-24 01:50:45 +08:00
\renewcommand{\py@thismodule}{#1}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\setindexsubitem{(in module #1)}%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\index{#1@{\py@idxcode{#1}} (#2module)|textbf}%
\ifpy@UseModuleIndex%
\withsubitem{}: New macro. Change indexsubitem temporarily for another macro. Intended usage: \withsubitem{(in module foo)}{\ttindex{myfunc()}} This allows indexing functions from other modules/class/whatnot without being dependent on the exact expansions of several macros internal to python.sty. It's also easier to read in the source! Some new "logical" macros that seem to be useful: \regexp{}: For regular expressions. To make it easier to keep the appearance consistent. \mimetype{}: Don't use \code{}! \envvar{}: Environment variable. This does some indexing as well. \character{}: Just a character we want to talk about in the text, but not a Python constant.
1998-03-12 14:41:40 +08:00
\write\modindexfile{\protect\indexentry{#1@{\tt #1}}{\thepage}}%
\fi%
}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% built-in & Python modules in the main distribution
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\bimodindex}[1]{\py@modindex{#1}{built-in }}
\newcommand{\stmodindex}[1]{\py@modindex{#1}{standard }}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% Python & extension modules outside the main distribution
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\modindex}[1]{\py@modindex{#1}{}}
\newcommand{\exmodindex}[1]{\py@modindex{#1}{extension }}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% Additional string for an index entry
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\newcommand{\index@subitem}{}
\newcommand{\setindexsubitem}[1]{\renewcommand{\index@subitem}{#1}}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\ttindex}[1]{\index{#1@{\py@idxcode{#1}} \index@subitem}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\withsubitem{}: New macro. Change indexsubitem temporarily for another macro. Intended usage: \withsubitem{(in module foo)}{\ttindex{myfunc()}} This allows indexing functions from other modules/class/whatnot without being dependent on the exact expansions of several macros internal to python.sty. It's also easier to read in the source! Some new "logical" macros that seem to be useful: \regexp{}: For regular expressions. To make it easier to keep the appearance consistent. \mimetype{}: Don't use \code{}! \envvar{}: Environment variable. This does some indexing as well. \character{}: Just a character we want to talk about in the text, but not a Python constant.
1998-03-12 14:41:40 +08:00
\newcommand{\withsubitem}[2]{%
\begingroup%
\def\index@subitem{#1}#2%
\endgroup%
}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
Removed an obsolete hack that's been commented out for a long time. Added comments to various sections.
1998-04-03 06:33:16 +08:00
Lots of new stuff for "module synopsis support." Public interface consists of three macros, one which replaces some of the current conventions used in the module sections: \declaremodule: Requires two parameters: module type (standard, builtin, extension), and the module name. An optional parameter should be given as the basis for the module's "key" used for linking to or referencing the section. The "key" should only be given if the module's name contains underscores, and should be the name with the underscore's stripped. This should be the first thing after the \section used to introduce the module. \modulesynopsis: Requires a single parameter: a short, one-liner description of the module that can be used as part of the chapter introduction. This should probably be placed just after the \declaremodule, but may be placed anywhere in the same section. \localmoduletable: No parameters. If a .syn file exists for the current chapter (or for the entire document in howto docs), a synopsistable is created with the contents loaded from the .syn file. Some re-organization due to module synopsis support. Some \def's changed to \newcommand's.
1998-07-24 01:50:45 +08:00
% Module synopsis processing -----------------------------------------------
%
\newcommand{\py@standardIndexModule}[1]{\stmodindex{#1}}
\newcommand{\py@builtinIndexModule}[1]{\bimodindex{#1}}
\newcommand{\py@extensionIndexModule}[1]{\exmodindex{#1}}
\newcommand{\py@IndexModule}[1]{\modindex{#1}}
\newif\ifpy@HaveModSynopsis\py@HaveModSynopsisfalse
\newif\ifpy@ModSynopsisFileIsOpen\py@ModSynopsisFileIsOpenfalse
% \declaremodule[key]{type}{name}
\newcommand{\declaremodule}[3][\py@modulebadkey]{
\py@openModSynopsisFile
\renewcommand{\py@thismoduletype}{#2}
\csname py@#2IndexModule\endcsname{#3}
\ifx\py@modulebadkey#1
\renewcommand{\py@thismodulekey}{#3}
\else
\renewcommand{\py@thismodulekey}{#1}
\fi
\label{module-\py@thismodulekey}
\py@HaveModSynopsistrue
}
\newcommand{\py@defsynopsis}{Module has no synopsis.}
\newcommand{\py@modulesynopsis}{\py@defsynopsis}
\newcommand{\modulesynopsis}[1]{
\renewcommand{\py@modulesynopsis}{#1}
}
% define the file
\newwrite\py@ModSynopsisFile
% hacked from \addtocontents from latex.ltx:
\long\def\py@writeModSynopsisFile#1{%
\protected@write\py@ModSynopsisFile%
{\let\label\@gobble \let\index\@gobble \let\glossary\@gobble}%
{\string#1}%
}
\newcommand{\py@closeModSynopsisFile}{
\ifpy@ModSynopsisFileIsOpen
\closeout\py@ModSynopsisFile
\py@ModSynopsisFileIsOpenfalse
\fi
}
\newcommand{\py@openModSynopsisFile}{
\ifpy@ModSynopsisFileIsOpen\else
\openout\py@ModSynopsisFile=\py@ModSynopsisFilename
\py@ModSynopsisFileIsOpentrue
\fi
}
\newcommand{\py@ProcessModSynopsis}{
\ifpy@HaveModSynopsis
\py@writeModSynopsisFile{\modulesynopsis%
{\py@thismodulekey}{\py@thismodule}%
{\py@thismoduletype}{\py@modulesynopsis}}%
\py@HaveModSynopsisfalse
\fi
\renewcommand{\py@modulesynopsis}{\py@defsynopsis}
}
\AtEndDocument{\py@ProcessModSynopsis\py@closeModSynopsisFile}
\newcommand{\localmoduletable}{
\IfFileExists{\py@ModSynopsisFilename}{
\begin{synopsistable}
\input{\py@ModSynopsisFilename}
\end{synopsistable}
}{}
}
\@ifundefined{pdfoutput}{
\newcommand{\py@ModSynopsisSummary}[4]{\bfcode{#2} & #4\\}
}{
\newcommand{\py@ModSynopsisSummary}[4]{
{\pdfannotlink attr{/Border [0 0 0]} goto name{label-module-#1}
\py@LinkColor \bfcode{#2} \py@NormalColor
\pdfendlink}& #4\\}
}
\newenvironment{synopsistable}{
% key, name, type, synopsis
\let\modulesynopsis=\py@ModSynopsisSummary
\begin{tabular}{ll}
}{
\end{tabular}
}
%
% --------------------------------------------------------------------------
\newcommand{\py@thisclass}{}
\newcommand{\py@thismodule}{}
\newcommand{\py@thismodulekey}{}
\newcommand{\py@thismoduletype}{}
\newcommand{\py@reset}{
\py@ProcessModSynopsis
\renewcommand{\py@thisclass}{}
\renewcommand{\py@thismodule}{}
\renewcommand{\py@thismodulekey}{}
\renewcommand{\py@thismoduletype}{}
}
% Augment the sectioning commands used to get our own font family in place,
% and reset some internal data items:
\renewcommand{\section}{\py@reset%
\@startsection{section}{1}{\z@}%
{-3.5ex \@plus -1ex \@minus -.2ex}%
{2.3ex \@plus.2ex}%
{\reset@font\Large\py@HeaderFamily}}
\renewcommand{\subsection}{\@startsection{subsection}{2}{\z@}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\reset@font\large\py@HeaderFamily}}
\renewcommand{\subsubsection}{\@startsection{subsubsection}{3}{\z@}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\reset@font\normalsize\py@HeaderFamily}}
\renewcommand{\paragraph}{\@startsection{paragraph}{4}{\z@}%
{3.25ex \@plus1ex \@minus.2ex}%
{-1em}%
{\reset@font\normalsize\py@HeaderFamily}}
\renewcommand{\subparagraph}{\@startsection{subparagraph}{5}{\parindent}%
{3.25ex \@plus1ex \@minus .2ex}%
{-1em}%
{\reset@font\normalsize\py@HeaderFamily}}
% Underscore hack (only act like subscript operator if in math mode)
%
% The following is due to Mark Wooding (the old version didn't work with
% Latex 2e.
\DeclareRobustCommand\hackscore{%
\ifmmode_\else\textunderscore\fi%
}
\begingroup
\catcode`\_\active
\def\next{%
\AtBeginDocument{\catcode`\_\active\def_{\hackscore{}}}%
}
\expandafter\endgroup\next
Removed an obsolete hack that's been commented out for a long time. Added comments to various sections.
1998-04-03 06:33:16 +08:00
% Now for a lot of semantically-loaded environments that do a ton of magical
% things to get the right formatting and index entries for the stuff in
% Python modules and C API.
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% {fulllineitems} is used in one place in libregex.tex, but is really for
% internal use in this file.
%
\newenvironment{fulllineitems}{
\begin{list}{}{\labelwidth \leftmargin \labelsep 0pt
\rightmargin 0pt \topsep -\parskip \partopsep \parskip
\itemsep -\parsep
\let\makelabel=\itemnewline}
}{\end{list}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
% \optional is mostly for use in the arguments parameters to the various
% {*desc} environments defined below, but may be used elsewhere. Known to
% be used in the debugger chapter.
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
%
% Typical usage:
%
% \begin{funcdesc}{myfunc}{reqparm\optional{, optparm}}
% ^^^ ^^^
% No space here No space here
%
% When a function has multiple optional parameters, \optional should be
% nested, not chained. This is right:
%
% \begin{funcdesc}{myfunc}{\optional{parm1\optional{, parm2}}}
%
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\newcommand{\optional}[1]{%
{\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
% C functions ------------------------------------------------------------
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% \begin{cfuncdesc}{type}{name}{arglist}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\newenvironment{cfuncdesc}[3]{
\begin{fulllineitems}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\item[\code{#1 \bfcode{#2}(\py@varvars{#3})}\index{#2@{\py@idxcode{#2()}}}]
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{\end{fulllineitems}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
% C variables ------------------------------------------------------------
% \begin{cvardesc}{type}{name}
\newenvironment{cvardesc}[2]{
\begin{fulllineitems}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\item[\code{#1 \bfcode{#2}}\index{#2@{\py@idxcode{#2}}}]
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{\end{fulllineitems}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
% C data types -----------------------------------------------------------
% \begin{ctypedesc}{typedef name}
\newenvironment{ctypedesc}[1]{
\begin{fulllineitems}
\item[\bfcode{#1}\ttindex{#1}]
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{\end{fulllineitems}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
% simple functions (not methods) -----------------------------------------
% \begin{funcdesc}{name}{args}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\newcommand{\funcline}[2]{\funclineni{#1}{#2}\ttindex{#1()}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\newenvironment{funcdesc}[2]{
\begin{fulllineitems}
\funcline{#1}{#2}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{\end{fulllineitems}}
% similar to {funcdesc}, but doesn't add to the index
Hide \varvars from "public" interface.
1998-04-17 10:17:00 +08:00
\newcommand{\funclineni}[2]{\item[\code{\bfcode{#1}(\py@varvars{#2})}]}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\newenvironment{funcdescni}[2]{
\begin{fulllineitems}
\funclineni{#1}{#2}
}{\end{fulllineitems}}
% classes ----------------------------------------------------------------
% \begin{classdesc}{name}{constructor args}
\newenvironment{classdesc}[2]{
Lots of new stuff for "module synopsis support." Public interface consists of three macros, one which replaces some of the current conventions used in the module sections: \declaremodule: Requires two parameters: module type (standard, builtin, extension), and the module name. An optional parameter should be given as the basis for the module's "key" used for linking to or referencing the section. The "key" should only be given if the module's name contains underscores, and should be the name with the underscore's stripped. This should be the first thing after the \section used to introduce the module. \modulesynopsis: Requires a single parameter: a short, one-liner description of the module that can be used as part of the chapter introduction. This should probably be placed just after the \declaremodule, but may be placed anywhere in the same section. \localmoduletable: No parameters. If a .syn file exists for the current chapter (or for the entire document in howto docs), a synopsistable is created with the contents loaded from the .syn file. Some re-organization due to module synopsis support. Some \def's changed to \newcommand's.
1998-07-24 01:50:45 +08:00
\renewcommand{\py@thisclass}{#1}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\begin{fulllineitems}
Hide \varvars from "public" interface.
1998-04-17 10:17:00 +08:00
\item[\code{\bfcode{#1}(\py@varvars{#2})}%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\withsubitem{(class in \py@thismodule)}{\ttindex{#1}}]
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{\end{fulllineitems}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\let\py@classbadkey=\@undefined
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
% object method ----------------------------------------------------------
% \begin{methoddesc}[classname]{methodname}{args}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\methodline}[3][\py@classbadkey]{
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\methodlineni{#2}{#3}
\ifx#1\@undefined
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\withsubitem{(\py@thisclass\ method)}{\ttindex{#2()}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\else
\withsubitem{(#1 method)}{\ttindex{#2()}}
\fi
}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newenvironment{methoddesc}[3][\py@classbadkey]{
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\begin{fulllineitems}
\ifx#1\@undefined
\methodline{#2}{#3}
\else
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\def\py@thisclass{#1}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\methodline[#1]{#2}{#3}
\fi
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{\end{fulllineitems}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
% similar to {methoddesc}, but doesn't add to the index
% (never actually uses the optional argument)
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\methodlineni}[3][\py@classbadkey]{%
Hide \varvars from "public" interface.
1998-04-17 10:17:00 +08:00
\item[\code{\bfcode{#2}(\py@varvars{#3})}]}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newenvironment{methoddescni}[3][\py@classbadkey]{
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\begin{fulllineitems}
\methodlineni{#2}{#3}
}{\end{fulllineitems}}
% object data attribute --------------------------------------------------
% \begin{memberdesc}[classname]{membername}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\memberline}[2][\py@classbadkey]{%
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\ifx#1\@undefined
\memberlineni{#2}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\withsubitem{(\py@thisclass\ attribute)}{\ttindex{#2}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\else
\memberlineni{#2}
Data attributes of objects should not be indexed with trailing parentheses!
1998-04-08 03:32:40 +08:00
\withsubitem{(#1 attribute)}{\ttindex{#2}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\fi
}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newenvironment{memberdesc}[2][\py@classbadkey]{
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\begin{fulllineitems}
\ifx#1\@undefined
\memberline{#2}
\else
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\def\py@thisclass{#1}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\memberline[#1]{#2}
\fi
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{\end{fulllineitems}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
% similar to {memberdesc}, but doesn't add to the index
% (never actually uses the optional argument)
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\memberlineni}[2][\py@classbadkey]{\item[\bfcode{#2}]}
\newenvironment{memberdescni}[2][\py@classbadkey]{
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\begin{fulllineitems}
\memberlineni{#2}
}{\end{fulllineitems}}
% For exceptions: --------------------------------------------------------
% \begin{excdesc}{name}
% -- need support for constructor; maybe use optional parameter?
\newenvironment{excdesc}[1]{
\begin{fulllineitems}
\item[\bfcode{#1}\ttindex{#1}]
}{\end{fulllineitems}}
% Module data or constants: ----------------------------------------------
% \begin{datadesc}{name}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\newcommand{\dataline}[1]{\datalineni{#1}\ttindex{#1}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\newenvironment{datadesc}[1]{
\begin{fulllineitems}
\dataline{#1}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{\end{fulllineitems}}
% similar to {datadesc}, but doesn't add to the index
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\newcommand{\datalineni}[1]{\item[\bfcode{#1}]\nopagebreak}
\newenvironment{datadescni}[1]{
\begin{fulllineitems}
\datalineni{#1}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{\end{fulllineitems}}
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
% bytecode instruction ---------------------------------------------------
% \begin{opcodedesc}{name}{var}
% -- {var} may be {}
\newenvironment{opcodedesc}[2]{
\begin{fulllineitems}
\item[\bfcode{#1}\quad\var{#2}]
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{\end{fulllineitems}}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\nodename}[1]{\label{#1}}
Don't use the fncychap package for HOWTO documents; appendices break. Still use them for manuals.
1998-03-25 23:41:23 +08:00
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% For these commands, use \command{} to get the typography right, not
% {\command}. This works better with the texinfo translation.
\newcommand{\ABC}{{\sc abc}}
\newcommand{\UNIX}{{\sc Unix}}
\newcommand{\POSIX}{POSIX}
\newcommand{\ASCII}{{\sc ascii}}
\newcommand{\Cpp}{C\protect\raisebox{.18ex}{++}}
\newcommand{\C}{C}
\newcommand{\EOF}{{\sc eof}}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\NULL}{\constant{NULL}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
Removed an obsolete hack that's been commented out for a long time. Added comments to various sections.
1998-04-03 06:33:16 +08:00
% Also for consistency: spell Python "Python", not "python"!
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% code is the most difficult one...
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\newcommand{\code}[1]{{\@vobeyspaces\@noligs\def\{{\char`\{}\def\}{\char`\}}\def\~{\char`\~}\def\^{\char`\^}\def\e{\char`\\}\def\${\char`\$}\def\#{\char`\#}\def\&{\char`\&}\def\%{\char`\%}%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\texttt{#1}}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\newcommand{\bfcode}[1]{\code{\bfseries#1}} % bold-faced code font
Fix the \kbd definition so it didn't leave the courier face on.
1998-07-01 22:49:25 +08:00
\newcommand{\kbd}[1]{\code{#1}}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\samp}[1]{`\code{#1}'}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% This weird definition of \var{} allows it to always appear in roman
% italics, and won't get funky in code fragments when we play around
% with fonts.
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\var}[1]{\normalsize\textrm{\textit{#1\/}}}
\renewcommand{\emph}[1]{{\em #1}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\newcommand{\dfn}[1]{\emph{#1}}
\newcommand{\strong}[1]{{\bf #1}}
% let's experiment with a new font:
\withsubitem{}: New macro. Change indexsubitem temporarily for another macro. Intended usage: \withsubitem{(in module foo)}{\ttindex{myfunc()}} This allows indexing functions from other modules/class/whatnot without being dependent on the exact expansions of several macros internal to python.sty. It's also easier to read in the source! Some new "logical" macros that seem to be useful: \regexp{}: For regular expressions. To make it easier to keep the appearance consistent. \mimetype{}: Don't use \code{}! \envvar{}: Environment variable. This does some indexing as well. \character{}: Just a character we want to talk about in the text, but not a Python constant.
1998-03-12 14:41:40 +08:00
\newcommand{\file}[1]{`{\small\textsf{#1}}'}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% Use this def/redef approach for \url{} since hyperref defined this already,
% but only if we actually used hyperref:
Add comments about several of the environments. Cleaned up some problems that caused minor warnings. Added environments for object methods and members, with non-indexing variants. This includes reduced use of the indexsubitem setting, allowing more robust index generation. Removed some unused definitions.
1998-03-27 13:22:53 +08:00
\@ifundefined{pdfannotlink}{
Fix the broken PDF links, really this time! "." cannot be part of the target names either. Appending a junk char to the end doesn't quite do it, or doesn't seem to at any rate. Instead, pad the page numbers to always be 3 charaters wide, with leading zeros.
1998-04-16 01:50:01 +08:00
\newcommand{\py@url}[1]{\mbox{\small\textsf{#1}}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{
Fix the broken PDF links, really this time! "." cannot be part of the target names either. Appending a junk char to the end doesn't quite do it, or doesn't seem to at any rate. Instead, pad the page numbers to always be 3 charaters wide, with leading zeros.
1998-04-16 01:50:01 +08:00
\newcommand{\py@url}[1]{{%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\pdfannotlink attr{/Border [0 0 0]} user{/S /URI /URI (#1)}%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\py@LinkColor% color of the link text
\mbox{\small\textsf{#1}}%
\py@NormalColor% Turn it back off; these are declarative
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\pdfendlink}% and don't appear bound to the current
}% formatting "box".
}
Fix the broken PDF links, really this time! "." cannot be part of the target names either. Appending a junk char to the end doesn't quite do it, or doesn't seem to at any rate. Instead, pad the page numbers to always be 3 charaters wide, with leading zeros.
1998-04-16 01:50:01 +08:00
\let\url=\py@url
\withsubitem{}: New macro. Change indexsubitem temporarily for another macro. Intended usage: \withsubitem{(in module foo)}{\ttindex{myfunc()}} This allows indexing functions from other modules/class/whatnot without being dependent on the exact expansions of several macros internal to python.sty. It's also easier to read in the source! Some new "logical" macros that seem to be useful: \regexp{}: For regular expressions. To make it easier to keep the appearance consistent. \mimetype{}: Don't use \code{}! \envvar{}: Environment variable. This does some indexing as well. \character{}: Just a character we want to talk about in the text, but not a Python constant.
1998-03-12 14:41:40 +08:00
\newcommand{\email}[1]{{\small\textsf{#1}}}
Added some comments.
1998-04-02 06:20:14 +08:00
\newcommand{\newsgroup}[1]{{\small\textsf{#1}}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
Hide \varvars from "public" interface.
1998-04-17 10:17:00 +08:00
\newcommand{\py@varvars}[1]{{\def\,{\/{\char`\,}}\var{#1}}}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
% let's see if this breaks anything now; we may be able to simplify...
\renewcommand{\py@varvars}[1]{\var{#1}}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
% I'd really like to get rid of this!
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\newif\iftexi\texifalse
% These should be used for all references to identifiers which are
% used to refer to instances of specific language constructs. See the
% names for specific semantic assignments.
%
% For now, don't do anything really fancy with them; just use them as
% logical markup. This might change in the future.
%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\module}[1]{\texttt{#1}}
\newcommand{\keyword}[1]{\texttt{#1}}
\newcommand{\exception}[1]{\texttt{#1}}
\newcommand{\class}[1]{\texttt{#1}}
\newcommand{\function}[1]{\texttt{#1}}
\newcommand{\member}[1]{\texttt{#1}}
\newcommand{\method}[1]{\texttt{#1}}
Don't use the fncychap package for HOWTO documents; appendices break. Still use them for manuals.
1998-03-25 23:41:23 +08:00
Removed an obsolete hack that's been commented out for a long time. Added comments to various sections.
1998-04-03 06:33:16 +08:00
\newcommand{\pytype}[1]{#1} % built-in Python type
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\cfunction}[1]{\texttt{#1}}
\newcommand{\ctype}[1]{\texttt{#1}} % C struct or typedef name
\newcommand{\cdata}[1]{\texttt{#1}} % C variable, typically global
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\withsubitem{}: New macro. Change indexsubitem temporarily for another macro. Intended usage: \withsubitem{(in module foo)}{\ttindex{myfunc()}} This allows indexing functions from other modules/class/whatnot without being dependent on the exact expansions of several macros internal to python.sty. It's also easier to read in the source! Some new "logical" macros that seem to be useful: \regexp{}: For regular expressions. To make it easier to keep the appearance consistent. \mimetype{}: Don't use \code{}! \envvar{}: Environment variable. This does some indexing as well. \character{}: Just a character we want to talk about in the text, but not a Python constant.
1998-03-12 14:41:40 +08:00
\newcommand{\mimetype}[1]{{\small\textsf{#1}}}
\regexp{}: Rewritten to look like Freidl's book. Too rip-off? \envvar{}: Bow to font-lock-mode a few times...!
1998-03-13 03:37:03 +08:00
% The \! is a "negative thin space" in math mode.
\newcommand{\regexp}[1]{%
{\tiny$^{^\lceil}\!\!$%
{\normalsize\code{#1}}%
Increase space between the end of a regexp and the little right floor symbol used as a closing quote. At AMK's request.
1998-04-04 05:22:31 +08:00
$\!\rfloor\!$%
\regexp{}: Rewritten to look like Freidl's book. Too rip-off? \envvar{}: Bow to font-lock-mode a few times...!
1998-03-13 03:37:03 +08:00
}}
\withsubitem{}: New macro. Change indexsubitem temporarily for another macro. Intended usage: \withsubitem{(in module foo)}{\ttindex{myfunc()}} This allows indexing functions from other modules/class/whatnot without being dependent on the exact expansions of several macros internal to python.sty. It's also easier to read in the source! Some new "logical" macros that seem to be useful: \regexp{}: For regular expressions. To make it easier to keep the appearance consistent. \mimetype{}: Don't use \code{}! \envvar{}: Environment variable. This does some indexing as well. \character{}: Just a character we want to talk about in the text, but not a Python constant.
1998-03-12 14:41:40 +08:00
\newcommand{\envvar}[1]{%
\regexp{}: Rewritten to look like Freidl's book. Too rip-off? \envvar{}: Bow to font-lock-mode a few times...!
1998-03-13 03:37:03 +08:00
\$#1% $ <-- bow to font-lock 3 times!
\index{#1@{\$#1}}% $
\index{environment variables!{\$#1}}% $
\withsubitem{}: New macro. Change indexsubitem temporarily for another macro. Intended usage: \withsubitem{(in module foo)}{\ttindex{myfunc()}} This allows indexing functions from other modules/class/whatnot without being dependent on the exact expansions of several macros internal to python.sty. It's also easier to read in the source! Some new "logical" macros that seem to be useful: \regexp{}: For regular expressions. To make it easier to keep the appearance consistent. \mimetype{}: Don't use \code{}! \envvar{}: Environment variable. This does some indexing as well. \character{}: Just a character we want to talk about in the text, but not a Python constant.
1998-03-12 14:41:40 +08:00
}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\makevar}[1]{#1} % variable in a Makefile
\newcommand{\character}[1]{\samp{#1}}
\withsubitem{}: New macro. Change indexsubitem temporarily for another macro. Intended usage: \withsubitem{(in module foo)}{\ttindex{myfunc()}} This allows indexing functions from other modules/class/whatnot without being dependent on the exact expansions of several macros internal to python.sty. It's also easier to read in the source! Some new "logical" macros that seem to be useful: \regexp{}: For regular expressions. To make it easier to keep the appearance consistent. \mimetype{}: Don't use \code{}! \envvar{}: Environment variable. This does some indexing as well. \character{}: Just a character we want to talk about in the text, but not a Python constant.
1998-03-12 14:41:40 +08:00
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% constants defined in Python modules or C headers, not language constants:
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\constant}[1]{\code{#1}} % manifest constant, not syntactic
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\newcommand{\manpage}[2]{{\emph{#1}(#2)}}
\newcommand{\rfc}[1]{RFC #1\index{RFC!RFC #1}}
\newcommand{\program}[1]{\strong{#1}}
% Deprecation stuff.
% Should be extended to allow an index / list of deprecated stuff. But
% there's a lot of stuff that needs to be done to make that automatable.
%
% First parameter is the release number that deprecates the feature, the
% second is the action the should be taken by users of the feature.
%
% Example:
%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
% \deprecated{1.5.1}{Use \method{frobnicate()} instead.}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
%
\newcommand{\deprecated}[2]{%
\strong{Deprecated since release #1.} #2\par}
\newenvironment{tableii}[4]{%
\begin{center}%
\def\lineii##1##2{\csname#2\endcsname{##1}&##2\\}%
Lighten up tables.
1998-04-12 04:53:03 +08:00
\begin{tabular}{#1}\strong{#3}&\strong{#4} \\ \hline%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{%
\end{tabular}%
\end{center}%
}
\newenvironment{tableiii}[5]{%
\begin{center}%
\def\lineiii##1##2##3{\csname#2\endcsname{##1}&##2&##3\\}%
Lighten up tables.
1998-04-12 04:53:03 +08:00
\begin{tabular}{#1}\strong{#3}&\strong{#4}&\strong{#5} \\ \hline%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{%
\end{tabular}%
\end{center}%
}
\newcommand{\itemnewline}[1]{%
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\@tempdima\linewidth%
\advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}
\itembreak, \itemjoin, \kwindex: Revived definitions to support the Python Reference Manual.
1998-05-07 03:36:01 +08:00
% Define \itembreak: force the text after an item to start on a new line
\newcommand{\itembreak}{%
\mbox{}%
\\*[0mm]%
}
% Define \itemjoin: some negative vspace to join two items together
\newcommand{\itemjoin}{%
\mbox{}%
\vspace{-\itemsep}%
\vspace{-\parsep}%
}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
% Cross-referencing (AMK, new impl. FLD)
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% Sample usage:
% \begin{seealso}
% \seemodule{rand}{Uniform random number generator}; % Module xref
% \seetext{\emph{Encyclopedia Britannica}}. % Ref to a book
Revise some of the PDF support to get at least preliminary outline support. Rewrite \seemodule (again) to allow an optional argument to support modules which include an underscore in the names. See example in comments.
1998-03-07 05:25:17 +08:00
%
% % A funky case: module name contains '_'; have to supply an optional key
% \seemodule[copyreg]{copy_reg}{pickle interface constructor registration}
%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% \end{seealso}
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\@ifundefined{pdfannotlink}{%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\py@seemodule}[3][\py@modulebadkey]{%
\ifx\py@modulebadkey#1\def\py@modulekey{#2}\else\def\py@modulekey{#1}\fi%
\ref{module-\py@modulekey}:\quad %
Revise some of the PDF support to get at least preliminary outline support. Rewrite \seemodule (again) to allow an optional argument to support modules which include an underscore in the names. See example in comments.
1998-03-07 05:25:17 +08:00
Module \module{#2}%
\quad (#3)%
}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
}{\newcommand{\py@seemodule}[3][\py@modulebadkey]{%
\ifx\py@modulebadkey#1\def\py@modulekey{#2}\else\def\py@modulekey{#1}\fi%
\ref{module-\py@modulekey}:\quad %
{\pdfannotlink attr{/Border [0 0 0]} goto name{label-module-\py@modulekey}%
\py@LinkColor Module \module{#2} \py@NormalColor%
Revise some of the PDF support to get at least preliminary outline support. Rewrite \seemodule (again) to allow an optional argument to support modules which include an underscore in the names. See example in comments.
1998-03-07 05:25:17 +08:00
\pdfendlink%
}%
\quad (#3)%
}
}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\newenvironment{seealso}[0]{
\strong{See Also:}\par
\def\seetext##1{\par{##1}}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\let\seemodule=\py@seemodule
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
}{\par}
% Allow the release number to be specified independently of the
% \date{}. This allows the date to reflect the document's date and
% release to specify the Python release that is documented.
%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\py@release}{}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\newcommand{\version}{}
\newcommand{\releasename}{Release}
\newcommand{\release}[1]{%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\renewcommand{\py@release}{\releasename\space\version}%
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\renewcommand{\version}{#1}}
% Allow specification of the author's address separately from the
% author's name. This can be used to format them differently, which
% is a good thing.
%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\newcommand{\py@authoraddress}{}
\newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}}
Added definitions for \developer, \developers, \developersaddress. Ask Guido if you really want to know why. ;-)
1998-05-15 04:56:31 +08:00
\let\developersaddress=\authoraddress
\let\developer=\author
\let\developers=\author
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% This sets up the fancy chapter headings that make the documents look
% at least a little better than the usual LaTeX output.
%
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\@ifundefined{ChTitleVar}{}{
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-29 02:30:34 +08:00
\ChNameVar{\raggedleft\normalsize\py@HeaderFamily}
\ChNumVar{\raggedleft \bfseries\Large\py@HeaderFamily}
\ChTitleVar{\raggedleft \rm\Huge\py@HeaderFamily}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% This creates chapter heads without the leading \vspace*{}:
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\def\@makechapterhead#1{%
{\parindent \z@ \raggedright \normalfont
\ifnum \c@secnumdepth >\m@ne
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\DOCH
\fi
Never, NEVER try to recover a screwed up file by carving a chunk out of an RCS ,v archive! And certainly don't check it back in without testing it. ;-( "@" becomes "@@" everywhere. This one *is* tested!
1998-03-07 13:29:15 +08:00
\interlinepenalty\@M
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
\DOTI{#1}
}
}
}
Added {definitions} environment, which has \term to define indivual terms. Similar to {description}.
1998-05-21 01:42:17 +08:00
% Definition lists; requested by AMK for HOWTO documents. Probably useful
% elsewhere as well, so keep in in the general style support.
%
\newenvironment{definitions}{%
\begin{description}%
\def\term##1{\item[##1]\itembreak}
}{%
\end{description}%
}
Convert LaTeX support to create a new class of documents. HTML generation now requires LaTeX2HTML 98.1p1 or newer (& and is still in progress). This means that doing things to change the formatting of the manuals (at the "normal user" level, like A4 paper), can happen in just one place, rather than in each document file.
1998-03-04 06:02:19 +08:00
% Tell TeX about pathological hyphenation cases:
\hyphenation{Base-HTTP-Re-quest-Hand-ler}
Reference in New Issue Copy Permalink