Commit Graph

55 Commits

Author SHA1 Message Date
Fred Drake ba82878a3b Merged changes from the 1.5.2p2 release. 2000-04-03 04:19:14 +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 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 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 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 0c275fa856 Added support for \platform, \platformof, and \ignorePlatformAnnotation. 1999-03-02 16:17:44 +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 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 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 b75c615389 \moduleauthor,
\sectionauthor:  New macros to record attributions; no output.
1998-08-10 18:41:43 +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 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 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 8e54abe92e Fix the \kbd definition so it didn't leave the courier face on. 1998-07-01 14:49:25 +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
Fred Drake ba1700c7bb Set the right page size in the PDF output. 1998-05-11 20:42:54 +00:00
Fred Drake 0cabff904f \itembreak,
\itemjoin,
\kwindex:  Revived definitions to support the Python Reference Manual.
1998-05-06 19:36:01 +00:00
Fred Drake 24340ea583 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
Fred Drake d579ed8239 Shift (re-)definition of \theindex to the document classes so that it doesn't
break HOWTO documents.
1998-04-17 02:45:41 +00:00
Fred Drake 300775d222 Hide \varvars from "public" interface. 1998-04-17 02:17:00 +00:00
Fred Drake a2c2a836d7 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
Fred Drake a88d681255 Change the form of the name given to each page of the PDF from "page.%d" to
"page.%dx"; this works around an acroread bug that causes targets not to be
recognized if their name is a prefix of another target in the file.
1998-04-15 14:53:28 +00:00
Fred Drake ee60191d1d Lighten up tables. 1998-04-11 20:53:03 +00:00
Fred Drake 41565f66b6 Data attributes of objects should not be indexed with trailing parentheses! 1998-04-07 19:32:40 +00:00
Fred Drake 47cfd03dff 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
Fred Drake 537149707b 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
Fred Drake 2351c80747 \bifuncindex: Fix so entries combine correctly with those of the built-in
functions section.
1998-04-02 18:48:32 +00:00
Fred Drake f14e2f8a04 Fix one remaining internal use of \code{} that could use the simpler form. 1998-04-02 16:09:02 +00:00
Fred Drake 454a4fb018 Added some comments. 1998-04-01 22:20:14 +00:00
Fred Drake 6cb71491de 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
Fred Drake 55730316c9 Don't use the fncychap package for HOWTO documents; appendices break. Still
use them for manuals.
1998-03-25 15:41:23 +00:00
Fred Drake c0b2e453ae 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
Fred Drake a2be9881f0 Reverting some of the index stuff to work with LaTeX2HTML better. 1998-03-17 06:20:04 +00:00
Fred Drake ae25be2e4d {classdesc} environment: Index as "Foo (class in foolib)" instead of
"Foo (in module foolib)".  Is now independent of indexsubitem.
1998-03-16 05:26:10 +00:00
Fred Drake 94fac130bb \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
Fred Drake 0ee9f727c9 \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
Fred Drake b390daf704 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
Fred Drake 1c8d0e0579 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
Fred Drake 6663b22198 Oops; file copy error somewhere along the way.... 1998-03-06 22:33:06 +00:00