Commit Graph

119 Commits

Author SHA1 Message Date
Fred Drake d81b1b0ffa Set the date and version to reflect the actual status, not the last
released status.  Has to be changed just before publishing anyway.
1999-11-18 20:57:36 +00:00
Fred Drake 7b8195a209 \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
Fred Drake 919e74ce88 Darn! Forgot to re-target. 1999-07-02 15:27:14 +00:00
Fred Drake d85b5a418a Move the setting for secnumdepth to the document classes; make the numbering
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.
1999-06-29 18:15:59 +00:00
Fred Drake 66823029a4 \declaremodule: Typo. 1999-05-17 14:57:26 +00:00
Fred Drake 5bc8d99bce \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
Fred Drake 84bd6f3b18 Change the look of \seemodule output to fit in better. 1999-05-11 15:42:51 +00:00
Fred Drake 250ba78565 Let's try again: new assertion. 1999-04-28 16:57:01 +00:00
Fred Drake 0a0fd595b3 \filenq: Like \file, but don't use single-quotes; this looks better
in tables.
1999-04-28 14:59:44 +00:00
Fred Drake d960dc81b5 Fix square brackets around optional parameters to macros. 1999-04-23 14:44:53 +00:00
Fred Drake 7bf96ca32d Make an assertion. 1999-04-22 14:16:59 +00:00
Fred Drake 30a535c0f7 Added support for adding environment/macro parameters more cleanly:
\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.
1999-04-22 13:03:49 +00:00
Fred Drake cc10e0469a Just in case a copy of the documentation gets released somehow... 1999-04-13 21:22:46 +00:00
Fred Drake 9b8afdee44 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
Fred Drake 9466b9a10d 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
Fred Drake 1d8f07acbd Markup for documenting LaTeX macros and environments. 1999-03-16 16:08:26 +00:00
Fred Drake 0c275fa856 Added support for \platform, \platformof, and \ignorePlatformAnnotation. 1999-03-02 16:17:44 +00:00
Fred Drake 69d49d6378 Set target. 1999-02-15 15:02:21 +00:00
Fred Drake 2116d983bf Make \versionadded and \versionchanged less prominant -- neither bold
nor a separate paragraph.
1999-02-02 18:02:48 +00:00
Fred Drake aa2aea0e79 \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
Fred Drake 9f253dc3ff \py@modindex: Format the index entry for the module index more like
that used in the "normal" index.  No visual difference, but
	more easily processed by helper scripts.
1999-01-26 19:23:09 +00:00
Fred Drake da94374a86 \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
Fred Drake dd7610cac9 Bump the date. Seems like fun. ;-) 1999-01-12 19:51:03 +00:00
Fred Drake b75d021081 Typo: "TWELV" --> "TWELVE"
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).
1999-01-04 16:15:02 +00:00
Fred Drake ae48aabb10 Update the date. 1998-12-22 18:27:22 +00:00
Fred Drake fa1cceb91f Make \var work correctly in math mode. 1998-11-30 14:42:59 +00:00
Fred Drake 1cbd196f96 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
Fred Drake 803b340888 Update the date. 1998-10-21 14:50:52 +00:00
Fred Drake 7f77db9530 Renamed myindex.ist to something more reasonable. 1998-10-19 21:45:52 +00:00
Fred Drake f9acc59c55 \itembreak,
\itemjoin:  Remove obsolete macros.

\itemnewline:  Rename to \py@itemnewline, since it's only used internally.
1998-09-09 15:27:43 +00:00
Fred Drake 3069c976cf Update date & version number for release 1.5.2a1. 1998-08-12 17:02:50 +00:00
Fred Drake 916f7c1e7c Better check in the date from the last magic-fix-release. ;-) 1998-08-11 13:14:08 +00:00
Fred Drake b75c615389 \moduleauthor,
\sectionauthor:  New macros to record attributions; no output.
1998-08-10 18:41:43 +00:00
Fred Drake 3f7b6fcea0 Ok, we'll try this again: update the release date. ;-( 1998-08-04 17:01:18 +00:00
Fred Drake 1e4973be73 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
Fred Drake 6481ba6251 Update the release date. 1998-07-27 21:10:54 +00:00
Fred Drake af958c7be2 \versionadded,
\versionchanged:  New macros.
1998-07-27 20:32:33 +00:00
Fred Drake 30e52653e1 {tableiv} environment: Four-column table.
\lineiv:  Row for {tableiv}.
1998-07-24 22:11:29 +00:00
Fred Drake c2aa9fbad9 Remove use of the avant package; Helvetica isn't as pretty, but works for
acroread.  The problem this solves is likely dependent on font availability,
so keeping things simple is a good solution.
1998-07-24 15:19:38 +00:00
Fred Drake 889f53d4e0 Reduce the number of levels in the Table of Contents by one, mostly for the
Python Library Reference.  The other manuals do not suffer.

This does not affect HOWTO documents.
1998-07-24 13:54:29 +00:00
Fred Drake 5420f3321d \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
Fred Drake a488f30627 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
Fred Drake 2fcadb2ffb \py@ModSynopsisFilename: New macro; gives names of the .syn file. 1998-07-23 17:36:46 +00:00
Fred Drake 1cc6d53f65 \py@ModSynopsisFilename: New macro; gives names of the "current" .syn file.
\chapter:  Extended, ensures that a pending module synopsis is written out
	and then closes the .syn file for the preceeding chapter.
1998-07-23 17:36:14 +00:00
Fred Drake 5da5a68325 Fix suggested by Lorenzo M. Catucci <lorenzo@argon.roma2.infn.it> to keep the
large letter at the top of each index section with at least the first entry
for that letter.
1998-07-08 21:37:25 +00:00
Fred Drake 8e54abe92e Fix the \kbd definition so it didn't leave the courier face on. 1998-07-01 14:49:25 +00:00
Fred Drake 2d4a54da32 Removed loading of shared font stuff from howto.cls and manual.cls, moving it
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.
1998-06-22 17:50:34 +00:00
Fred Drake 44c413b05e Make the large letter at the top of each section use the sans-serif font,
like any other header.
1998-06-22 17:27:48 +00:00
Fred Drake 3bf7865a20 Added {definitions} environment, which has \term to define indivual terms.
Similar to {description}.
1998-05-20 17:42:17 +00:00
Fred Drake 6df93ef9dd Added definitions for \developer, \developers, \developersaddress.
Ask Guido if you really want to know why.  ;-)
1998-05-14 20:56:31 +00:00