Rooba
/
cpython
mirror of https://github.com/python/cpython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
cpython/Doc/texinputs/python.sty

1062 lines
33 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-03 22:02:19 +00:00
%
Oops; file copy error somewhere along the way....
1998-03-06 22:33:06 +00: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-03 22:02:19 +00: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 14:53:43 +00: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-03 22:02:19 +00:00
Add new environments: longtableii, longtableiii, and longtableiv, to support long tables which might break across page boundaries. Otherwise identical to tableii, tableiii, and tableiv.
2000-09-21 15:58:02 +00:00
\RequirePackage{longtable}
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
% Uncomment these two lines to ignore the paper size and make the page
% size more like a typical published manual.
%\renewcommand{\paperheight}{9in}
%\renewcommand{\paperwidth}{8.5in} % typical squarish manual
%\renewcommand{\paperwidth}{7in} % O'Reilly ``Programmming Python''
Added some comments.
1998-04-01 22:20:14 +00: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 14:53:43 +00: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-28 18:30:34 +00: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 05:22:53 +00: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 14:53:43 +00: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-03 22:02:19 +00:00
\input{pdfcolor}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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-03 22:02:19 +00:00
\pdfcompresslevel=9
Set the right page size in the PDF output.
1998-05-11 20:42:54 +00: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-06 21:25:17 +00: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-15 17:50:01 +00: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-23 17:50:45 +00: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-15 17:50:01 +00: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-06 21:25:17 +00: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-28 18:30:34 +00:00
\let\py@OldContentsline=\contentsline
\py@linkToName: New macro to consolidate support for most internal hyperlinking in the PDF version. This also allows many of the macros that do this stuff to be a good bit more readable. Takes the target name and link content as parameters. Use \py@linkToName for all internal links.
1999-01-27 17:37:36 +00:00
%
% Macro that takes two args: the name to link to and the content of
% the link. This takes care of the PDF magic, getting the colors
% the same for each link, and avoids having lots of garbage all over
% this style file.
\newcommand{\py@linkToName}[2]{%
\pdfannotlink attr{/Border [0 0 0]} goto name{#1}%
\py@LinkColor#2\py@NormalColor%
\pdfendlink%
}
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-15 17:50:01 +00: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-03 22:02:19 +00: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-15 17:50:01 +00:00
\def\my@pageno{\py@targetno{#3}}%
\py@linkToName: New macro to consolidate support for most internal hyperlinking in the PDF version. This also allows many of the macros that do this stuff to be a good bit more readable. Takes the target name and link content as parameters. Use \py@linkToName for all internal links.
1999-01-27 17:37:36 +00:00
\py@OldContentsline{#1}{\py@linkToName{page\my@pageno}{#2}}{#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-03 22:02:19 +00: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-06 21:25:17 +00: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 14:53:43 +00: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-06 21:25:17 +00: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-15 17:50:01 +00:00
\newcommand{\py@target}[1]{%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00:00
\ifpy@doing@page@targets%
Use more recent option to \pdfdest to not change the zoom factor. This is in response to a comment from Wes Rishel <wes@rishel.com>.
1999-03-24 14:16:17 +00:00
{\pdfdest name{#1} xyz}%
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-15 17:50:01 +00:00
\fi%
}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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-03 22:02:19 +00:00
\renewcommand{\label}[1]{%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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-15 17:50:01 +00: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-03 22:02:19 +00:00
}
Set the right page size in the PDF output.
1998-05-11 20:42:54 +00: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-03 22:02:19 +00: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 05:29:15 +00: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-03 22:02:19 +00: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 05:29:15 +00: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-15 17:50:01 +00: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 05:29:15 +00: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-03 22:02:19 +00: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 14:53:43 +00: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-03 22:02:19 +00: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
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
\textheight \paperheight
\advance\textheight by -2in
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-03 22:02:19 +00:00
\oddsidemargin 0pt
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
\evensidemargin 0pt
%\evensidemargin -.25in % for ``manual size'' documents
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-03 22:02:19 +00:00
\marginparwidth 0.5in
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
\textwidth \paperwidth
\advance\textwidth by -2in
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-03 22:02:19 +00:00
% 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-28 18:30:34 +00: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-03 22:02:19 +00:00
\hbadness = 5000 % don't print trivial gripes
\pagestyle{empty} % start this way; change for
\pagenumbering{roman} % ToC & chapters
% 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-28 18:30:34 +00: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-03 22:02:19 +00: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 05:29:15 +00: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-03 22:02:19 +00: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-28 18:30:34 +00: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-03 22:02:19 +00: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-28 18:30:34 +00: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-03 22:02:19 +00: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 05:29:15 +00: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-04 21:47:59 +00: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 05:29:15 +00: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-04 21:47:59 +00: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 05:29:15 +00: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-04 21:47:59 +00: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-03 22:02:19 +00: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.
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
\let\py@OldVerbatim=\verbatim
\let\py@OldEndVerbatim=\endverbatim
\RequirePackage{verbatim}
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-03 22:02:19 +00:00
% 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-28 18:30:34 +00: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-03 22:02:19 +00:00
\renewcommand{\verbatim}{%
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
\setlength{\parindent}{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-03 22:02:19 +00: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-28 18:30:34 +00: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-03 22:02:19 +00:00
%
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
\par\indent%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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-03 22:02:19 +00:00
\small%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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-03 22:02:19 +00:00
}
\renewcommand{\endverbatim}{%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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-03 22:02:19 +00:00
\end{minipage}%
}
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-23 17:50:45 +00: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-03 22:02:19 +00: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-23 17:50:45 +00: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-03 22:02:19 +00:00
%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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-03 22:02:19 +00: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-06 19:36:01 +00: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-28 18:30:34 +00: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-03 22:02:19 +00:00
\newcommand{\obindex}[1]{\indexii{object}{#1}}
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\newcommand{\bifuncindex}[1]{%
\index{#1@{\py@idxcode{#1()}} (built-in function)}}
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-03 22:02:19 +00: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-28 18:30:34 +00: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-03 22:02:19 +00:00
\seemodule: Fix so that each \seemodule entry gets its own paragraph, so they don't get run together when there's no blank line between them in the source. The HTML conversion already did the right thing. \refmodule: Refer to a module, using a hyperlink in the PDF version. Visually the same as \module.
1999-01-13 17:09:06 +00:00
% Refer to a module's documentation using a hyperlink of the module's
% name, at least if we're building PDF:
\@ifundefined{pdfannotlink}{%
\newcommand{\refmodule}[2][\py@modulebadkey]{\module{#2}}
\py@linkToName: New macro to consolidate support for most internal hyperlinking in the PDF version. This also allows many of the macros that do this stuff to be a good bit more readable. Takes the target name and link content as parameters. Use \py@linkToName for all internal links.
1999-01-27 17:37:36 +00:00
}{%
\newcommand{\refmodule}[2][\py@modulebadkey]{%
\seemodule: Fix so that each \seemodule entry gets its own paragraph, so they don't get run together when there's no blank line between them in the source. The HTML conversion already did the right thing. \refmodule: Refer to a module, using a hyperlink in the PDF version. Visually the same as \module.
1999-01-13 17:09:06 +00:00
\ifx\py@modulebadkey#1\def\py@modulekey{#2}\else\def\py@modulekey{#1}\fi%
\py@linkToName: New macro to consolidate support for most internal hyperlinking in the PDF version. This also allows many of the macros that do this stuff to be a good bit more readable. Takes the target name and link content as parameters. Use \py@linkToName for all internal links.
1999-01-27 17:37:36 +00:00
\py@linkToName{label-module-\py@modulekey}{\module{#2}}%
\seemodule: Fix so that each \seemodule entry gets its own paragraph, so they don't get run together when there's no blank line between them in the source. The HTML conversion already did the right thing. \refmodule: Refer to a module, using a hyperlink in the PDF version. Visually the same as \module.
1999-01-13 17:09:06 +00: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-03 22:02:19 +00: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-28 18:30:34 +00: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-09 16:35:36 +00: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-28 18:30:34 +00: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-09 16:35:36 +00: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 06:41:40 +00: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-28 18:30:34 +00: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-23 17:50:45 +00: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 05:22:53 +00:00
\setindexsubitem{(in module #1)}%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00:00
\index{#1@{\py@idxcode{#1}} (#2module)|textbf}%
\ifpy@UseModuleIndex%
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
1999-03-02 16:17:44 +00:00
\@ifundefined{py@modplat@\py@thismodulekey}{
\write\modindexfile{\protect\indexentry{#1@{\texttt{#1}}}{\thepage}}%
}{\write\modindexfile{\protect\indexentry{#1@{\texttt{#1} %
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
\emph{(\py@platformof[\py@thismodulekey]{})}}}{\thepage}}%
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
1999-03-02 16:17:44 +00: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 06:41:40 +00:00
\fi%
}
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
% *** XXX *** THE NEXT FOUR MACROS ARE NOW OBSOLETE !!! ***
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-03 22:02:19 +00:00
% built-in & Python modules in the main distribution
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
\newcommand{\bimodindex}[1]{\py@modindex{#1}{built-in }%
\typeout{*** MACRO bimodindex IS OBSOLETE -- USE declaremodule INSTEAD!}}
\newcommand{\stmodindex}[1]{\py@modindex{#1}{standard }%
\typeout{*** MACRO stmodindex IS OBSOLETE -- USE declaremodule 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-03 22:02:19 +00:00
% Python & extension modules outside the main distribution
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
\newcommand{\modindex}[1]{\py@modindex{#1}{}%
\typeout{*** MACRO modindex IS OBSOLETE -- USE declaremodule INSTEAD!}}
\newcommand{\exmodindex}[1]{\py@modindex{#1}{extension }%
\typeout{*** MACRO exmodindex IS OBSOLETE -- USE declaremodule 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-03 22:02:19 +00:00
% Additional string for an index entry
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
\newif\ifpy@usingsubitem\py@usingsubitemfalse
\newcommand{\py@indexsubitem}{}
\newcommand{\setindexsubitem}[1]{\renewcommand{\py@indexsubitem}{ #1}%
\py@usingsubitemtrue}
\newcommand{\ttindex}[1]{%
\ifpy@usingsubitem
\index{#1@{\py@idxcode{#1}}\py@indexsubitem}%
\else%
\index{#1@{\py@idxcode{#1}}}%
\fi%
}
\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 06:41:40 +00:00
\newcommand{\withsubitem}[2]{%
\begingroup%
Fix \withsubitem so that it actually works if the only indexing macro in the content body is the \ttindex macro, which seems to match actual usage. Adjust \funcline to restore the "index sub-item" for functions to be " (in module <name>)" instead of " (in <name>)". This is need to match uses of \withsubitem throughout the documentation. (Not ideal, but gets achieves consistency.)
2000-10-30 06:22:22 +00:00
\def\ttindex##1{\index{##1@{\py@idxcode{##1}} #1}}%
#2%
\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 06:41:40 +00:00
\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-03 22:02:19 +00:00
Removed an obsolete hack that's been commented out for a long time. Added comments to various sections.
1998-04-02 22:33:16 +00: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-23 17:50:45 +00:00
% Module synopsis processing -----------------------------------------------
%
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
1999-03-02 16:17:44 +00:00
\newcommand{\py@thisclass}{}
\newcommand{\py@thismodule}{}
\newcommand{\py@thismodulekey}{}
\newcommand{\py@thismoduletype}{}
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
\newcommand{\py@standardIndexModule}[1]{\py@modindex{#1}{standard }}
\newcommand{\py@builtinIndexModule}[1]{\py@modindex{#1}{built-in }}
\newcommand{\py@extensionIndexModule}[1]{\py@modindex{#1}{extension }}
\newcommand{\py@IndexModule}[1]{\py@modindex{#1}{}}
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-23 17:50:45 +00:00
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
1999-03-02 16:17:44 +00:00
\newif\ifpy@HaveModSynopsis \py@HaveModSynopsisfalse
\newif\ifpy@ModSynopsisFileIsOpen \py@ModSynopsisFileIsOpenfalse
\newif\ifpy@HaveModPlatform \py@HaveModPlatformfalse
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-23 17:50:45 +00:00
% \declaremodule[key]{type}{name}
\newcommand{\declaremodule}[3][\py@modulebadkey]{
\py@openModSynopsisFile
\renewcommand{\py@thismoduletype}{#2}
\ifx\py@modulebadkey#1
\renewcommand{\py@thismodulekey}{#3}
\else
\renewcommand{\py@thismodulekey}{#1}
\fi
\declaremodule: Make this more robust. Only attempt to add an index entry based on the module type if the type is known. Otherwise, spit out a warning the the module type parameter was bad and generate a "plain" index entry. Without this, the bad module type was emitted as text. Problem noticed by processing Michael Hudson's docs for bytecodehacks.
1999-05-17 14:47:10 +00:00
\@ifundefined{py@#2IndexModule}{%
\typeout{*** MACRO declaremodule called with unknown module type: `#2'}
\declaremodule: Typo.
1999-05-17 14:57:26 +00:00
\py@IndexModule{#3}%
\declaremodule: Make this more robust. Only attempt to add an index entry based on the module type if the type is known. Otherwise, spit out a warning the the module type parameter was bad and generate a "plain" index entry. Without this, the bad module type was emitted as text. Problem noticed by processing Michael Hudson's docs for bytecodehacks.
1999-05-17 14:47:10 +00:00
}{%
\csname py@#2IndexModule\endcsname{#3}%
}
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-23 17:50:45 +00:00
\label{module-\py@thismodulekey}
}
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
1999-03-02 16:17:44 +00:00
\newif\ifpy@ModPlatformFileIsOpen \py@ModPlatformFileIsOpenfalse
\newcommand{\py@ModPlatformFilename}{\jobname.pla}
\newcommand{\platform}[1]{
\ifpy@ModPlatformFileIsOpen\else
\newwrite\py@ModPlatformFile
\openout\py@ModPlatformFile=\py@ModPlatformFilename
\py@ModPlatformFileIsOpentrue
\fi
}
\InputIfFileExists{\jobname.pla}{}{}
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
\newcommand{\py@platformof}[2][\py@modulebadkey]{%
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
1999-03-02 16:17:44 +00:00
\ifx\py@modulebadkey#1 \def\py@key{#2}%
\else \def\py@key{#1}%
\fi%
\csname py@modplat@\py@key\endcsname%
}
\newcommand{\ignorePlatformAnnotation}[1]{}
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-23 17:50:45 +00:00
\moduleauthor, \sectionauthor: New macros to record attributions; no output.
1998-08-10 18:41:43 +00:00
% \moduleauthor{name}{email}
\newcommand{\moduleauthor}[2]{}
% \sectionauthor{name}{email}
\newcommand{\sectionauthor}[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-23 17:50:45 +00:00
\newcommand{\py@defsynopsis}{Module has no synopsis.}
\newcommand{\py@modulesynopsis}{\py@defsynopsis}
\newcommand{\modulesynopsis}[1]{
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
1999-03-02 16:17:44 +00:00
\py@HaveModSynopsistrue
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-23 17:50:45 +00:00
\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}
Added support for \platform, \platformof, and \ignorePlatformAnnotation.
1999-03-02 16:17:44 +00:00
\long\def\py@writeModPlatformFile#1{%
\protected@write\py@ModPlatformFile%
{\let\label\@gobble \let\index\@gobble \let\glossary\@gobble}%
{\string#1}%
}
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-23 17:50:45 +00:00
\newcommand{\localmoduletable}{
\IfFileExists{\py@ModSynopsisFilename}{
\begin{synopsistable}
\input{\py@ModSynopsisFilename}
\end{synopsistable}
}{}
}
\@ifundefined{pdfoutput}{
\newcommand{\py@ModSynopsisSummary}[4]{\bfcode{#2} & #4\\}
}{
\py@linkToName: New macro to consolidate support for most internal hyperlinking in the PDF version. This also allows many of the macros that do this stuff to be a good bit more readable. Takes the target name and link content as parameters. Use \py@linkToName for all internal links.
1999-01-27 17:37:36 +00:00
\newcommand{\py@ModSynopsisSummary}[4]{%
\py@linkToName{label-module-#1}{\bfcode{#2}} & #4\\
}
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-23 17:50:45 +00:00
}
\newenvironment{synopsistable}{
% key, name, type, synopsis
\let\modulesynopsis=\py@ModSynopsisSummary
\begin{tabular}{ll}
}{
\end{tabular}
}
%
% --------------------------------------------------------------------------
\newcommand{\py@reset}{
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
\py@usingsubitemfalse
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-23 17:50:45 +00:00
\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}}
\textunderscore: Re-define with a width that's more appropriate for the courier font used in Python code. This still isn't *good*, but makes the width about right in most cases. (Exception: it's now a little wide in \var words.)
1998-07-23 21:41:02 +00:00
% This gets the underscores closer to the right width; the only change
% from standard LaTeX is the width specified.
\DeclareTextCommandDefault{\textunderscore}{%
\leavevmode \kern.06em\vbox{\hrule\@width.55em}}
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-23 17:50:45 +00:00
% 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-02 22:33:16 +00: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-03 22:02:19 +00:00
% {fulllineitems} is used in one place in libregex.tex, but is really for
% internal use in this file.
%
\itembreak, \itemjoin: Remove obsolete macros. \itemnewline: Rename to \py@itemnewline, since it's only used internally.
1998-09-09 15:27:43 +00:00
\newcommand{\py@itemnewline}[1]{%
\@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-03 22:02:19 +00:00
\newenvironment{fulllineitems}{
\begin{list}{}{\labelwidth \leftmargin \labelsep 0pt
\rightmargin 0pt \topsep -\parskip \partopsep \parskip
\itemsep -\parsep
\itembreak, \itemjoin: Remove obsolete macros. \itemnewline: Rename to \py@itemnewline, since it's only used internally.
1998-09-09 15:27:43 +00:00
\let\makelabel=\py@itemnewline}
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-03 22:02:19 +00:00
}{\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 05:22:53 +00: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-28 18:30:34 +00: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}}}
%
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
\let\py@badkey=\@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 05:22:53 +00: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-03 22:02:19 +00:00
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
% This can be used when a function or method accepts an varying number
% of arguments, such as by using the *args syntax in the parameter list.
\newcommand{\py@moreargs}{...}
% This can be used when you don't want to document the parameters to a
% function or method, but simply state that it's an alias for
% something else.
\newcommand{\py@unspecified}{...}
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 05:22:53 +00:00
% C functions ------------------------------------------------------------
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
% \begin{cfuncdesc}[refcount]{type}{name}{arglist}
% Note that the [refcount] slot should only be filled in by
% tools/anno-api.py; it pulls the value from the refcounts database.
\newenvironment{cfuncdesc}[4][\py@badkey]{
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 05:22:53 +00:00
\begin{fulllineitems}
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
\item[\code{#2 \bfcode{#3}(\py@varvars{#4})}\index{#3@{\py@idxcode{#3()}}}]
\ifx#1\@undefined\else%
cfuncdesc environment: When processing the optional parameter, don't append any text; let the pre-processor supply all of it.
2000-04-10 18:21:38 +00:00
\emph{Return value: \textbf{#1}.}\\
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
\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-03 22:02:19 +00: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 05:22:53 +00: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-28 18:30:34 +00: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-03 22:02:19 +00: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 05:22:53 +00:00
% C data types -----------------------------------------------------------
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
% \begin{ctypedesc}[index name]{typedef name}
\newenvironment{ctypedesc}[2][\py@badkey]{
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 05:22:53 +00:00
\begin{fulllineitems}
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
\item[\bfcode{#2}%
\ifx#1\@undefined%
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\index{#2@{\py@idxcode{#2}} (C type)}
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
\else%
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\index{#2@{\py@idxcode{#1}} (C type)}
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
\fi]
}{\end{fulllineitems}}
% Funky macros -----------------------------------------------------------
% \begin{csimplemacro}{name}
% -- "simple" because it has no args; NOT for constant definitions!
\newenvironment{csimplemacrodesc}[1]{
\begin{fulllineitems}
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\item[\bfcode{#1}\index{#1@{\py@idxcode{#1}} (macro)}]
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-03 22:02:19 +00: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 05:22:53 +00:00
% simple functions (not methods) -----------------------------------------
% \begin{funcdesc}{name}{args}
Fix \withsubitem so that it actually works if the only indexing macro in the content body is the \ttindex macro, which seems to match actual usage. Adjust \funcline to restore the "index sub-item" for functions to be " (in module <name>)" instead of " (in <name>)". This is need to match uses of \withsubitem throughout the documentation. (Not ideal, but gets achieves consistency.)
2000-10-30 06:22:22 +00:00
\newcommand{\funcline}[2]{%
\funclineni{#1}{#2}%
\index{#1@{\py@idxcode{#1()}} (in module \py@thismodule)}}
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 05:22:53 +00: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-03 22:02:19 +00:00
}{\end{fulllineitems}}
% similar to {funcdesc}, but doesn't add to the index
Hide \varvars from "public" interface.
1998-04-17 02:17:00 +00: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 05:22:53 +00:00
\newenvironment{funcdescni}[2]{
\begin{fulllineitems}
\funclineni{#1}{#2}
}{\end{fulllineitems}}
% classes ----------------------------------------------------------------
% \begin{classdesc}{name}{constructor args}
\newenvironment{classdesc}[2]{
Minor nit that fixes a bunch of indexing: the way the classdesc environment saves the name of the last class described, method and member descriptions were not picking it up correctly. Thus, many index entries were described as "( method)" instead of "(FooClass method)". Multiple entries were collapsed in the index when methods/members from multiple classes share the same name.
1998-11-25 17:13:28 +00:00
% Using \renewcommand doesn't work for this, for unknown reasons:
\global\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 05:22:53 +00:00
\begin{fulllineitems}
Hide \varvars from "public" interface.
1998-04-17 02:17:00 +00:00
\item[\code{\bfcode{#1}(\py@varvars{#2})}%
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\index{#1@{\py@idxcode{#1}} (class in \py@thismodule)}]
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-03 22:02:19 +00:00
}{\end{fulllineitems}}
excclassdesc: New environment. For use in documenting class-based exceptions which have interesting constructor signatures. \pep, \seepep: New macros. Equivalent to \rfc and \seerfc, but referring to the PEP series instead of the Internet RFC series of documents.
2000-09-09 06:01:25 +00:00
% \begin{excclassdesc}{name}{constructor args}
% but indexes as an exception
\newenvironment{excclassdesc}[2]{
% Using \renewcommand doesn't work for this, for unknown reasons:
\global\def\py@thisclass{#1}
\begin{fulllineitems}
\item[\code{\bfcode{#1}(\py@varvars{#2})}%
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\index{#1@{\py@idxcode{#1}} (exception in \py@thismodule)}]
excclassdesc: New environment. For use in documenting class-based exceptions which have interesting constructor signatures. \pep, \seepep: New macros. Equivalent to \rfc and \seerfc, but referring to the PEP series instead of the Internet RFC series of documents.
2000-09-09 06:01:25 +00: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 05:22:53 +00:00
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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 05:22:53 +00:00
% object method ----------------------------------------------------------
% \begin{methoddesc}[classname]{methodname}{args}
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\newcommand{\methodline}[3][\@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 05:22:53 +00:00
\methodlineni{#2}{#3}
\ifx#1\@undefined
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\index{#2@{\py@idxcode{#2()}} (\py@thisclass\ method)}
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 05:22:53 +00:00
\else
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\index{#2@{\py@idxcode{#2()}} (#1 method)}
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 05:22:53 +00:00
\fi
}
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\newenvironment{methoddesc}[3][\@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 05:22:53 +00: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-28 18:30:34 +00:00
\def\py@thisclass{#1}
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\methodline{#2}{#3}
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 05:22:53 +00:00
\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-03 22:02:19 +00: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 05:22:53 +00: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-28 18:30:34 +00:00
\newcommand{\methodlineni}[3][\py@classbadkey]{%
Hide \varvars from "public" interface.
1998-04-17 02:17:00 +00: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-28 18:30:34 +00: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 05:22:53 +00: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-28 18:30:34 +00: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 05:22:53 +00:00
\ifx#1\@undefined
\memberlineni{#2}
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\index{#2@{\py@idxcode{#2}} (\py@thisclass\ attribute)}
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 05:22:53 +00:00
\else
\memberlineni{#2}
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\index{#2@{\py@idxcode{#2}} (#1 attribute)}
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 05:22:53 +00:00
\fi
}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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 05:22:53 +00: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-28 18:30:34 +00:00
\def\py@thisclass{#1}
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\memberline{#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 05:22:53 +00:00
\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-03 22:02:19 +00: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 05:22:53 +00: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-28 18:30:34 +00: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 05:22:53 +00:00
\begin{fulllineitems}
\memberlineni{#2}
}{\end{fulllineitems}}
% For exceptions: --------------------------------------------------------
% \begin{excdesc}{name}
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
% -- for constructor information, use excclassdesc instead
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 05:22:53 +00:00
\newenvironment{excdesc}[1]{
\begin{fulllineitems}
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\item[\bfcode{#1}%
\index{#1@{\py@idxcode{#1}} (exception in \py@thismodule)}]
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 05:22:53 +00:00
}{\end{fulllineitems}}
% Module data or constants: ----------------------------------------------
% \begin{datadesc}{name}
Avoid using \withsubitem and \ttindex internally; they have not proven to be very robust. Using \index directly fixes a lot of entries in the index that had to be specifically read to determine that they had the wrong parenthesized description.
2000-10-29 05:19:16 +00:00
\newcommand{\dataline}[1]{%
\datalineni{#1}\index{#1@{\py@idxcode{#1}} (data in \py@thismodule)}}
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 05:22:53 +00: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-03 22:02:19 +00: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 05:22:53 +00: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-03 22:02:19 +00: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 05:22:53 +00: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-03 22:02:19 +00:00
}{\end{fulllineitems}}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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 15:41:23 +00: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-03 22:02:19 +00: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-28 18:30:34 +00: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-03 22:02:19 +00:00
Removed an obsolete hack that's been commented out for a long time. Added comments to various sections.
1998-04-02 22:33:16 +00: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-03 22:02:19 +00:00
% code is the most difficult one...
Try to make sure \code always uses roman (non-italic) text. Change a 1.6 version number used in a an example in a comment to 2.0.
2000-06-30 17:57:05 +00:00
\newcommand{\code}[1]{\textrm{\@vobeyspaces\@noligs\def\{{\char`\{}\def\}{\char`\}}\def\~{\char`\~}\def\^{\char`\^}\def\e{\char`\\}\def\${\char`\$}\def\#{\char`\#}\def\&{\char`\&}\def\%{\char`\%}%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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-03 22:02:19 +00: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 14:49:25 +00: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-28 18:30:34 +00: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-03 22:02:19 +00: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
Make \var work correctly in math mode.
1998-11-30 14:42:59 +00:00
% with fonts. This also works directly in math mode.
\newcommand{\var}[1]{%
\ifmmode%
\hbox{\normalsize\textrm{\textit{#1\/}}}%
\else%
\normalsize\textrm{\textit{#1\/}}%
\fi%
}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00:00
\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-03 22:02:19 +00: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 06:41:40 +00:00
\newcommand{\file}[1]{`{\small\textsf{#1}}'}
\filenq: Like \file, but don't use single-quotes; this looks better in tables.
1999-04-28 14:59:44 +00:00
\newcommand{\filenq}[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-03 22:02:19 +00: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 05:22:53 +00: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-15 17:50:01 +00: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-03 22:02:19 +00: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-15 17:50:01 +00: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-03 22:02:19 +00: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-28 18:30:34 +00: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-03 22:02:19 +00: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-15 17:50:01 +00: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 06:41:40 +00:00
\newcommand{\email}[1]{{\small\textsf{#1}}}
Added some comments.
1998-04-01 22:20:14 +00: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-03 22:02:19 +00:00
\py@varvars: Merge the various definitions to be the simplist one that does everything needed, and discard the older stuff that is not being used.
2000-08-03 17:38:30 +00:00
\newcommand{\py@varvars}[1]{{%
Merged changes from the 1.5.2p2 release.
2000-04-03 04:19:14 +00:00
{\let\unspecified=\py@unspecified%
\let\moreargs=\py@moreargs%
\py@varvars: Merge the various definitions to be the simplist one that does everything needed, and discard the older stuff that is not being used.
2000-08-03 17:38:30 +00:00
\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-03 22:02:19 +00:00
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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-03 22:02:19 +00:00
\newif\iftexi\texifalse
Define stuff to allow simple HTML-only selection using TeX's \if<foo>...\fi stuff. \ifhtml ...\fi for HTML only.
1998-07-28 21:52:17 +00:00
% This is used to get l2h to put the copyright and abstract on
% a separate HTML page.
\newif\ifhtml\htmlfalse
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-03 22:02:19 +00:00
% 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-28 18:30:34 +00: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 15:41:23 +00:00
Removed an obsolete hack that's been commented out for a long time. Added comments to various sections.
1998-04-02 22:33:16 +00: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-28 18:30:34 +00: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-03 22:02:19 +00: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 06:41:40 +00: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-12 19:37:03 +00: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-03 21:22:31 +00:00
$\!\rfloor\!$%
\regexp{}: Rewritten to look like Freidl's book. Too rip-off? \envvar{}: Bow to font-lock-mode a few times...!
1998-03-12 19:37:03 +00: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 06:41:40 +00: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-12 19:37:03 +00: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 06:41:40 +00:00
}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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 06:41:40 +00: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-03 22:02:19 +00: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-28 18:30:34 +00: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-03 22:02:19 +00:00
\newcommand{\manpage}[2]{{\emph{#1}(#2)}}
excclassdesc: New environment. For use in documenting class-based exceptions which have interesting constructor signatures. \pep, \seepep: New macros. Equivalent to \rfc and \seerfc, but referring to the PEP series instead of the Internet RFC series of documents.
2000-09-09 06:01:25 +00:00
\newcommand{\pep}[1]{PEP #1\index{Python Enhancement Proposals!PEP #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-03 22:02:19 +00:00
\newcommand{\rfc}[1]{RFC #1\index{RFC!RFC #1}}
\newcommand{\program}[1]{\strong{#1}}
\programopt: New macro, used to mark command-line parameters in the text. Looks like \program. \citetitle: New macro, used to mark titles of cited works (like the names of the Python manuals). Accepts & discards an optional parameter that is only used by the HTML formatter. Looks like \emph.
1999-11-09 17:02:11 +00:00
\newcommand{\programopt}[1]{\strong{#1}}
\longprogramopt: New macro.
2000-04-11 18:47:59 +00:00
% Note that \longprogramopt provides the '--'!
\newcommand{\longprogramopt}[1]{\strong{-{}-#1}}
\programopt: New macro, used to mark command-line parameters in the text. Looks like \program. \citetitle: New macro, used to mark titles of cited works (like the names of the Python manuals). Accepts & discards an optional parameter that is only used by the HTML formatter. Looks like \emph.
1999-11-09 17:02:11 +00:00
% cited titles: \citetitle{Title of Work}
% online: \citetitle[url-to-resource]{Title of Work}
\citetitle: Format the title, not the optional URL!
2000-08-17 04:25:59 +00:00
\newcommand{\citetitle}[2][URL]{\emph{#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-03 22:02:19 +00:00
% 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-28 18:30:34 +00: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-03 22:02:19 +00:00
%
\newcommand{\deprecated}[2]{%
\strong{Deprecated since release #1.} #2\par}
\versionadded, \versionchanged: New macros.
1998-07-27 20:32:33 +00:00
% New stuff.
% This should be used to mark things which have been added to the
% development tree but that aren't in the release, but are documented.
% This allows release of documentation that already includes updated
Make \versionadded and \versionchanged less prominant -- neither bold nor a separate paragraph.
1999-02-02 18:02:48 +00:00
% descriptions. Place at end of descriptor environment.
\versionadded, \versionchanged: New macros.
1998-07-27 20:32:33 +00:00
%
% Example:
% \versionadded{1.5.2}
Try to make sure \code always uses roman (non-italic) text. Change a 1.6 version number used in a an example in a comment to 2.0.
2000-06-30 17:57:05 +00:00
% \versionchanged[short explanation]{2.0}
\versionadded, \versionchanged: New macros.
1998-07-27 20:32:33 +00:00
%
\newcommand{\versionadded}[1]{%
Make \versionadded and \versionchanged less prominant -- neither bold nor a separate paragraph.
1999-02-02 18:02:48 +00:00
{ New in version #1. }}
\versionchanged: Added optional parameter for explanation of change.
2000-05-02 17:28:36 +00:00
\newcommand{\versionchanged}[2][\py@badkey]{%
\ifx#1\@undefined%
{ Changed in version #2. }%
\else%
{ Changed in version #2:\ #1. }%
\fi%
}
\versionadded, \versionchanged: New macros.
1998-07-27 20:32:33 +00: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-03 22:02:19 +00:00
\versionadded, \versionchanged: New macros.
1998-07-27 20:32:33 +00:00
% Tables.
%
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-03 22:02:19 +00:00
\newenvironment{tableii}[4]{%
\begin{center}%
\def\lineii##1##2{\csname#2\endcsname{##1}&##2\\}%
Remove second horizontal line below table headers; it is just too distracting.
2000-10-24 02:18:30 +00: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-03 22:02:19 +00:00
}{%
\end{tabular}%
\end{center}%
}
Add new environments: longtableii, longtableiii, and longtableiv, to support long tables which might break across page boundaries. Otherwise identical to tableii, tableiii, and tableiv.
2000-09-21 15:58:02 +00:00
\newenvironment{longtableii}[4]{%
\begin{center}%
\def\lineii##1##2{\csname#2\endcsname{##1}&##2\\}%
Remove second horizontal line below table headers; it is just too distracting.
2000-10-24 02:18:30 +00:00
\begin{longtable}[c]{#1}\strong{#3}&\strong{#4} \\* \hline\endhead%
Add new environments: longtableii, longtableiii, and longtableiv, to support long tables which might break across page boundaries. Otherwise identical to tableii, tableiii, and tableiv.
2000-09-21 15:58:02 +00:00
}{%
\end{longtable}%
\end{center}%
}
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-03 22:02:19 +00:00
\newenvironment{tableiii}[5]{%
\begin{center}%
\def\lineiii##1##2##3{\csname#2\endcsname{##1}&##2&##3\\}%
Add new environments: longtableii, longtableiii, and longtableiv, to support long tables which might break across page boundaries. Otherwise identical to tableii, tableiii, and tableiv.
2000-09-21 15:58:02 +00:00
\begin{tabular}{#1}\strong{#3}&\strong{#4}&\strong{#5} \\%
Remove second horizontal line below table headers; it is just too distracting.
2000-10-24 02:18:30 +00:00
\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-03 22:02:19 +00:00
}{%
\end{tabular}%
\end{center}%
}
Add new environments: longtableii, longtableiii, and longtableiv, to support long tables which might break across page boundaries. Otherwise identical to tableii, tableiii, and tableiv.
2000-09-21 15:58:02 +00:00
\newenvironment{longtableiii}[5]{%
\begin{center}%
\def\lineiii##1##2##3{\csname#2\endcsname{##1}&##2&##3\\}%
\begin{longtable}[c]{#1}\strong{#3}&\strong{#4}&\strong{#5} \\%
Remove second horizontal line below table headers; it is just too distracting.
2000-10-24 02:18:30 +00:00
\hline\endhead%
Add new environments: longtableii, longtableiii, and longtableiv, to support long tables which might break across page boundaries. Otherwise identical to tableii, tableiii, and tableiv.
2000-09-21 15:58:02 +00:00
}{%
\end{longtable}%
\end{center}%
}
{tableiv} environment: Four-column table. \lineiv: Row for {tableiv}.
1998-07-24 22:11:29 +00:00
\newenvironment{tableiv}[6]{%
\begin{center}%
\def\lineiv##1##2##3##4{\csname#2\endcsname{##1}&##2&##3&##4\\}%
\begin{tabular}{#1}\strong{#3}&\strong{#4}&\strong{#5}&\strong{#6} \\%
Remove second horizontal line below table headers; it is just too distracting.
2000-10-24 02:18:30 +00:00
\hline%
{tableiv} environment: Four-column table. \lineiv: Row for {tableiv}.
1998-07-24 22:11:29 +00:00
}{%
\end{tabular}%
\end{center}%
}
Add new environments: longtableii, longtableiii, and longtableiv, to support long tables which might break across page boundaries. Otherwise identical to tableii, tableiii, and tableiv.
2000-09-21 15:58:02 +00:00
\newenvironment{longtableiv}[6]{%
\begin{center}%
\def\lineiv##1##2##3##4{\csname#2\endcsname{##1}&##2&##3&##4\\}%
\begin{longtable}[c]{#1}\strong{#3}&\strong{#4}&\strong{#5}&\strong{#6}%
\\%
Remove second horizontal line below table headers; it is just too distracting.
2000-10-24 02:18:30 +00:00
\hline\endhead%
Add new environments: longtableii, longtableiii, and longtableiv, to support long tables which might break across page boundaries. Otherwise identical to tableii, tableiii, and tableiv.
2000-09-21 15:58:02 +00:00
}{%
\end{longtable}%
\end{center}%
}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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-03 22:02:19 +00:00
% Sample usage:
% \begin{seealso}
Change the look of \seemodule output to fit in better.
1999-05-11 15:42:51 +00:00
% \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-06 21:25:17 +00:00
%
% % A funky case: module name contains '_'; have to supply an optional key
Change the look of \seemodule output to fit in better.
1999-05-11 15:42:51 +00:00
% \seemodule[copyreg]{copy_reg}{Interface constructor registration for
% \module{pickle}.}
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-03 22:02:19 +00:00
% \end{seealso}
Change the look of \seemodule output to fit in better.
1999-05-11 15:42:51 +00:00
%
% Note that the last parameter for \seemodule and \seetext should be complete
% sentences and be terminated with the proper punctuation.
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-03 22:02:19 +00: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 05:29:15 +00:00
\@ifundefined{pdfannotlink}{%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00:00
\newcommand{\py@seemodule}[3][\py@modulebadkey]{%
\seemodule: Fix so that each \seemodule entry gets its own paragraph, so they don't get run together when there's no blank line between them in the source. The HTML conversion already did the right thing. \refmodule: Refer to a module, using a hyperlink in the PDF version. Visually the same as \module.
1999-01-13 17:09:06 +00:00
\par%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00:00
\ifx\py@modulebadkey#1\def\py@modulekey{#2}\else\def\py@modulekey{#1}\fi%
Change the look of \seemodule output to fit in better.
1999-05-11 15:42:51 +00:00
\begin{fulllineitems}
\item[Module \module{#2} (section \ref{module-\py@modulekey}):]
#3
\end{fulllineitems}
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-06 21:25:17 +00:00
}
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00:00
}{\newcommand{\py@seemodule}[3][\py@modulebadkey]{%
\seemodule: Fix so that each \seemodule entry gets its own paragraph, so they don't get run together when there's no blank line between them in the source. The HTML conversion already did the right thing. \refmodule: Refer to a module, using a hyperlink in the PDF version. Visually the same as \module.
1999-01-13 17:09:06 +00:00
\par%
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00:00
\ifx\py@modulebadkey#1\def\py@modulekey{#2}\else\def\py@modulekey{#1}\fi%
Change the look of \seemodule output to fit in better.
1999-05-11 15:42:51 +00:00
\begin{fulllineitems}
\item[\py@linkToName{label-module-\py@modulekey}{Module \module{#2}}
(section \ref{module-\py@modulekey}):]
#3
\end{fulllineitems}
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-06 21:25:17 +00:00
}
}
\seetitle: New macro for building reference list content.
2000-09-12 17:52:33 +00:00
% \seetitle[url]{title}{why it's interesting}
\newcommand{\py@seetitle}[3][\py@modulebadkey]{%
\par
\begin{fulllineitems}
\item[\citetitle{#2}]
\ifx\py@modulebadkey#1\else
\item[{\small{(\url{#1})}}]
\fi
#3
\end{fulllineitems}
}
excclassdesc: New environment. For use in documenting class-based exceptions which have interesting constructor signatures. \pep, \seepep: New macros. Equivalent to \rfc and \seerfc, but referring to the PEP series instead of the Internet RFC series of documents.
2000-09-09 06:01:25 +00:00
% \seepep{number}{title}{why it's interesting}
\newcommand{\py@seepep}[3]{%
\par%
\begin{fulllineitems}
\item[\pep{#1}, ``\emph{#2}'']
#3
\end{fulllineitems}
}
Define \seerfc within the seealso environment.
2000-04-26 18:13:58 +00:00
% \seerfc{number}{title}{why it's interesting}
\newcommand{\py@seerfc}[3]{%
\par%
\begin{fulllineitems}
\item[\rfc{#1}, ``\emph{#2}'']
#3
\end{fulllineitems}
}
Define \seeurl in the seealso environment. Two parameters: url, why.
2000-05-09 16:18:44 +00:00
% \seeurl{url}{why it's interesting}
\newcommand{\py@seeurl}[2]{%
\par%
\begin{fulllineitems}
\item[\url{#1}]
#2
\end{fulllineitems}
}
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-03 22:02:19 +00:00
\newenvironment{seealso}[0]{
Add some (commented out) macros to change the page size to the size of typical published manuals, so people can more easily see what they're really asking for. ;-) Revise the verbatim environment: simple implementation, but more compatible if a document also add \usepackage{verbatim} at the beginning. Declare \modindex, \bimodindex, \exmodindex, and \stmodindex obsolete. These still work just fine, but \declaremodule should be used instead. The obsolete macros will print a warning on standard out.
1999-03-18 16:18:27 +00:00
\par
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-03 22:02:19 +00:00
\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-28 18:30:34 +00:00
\let\seemodule=\py@seemodule
\seetitle: New macro for building reference list content.
2000-09-12 17:52:33 +00:00
\let\seepep=\py@seepep
Define \seerfc within the seealso environment.
2000-04-26 18:13:58 +00:00
\let\seerfc=\py@seerfc
\seetitle: New macro for building reference list content.
2000-09-12 17:52:33 +00:00
\let\seetitle=\py@seetitle
Define \seeurl in the seealso environment. Two parameters: url, why.
2000-05-09 16:18:44 +00:00
\let\seeurl=\py@seeurl
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-03 22:02:19 +00:00
}{\par}
\versionadded, \versionchanged: New macros.
1998-07-27 20:32:33 +00:00
% Allow the Python release number to be specified independently of the
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-03 22:02:19 +00:00
% \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-28 18:30:34 +00: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-03 22:02:19 +00:00
\newcommand{\version}{}
\shortversion, \setshortversion: New markup to help deal with Python having a "real" version number and an abbreviated version number used to create pathnames to the library installation.
2000-09-14 20:11:05 +00:00
\newcommand{\shortversion}{}
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-03 22:02:19 +00:00
\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-28 18:30:34 +00: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-03 22:02:19 +00:00
\renewcommand{\version}{#1}}
\shortversion, \setshortversion: New markup to help deal with Python having a "real" version number and an abbreviated version number used to create pathnames to the library installation.
2000-09-14 20:11:05 +00:00
\newcommand{\setshortversion}[1]{%
\renewcommand{\shortversion}{#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-03 22:02:19 +00:00
% 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-28 18:30:34 +00: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-14 20:56:31 +00: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-03 22:02:19 +00: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 05:29:15 +00:00
\@ifundefined{ChTitleVar}{}{
Fixed \code so word wrapping is allowed. Removed some old stuff. Do better hiding of internal names.
1998-04-28 18:30:34 +00: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-03 22:02:19 +00: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 05:29:15 +00: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-03 22:02:19 +00: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 05:29:15 +00: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-03 22:02:19 +00:00
\DOTI{#1}
}
}
}
Added {definitions} environment, which has \term to define indivual terms. Similar to {description}.
1998-05-20 17:42:17 +00: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}%
\itembreak, \itemjoin: Remove obsolete macros. \itemnewline: Rename to \py@itemnewline, since it's only used internally.
1998-09-09 15:27:43 +00:00
\def\term##1{\item[##1]\mbox{}\\*[0mm]}
Added {definitions} environment, which has \term to define indivual terms. Similar to {description}.
1998-05-20 17:42:17 +00:00
}{%
\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-03 22:02:19 +00:00
% Tell TeX about pathological hyphenation cases:
\hyphenation{Base-HTTP-Re-quest-Hand-ler}