This partially addresses SourceForge bug #114318.
Fix the release number -- this is supposed to be the *Python* release,
not the documentation release! The later is given by the combination of
the Python release number and the date. Add a comment so I can keep it
straight.
\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.
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.
The \\ introduced in the \author in boilerplate.tex broke the PDF
generation because line breaks are not allowed in the "Document Info"
metadata stored in the PDF file. This changes the line break to
a ", " (comma-space) in that context.
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.
for the manual class go one deeper than it previously did (\subsection
entries will now be numbered); no change for howto documents.
This makes it easier to refer precisely to smaller sections using \ref.
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.
\op adds an optional parameter, and \p adds a required parameter.
These are only defined in the context of the parameter list parameter
of the envdesc and macrodesc environments.
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.
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.
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.
Added note at top, since LaTeX style writers like to force name
changes when someone else makes a change to the style. I'm sending a
note to the author reporting the error and asking for an updated
version.
This cannot be distributed in this form. This will be resolved when I
get a response from Ulf Lindgren.
Typo reported by rwolff@noao.edu (Richard Wolff).
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.
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.)
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.
to pypaper.sty.
Added the use of the "avant" package to use AvantGarde for the sans-serif
font instead of the helvetica font loaded by the "times" package.
This is separated so I can build A4 and US Letter sizes without having to
edit files.
Anyone who downloads the source package can also simply edit this file,
which is a lot shorter than the manual.cls file, and easier to find the
appropriate line.
"." 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.
wrapping of long lines, which tools/indfix.py doesn't understand, and needs
to to handle collapsing of entries which can share a common emtry and just
be short entries themselves. We get the added benefit of nicer formatting.
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.
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.
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.
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.
Fred Drake
Greg Ward
Guido van Rossum