Commit Graph

254 Commits

Author SHA1 Message Date
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
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 2a3ab4fac1 Do better hiding of internal names. 1998-04-28 18:31:50 +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 724473fbe5 Load the options from the pypaper.sty file before setting up the "base class"
for the manual documents.
1998-04-25 04:12:17 +00:00
Fred Drake b4929a794e Paper size / font size configuration file.
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.
1998-04-25 04:11:27 +00:00
Fred Drake 255284b42a Fix problem for the Library Reference where high-numbered sections of
high-numbered chapters took too much space for the section number in the
table of contents.  This makes the section number and title not overlap.
1998-04-20 16:55:14 +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 4d2996d473 Fix version number. 1998-04-13 20:29:45 +00:00
Fred Drake ee60191d1d Lighten up tables. 1998-04-11 20:53:03 +00:00
Fred Drake 02a8e6b600 Update release number and date. 1998-04-09 14:50:47 +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 0a2eb138e7 Style specification for building *.ind from *.idx. This is needed to avoid
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.
1998-04-04 04:18:06 +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 48a16bf6b5 \tableofcontents: Add support for some warning reduction in python.sty. 1998-03-27 05:24:03 +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 97c73c83ed Remove \newif relating to index support; no longer needed. Index control
is now shared and located solely in python.sty.
1998-03-09 16:40:31 +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
Fred Drake ebcb658248 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
Fred Drake dbe132c7ac LaTeX class for Python HOWTO documents. 1998-03-06 21:21:56 +00:00
Fred Drake 55a7cf3ee7 Update documentation release date. 1998-03-05 17:15:26 +00:00
Fred Drake aa54e2db84 Move the change to ending the abstract from python.sty to manual.cls; it
is not appropriate for the howto document class.
1998-03-05 16:41:42 +00:00
Fred Drake 3455edcbc8 Create the module index only if a conditional is true. 1998-03-04 21:56:42 +00:00
Fred Drake 54b03b85f7 Define a new conditional, use this to control creation of module index
data file.
1998-03-04 21:52:33 +00:00
Fred Drake 28f1391051 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
Fred Drake 6659c30b67 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
Fred Drake 5c4e648731 Updated date for interim documentation release. 1998-02-17 15:41:45 +00:00
Fred Drake 8a72a7e344 Use new \authoraddress{}; author's name and address are now separate.
Use new \release{}; this is now separate from \date{}.

Use \email{} instead of \code{} for email addresses.
1998-02-12 03:16:04 +00:00
Fred Drake 0e823d2abd New file. Written by Ulf A. Lindgren <lindgren@ae.chalmers.se>; we have
permission to distribute this without modifications.  This is the latest
version, directly from Ulf.

CTAN:macros/latex/contrib/supported/fncychap/
1998-02-11 23:01:23 +00:00
Fred Drake a28eb3a8cb Mark the URL "ftp://ftp.python.org" with \url{}. 1998-02-11 14:42:06 +00:00
Fred Drake cb42f7c295 Consistency: "{\tt ...}" ==> "\code{...}" 1998-01-20 04:55:47 +00:00
Guido van Rossum 5b943ca1a9 Set the release date for 1.5 (final). 1997-12-30 04:29:30 +00:00
Guido van Rossum d58daff686 Planned release date for 1.5b2. 1997-12-10 18:56:48 +00:00
Guido van Rossum e4a93bc4b3 Fix the release date for 1.5b1 to be Nov. 26 1997-11-18 15:32:15 +00:00
Guido van Rossum 18b0db3b53 Set Oct 10 as the release date. 1997-10-07 14:39:43 +00:00
Guido van Rossum 1574d78550 Date 1997-08-15 02:52:35 +00:00
Fred Drake b065452ebc Bump up the version number. The date still needs to be set (Guido will
have to do that one!), but at least the version will match the release
version.  (1.5a2 got skipped for this.)
1997-07-25 13:14:35 +00:00
Guido van Rossum 1681429ba8 Fix the date. 1997-05-09 02:25:55 +00:00
Guido van Rossum 61f9139125 Added disclaimer. 1996-10-25 15:40:20 +00:00
Guido van Rossum fd1e543316 New date and version number. 1996-10-22 19:00:46 +00:00
Guido van Rossum 93e2ee5753 New version/date 1996-08-23 15:45:37 +00:00
Guido van Rossum e288f9dfa3 New zip code and release; added guido@python.org as alternative email. 1996-07-30 20:45:21 +00:00
Guido van Rossum 164c36b6c3 Change of address; 1.4 beta 1. 1996-06-26 19:19:54 +00:00
Guido van Rossum e38a752d25 new version / date 1995-10-08 01:06:25 +00:00
Guido van Rossum 96628a90c4 typos, layout and other small things 1995-04-10 11:34:00 +00:00
Guido van Rossum 84099363ef version 1.2-proof-3 1995-03-28 13:32:03 +00:00
Guido van Rossum 93487db9bc use {} instead of \ after \copyright 1995-03-28 13:31:51 +00:00
Guido van Rossum 8e6b1aad21 add (c) symbol 1995-03-17 16:01:08 +00:00
Guido van Rossum 46965bca6a new date and version 1995-03-17 16:00:47 +00:00
Guido van Rossum d983cde886 change of address and date 1995-03-15 12:53:31 +00:00
Guido van Rossum 4c14a69ff9 fix version number 1995-02-14 09:46:19 +00:00
Guido van Rossum 31cce97374 copyright.tex: Add 1995 to copyright message.
lib.tex: add libimp; remove bogus warning about lineii.
libmath.tex: document hypot().
libmd5.tex: rename md5.md5() to md5.new().
libposix.tex: document chown().
libposixfile.tex: openfile() instead of fileopen().
libsocket.tex: document gethostbyaddr().
libtypes.tex: add footnote explaining why readline() keeps the newline.
ref3.tex: correct typos, add back*quotes to index.
ref4.tex: don't use \verb inside footnote.
ref5.tex: explain repr() and str() and add them + back*quotes to index.
ref6.tex: correct typo, don't use \verb in footnote.
ref7.tex: don't use \verb in footnote.
1995-01-04 19:17:34 +00:00
Guido van Rossum dd99fd2133 change date to 11 oct 1994-10-11 15:43:38 +00:00
Guido van Rossum 16cd7f9f12 Moved author and date to boilerplate.tex.
Added copyright.tex to all files.
Added descr of check_interval to libsys.tex.
Corrected lotsa typos in tut.tex (thanks to George M. Sipe).
Corrected mktuple (should be newtupleobject) example in ext.tex.
1994-10-06 10:29:26 +00:00