Commit Graph

1465 Commits

Author SHA1 Message Date
Fred Drake 54c3947fbc Updated URL to AMK's regex-to-re HOWTO. 1998-04-09 14:03:00 +00:00
Fred Drake 5406e7071f Added reference to AMK's HOWTO on the topic. 1998-04-09 14:02:02 +00:00
Fred Drake 223395c0a0 Added imaplib. 1998-04-09 13:55:06 +00:00
Fred Drake b8efda01e6 Update URL to the related HOWTO document. 1998-04-09 13:49:18 +00:00
Fred Drake bd400881dd Add section for ni back in, but comment it out. 1998-04-09 11:04:19 +00:00
Fred Drake eac469ca3d Commented out sections on obsolete & Macintosh modules. 1998-04-09 04:51:07 +00:00
Fred Drake f1b72ddf82 Reduced description of the obsolete method Stats.ignore(). 1998-04-09 04:49:56 +00:00
Fred Drake 058068d992 Nearly a complete re-write.
Basically, it now works and produces a nice-looking HTML index.

Shows some promise for extensibility, but still young.  Needs useful comments.
1998-04-08 23:12:51 +00:00
Fred Drake 166abbabf9 Remove option to strip out <tt>...</tt> from index entry text; this is now
left to the buildindex.py script.

Change the field separator used in the index.dat file so utilities like grep
are useful on these files; they can't typically handle NUL bytes.

Protect index entries for environment variables from being handled as
case-insensitive by buildindex.py.
1998-04-08 23:10:54 +00:00
Guido van Rossum ae2be7144d Correct definition of CTIME. 1998-04-08 22:44:25 +00:00
Fred Drake 3f3c25fc03 Set flag to remove <tt>...</tt> markup from the index entries; it just ends up
looking really bad in popular browsers, mostly due to vertical size differences
between the roman and monospaced fonts.
1998-04-08 13:46:24 +00:00
Fred Drake 2764dd33cf Separate sections on anydbm and dumbdbm.
This is the last separation; each module now gets its own section.  This will
be useful in performing conversions.
1998-04-07 22:08:02 +00:00
Fred Drake 8e729ec31a Caught a few more spurious \setindexsubitem macros.... 1998-04-07 22:06:41 +00:00
Fred Drake 5ab5503b8a Use {classdesc} and {memberdesc} where appropriate. 1998-04-07 22:01:33 +00:00
Fred Drake a3f5c32f18 Removed unnecessary \setindexsubitem. 1998-04-07 21:45:52 +00:00
Fred Drake 1ce3604cfd Separate UserDict and UserList documentation into separate sections. 1998-04-07 20:05:33 +00:00
Fred Drake df0e3fcb63 Markup nit. 1998-04-07 20:04:27 +00:00
Fred Drake c708605f4f Added a reference to the discussion in Knuth's "Sorting and Searching", and
noted that the original algorithm produces 4-character results rather than
the 6-character results provided by this module.
1998-04-07 19:58:19 +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 396b827a93 Minor markup nit. 1998-04-07 19:17:27 +00:00
Fred Drake 82d493fb96 Fixed some index entries. 1998-04-07 19:14:17 +00:00
Fred Drake 6b9ff7257b Added entry for wdb. 1998-04-07 19:09:32 +00:00
Fred Drake 810349b685 Fix the formatting of the list of fields in the disassemble() function. 1998-04-07 14:16:41 +00:00
Fred Drake 272fb3aaa4 Added poplib.
Made the module lists look like the other module lists in the documentation.
1998-04-07 14:15:28 +00:00
Fred Drake af370ea254 Move a short paragraph outside the description of ASTType. 1998-04-05 20:23:02 +00:00
Fred Drake 3a0351cf85 Remove all uses of \sectcode; we can now use logical markup everywhere. 1998-04-04 07:23:21 +00:00
Fred Drake e7957184d2 Change \sectcode to logical markup. 1998-04-04 07:17:47 +00:00
Fred Drake fc57619811 Remove obsolete \setindexsubitem macros.
Massive migration to methoddesc and memberdesc.

Logical markup as needed.

A sprinkling of index entries for flavor.
1998-04-04 07:15:02 +00:00
Fred Drake 71c1e502f0 Moved some things around.
Adjusted a couple of the comments to be more informative.

Tell a little bit about what obsolete means now, and how to use obsolete
modules.
1998-04-04 07:03:19 +00:00
Fred Drake 13beac1289 Removed obsolete \setindexsubitem macros. 1998-04-04 06:46:51 +00:00
Fred Drake 85ea68b2a2 Added index entries. 1998-04-04 06:46:05 +00:00
Fred Drake 81acc2e988 Remove obsolete \setindexsubitem macro.
Logical markup, methoddesc, etc.
1998-04-04 06:35:41 +00:00
Fred Drake 61f45c7cb5 Remove obsolete \setindexsubitem macro,
Added index entries.

Markup nits.
1998-04-04 06:31:51 +00:00
Fred Drake b208f128b4 Added index entry. 1998-04-04 06:28:54 +00:00
Fred Drake 82143348aa Remove obsolete \setindexsubitem macro. 1998-04-04 06:28:14 +00:00
Fred Drake 858f787a02 Fix index entry for HTMLParser class. 1998-04-04 06:25:27 +00:00
Fred Drake 41788db3e2 Logical markup.
Index entries.
1998-04-04 06:23:02 +00:00
Fred Drake 9b28fe285d Logical markup. 1998-04-04 06:20:28 +00:00
Fred Drake e14dde2117 Fixed description of similarity between m[name] and m.getheader(name),
reported by Samuel L. Bayer.

Use methoddesc instead of funcdesc, etc.
1998-04-04 06:19:30 +00:00
Fred Drake d275de985a Remove obsolete lines like this:
\setindexsubitem{(in module frobnitz)}

These are no longer needed when present before any other \setindexsubitem{}
in the module section.  The indexsubitem is now set by \bimodindex and
\stmodindex.
1998-04-04 05:56:51 +00:00
Fred Drake 4bde97f190 Add fileinput section under Misc. Services. 1998-04-04 05:50:12 +00:00
Fred Drake ea2f2b9409 Use new index style for makeindex.
Add dependency on libfileinput.tex for lib.dvi.
1998-04-04 04:21:45 +00:00
Fred Drake 35ca0d69e1 Document fileinput. 1998-04-04 04:20:51 +00:00
Fred Drake a8e262b0b2 Use the new index style when running makeindex. 1998-04-04 04:20:21 +00:00
Fred Drake 10ad52e8af Minor cleanliness. 1998-04-04 04:19:20 +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 07bcd99873 Start at updating the template a little bit. There's a lot of stuff that's
just not here yet.
1998-04-03 21:25:16 +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 fe03e81aa5 Removed line of obsolete markup. 1998-04-03 20:35:03 +00:00
Guido van Rossum 791468f731 Some clarifications of out-of-range group indexes/names 1998-04-03 20:07:37 +00:00
Fred Drake 61885924b1 Lots of markup consistency nits.
Logical markup.
1998-04-03 07:16:46 +00:00
Fred Drake 6251c169c6 Small nits.
One more index entry.

Be more specific about an exception raised by range().
1998-04-03 07:15:54 +00:00
Fred Drake 8efde2197b Several minor markup nits. 1998-04-03 07:13:56 +00:00
Fred Drake 9f6aec870e "alternative" is a noun, use "alternate" for the adjective.
Minor nits.
1998-04-03 07:12:52 +00:00
Fred Drake 14c198b146 Talk about some minor nits... 1998-04-03 07:11:32 +00:00
Fred Drake 395e8e4860 Capitalize "Python" for consistency.
Describe UserDict and UserList individually so they aren't too hideous in
the presentation.
1998-04-03 07:10:41 +00:00
Fred Drake 7932a6bf8c Small markup nits. 1998-04-03 07:09:38 +00:00
Fred Drake d59db4f974 Small consistency nits. 1998-04-03 07:06:56 +00:00
Fred Drake 2123774287 Capitalize "Python" for consistency. 1998-04-03 07:06:01 +00:00
Fred Drake e6cedb362c New index entries. 1998-04-03 07:05:16 +00:00
Fred Drake 3f1c4720b5 Use {methoddesc} as appropriate. 1998-04-03 07:04:45 +00:00
Fred Drake 5dabeed4ea Index entries.
Consistency nits.
1998-04-03 07:02:35 +00:00
Fred Drake d0a40cb4cf Added comment crediting Sue Williams with this documentation section (the
ACKS file should be checked....).
1998-04-03 06:56:31 +00:00
Fred Drake 55e3cbd115 Fix one typo.
Add a manpage reference.

Add an index entry.
1998-04-03 06:54:27 +00:00
Fred Drake 74810d5abb Nits.
Add {excdesc} for zlib.error.

Use {methoddesc} where appropriate.
1998-04-03 06:49:26 +00:00
Fred Drake c3486318e0 Add index entry for GzipFile class. 1998-04-03 06:48:16 +00:00
Fred Drake d678cb7a6c Logical markup. 1998-04-03 06:35:54 +00:00
Fred Drake 9fee071ab6 Markup consistency. 1998-04-03 06:21:23 +00:00
Fred Drake 5bfe4850cf Consistency: Don't use module name when referring to functions defined
in the same module.
1998-04-03 06:14:54 +00:00
Fred Drake 2cfc835b7b Minor nits.
Lots of index entries.
1998-04-03 06:12:21 +00:00
Fred Drake 4e6688747c Consistency nits:
Use math-mode pi instead of mixing forms.

Use spaces around relational operators.
1998-04-03 06:04:12 +00:00
Fred Drake 76547c5631 Minor nits.
Moved IGNORECASE & friends to "top level" definitions following compile(),
since there is no other case of nesting in the manual.

Use {memberdesc} and {methoddesc} as appropriate.
1998-04-03 05:59:05 +00:00
Fred Drake dff21a6b93 Minor nits.
Indent code sample to use 4-space indents.
1998-04-03 05:42:10 +00:00
Fred Drake 16a19c46a9 Mention the --help option to tools/mkhowto.sh. 1998-04-03 05:41:38 +00:00
Fred Drake 5bd7fccef9 Minor nits.
Index entry.
1998-04-03 05:31:45 +00:00
Fred Drake a594bafde7 Normalized case rules in section headings.
Moved stuff from "Recent Additions to 1.1" to "More on Defining Functions".
This means there's now a short section on "Defining Functions" immediately
followed by a long section "More on Defining Functions."
1998-04-03 05:16:31 +00:00
Fred Drake 7e9d3148d1 Capitalize "Python" for consistency. 1998-04-03 05:02:28 +00:00
Fred Drake 6a79be8db8 Capitalize "Python" for consistency.
Add an index entry.
1998-04-03 03:47:03 +00:00
Fred Drake 930f134fc9 Logical markup. 1998-04-03 03:44:56 +00:00
Fred Drake dd1f52b0c4 Use {seealso} environment to refer to the struct module.
Document ArrayType.

Use {memberdesc} and {methoddesc} environments, as appropriate.

Minor nits.
1998-04-03 03:35:24 +00:00
Fred Drake 5a52519a6e add_idx(): Restore message to stdout when formatting the general index. 1998-04-02 22:39:05 +00:00
Fred Drake 2b8093ab96 Match python.sty a little better. 1998-04-02 22:33:44 +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 1191692d3d Lots of little nits.
Big fix:  the module index for the Python Library Reference is once more in a
separate file!  Yeah!
1998-04-02 22:30:57 +00:00
Fred Drake 58b2bfd0bf This fixes a (minor) problem discovered by AMK when you don't want any
special markup for the first column of a table using {tableii} or {tableiii}.
In LaTeX, this requires using "textrm" as the formatting function, and this
is needed to remove the bogus "<textrm>" that gets generated otherwise.
There should probably be a more general mapping of specified markup to useful
markup, but that doesn't appear needed at the moment.

do_env_tableii(), do_env_tableiii():  If the markup for the first column is
	\textrm, make it empty.

do_cmd_lineii(), do_cmd_lineiii():  If the markup for the first column is
	empty, don't add markup around the text.
1998-04-02 20:14:04 +00:00
Fred Drake 3a18f3ba38 Hyphenate "built-in" for consistency. 1998-04-02 19:36:25 +00:00
Fred Drake dc40904a32 Hyphenate "built-in" for consistency. 1998-04-02 18:54:54 +00:00
Fred Drake da70ee1fae Use methoddesc and memberdesc, as needed.
Added description of BastionClass, since it is referred to in the Bastion
description as subclassable.
1998-04-02 18:51:30 +00:00
Fred Drake 182bd2d176 Use methoddesc instead of funcdesc to describe the only method. 1998-04-02 18:50:21 +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 0a73d4db51 Removed reference to ni module. 1998-04-02 18:46:44 +00:00
Fred Drake 9ac80cb5bd Removed references to ni. 1998-04-02 18:45:09 +00:00
Fred Drake b401637bd8 Markup nits, index entries. 1998-04-02 18:44:38 +00:00
Fred Drake 674e0fd7a8 Be more specific about where in RFC 1421 to look, since it's not at all
obvious when taking a quick look.

Say "base64" instead of "base-64", since that seems to be how it's referred
to in other RFCs.
1998-04-02 16:24:29 +00:00
Fred Drake b789c70d05 Minor markup nits. 1998-04-02 16:19:15 +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 9e9c89e67c Some nits.
Fixed quoting in third paragraph of the findmatch() description.
1998-04-02 15:53:07 +00:00
Fred Drake ac8f91ada4 Added --split for AMK; control split level of the HTML output. Use --split 1
to create a single HTML file.

Added --help.
1998-04-02 15:37:13 +00:00
Fred Drake a0dbddfcc0 Markup consistency nits.
Fix indentation in code sample in PyArg_ParseTuple() section.

Added one index entry.

Fix include file reference in "Shared Libraries" to print <...> instead of
the upside-down versions of ! and ?.
1998-04-02 06:50:02 +00:00
Fred Drake c6fa34e4d0 Markup consistency & nits.
Fix typo in a C code example:  KeyError is spelled PyExc_KeyError in C; the
"K" is upper case!

Some index entries.

On function signatures, always use parameter names.  Make return types match
what's in the header files.  When the return type is a pointer, always omit
the space between te type name and the "*"; leaving it in results in

	type * func(..)

and having two spaces there just looks terrible.
1998-04-02 06:47:24 +00:00
Guido van Rossum e9625e86b8 AMK's version from the latest pypcre distribution. This clarifies a
few things and adds docs for what happens to escapes in replacement
strings.
1998-04-02 01:32:24 +00:00
Fred Drake 391564f10f Small markup nits, a few grammatical fixes, and a clarification of the binary
mode for files under MacOS.

Updated the traffic figure for c.l.p in the "What Now?" chapter; see comments.
1998-04-01 23:11:56 +00:00
Fred Drake 1a7af3959b Implemented one more special markup item. 1998-04-01 22:44:56 +00:00
Fred Drake 454a4fb018 Added some comments. 1998-04-01 22:20:14 +00:00
Fred Drake 982d91fb51 Change $ICONSERVER to conform to the value AMK & I have discussed for this;
doing this here may prove to not be such a good idea, but we'll see.
1998-03-27 06:53:13 +00:00
Fred Drake 8fe533e6a0 Use the new {methoddesc} and {memberdesc} environments as appropriate. 1998-03-27 05:27:08 +00:00
Fred Drake ec56109a0a First (rough) cut at HTML index generation in Python. Not very pretty, but
easier to work with than the Perl code.
1998-03-27 05:25:43 +00:00
Fred Drake 19e2ce58bf Add support for mapping internal labels used from the index. 1998-03-27 05:24:53 +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 235e6b1428 Some cleanup.
Remove index generation from Perl; use an external script instead.
1998-03-27 05:19:43 +00:00
Fred Drake 8821ecb9cc Added note about weird sequencing of <PRE> & <dl> around {verbatim} sections. 1998-03-27 05:18:45 +00:00
Fred Drake 6355bd43e5 Clarified some comments about the requirements on the TeX installation.
Added brief section on the howto support.
1998-03-27 05:17:21 +00:00
Fred Drake 42b31a5536 Lots and lots and lots.....
Implemented some new features of python.sty for methods & members.

Fixed some bugs.

Cleaned up some perl code and made some basic regular expressions more robust.
1998-03-27 05:16:10 +00:00
Fred Drake f76abb51ef Make sure both hyphens of a long-option show up in the HTML output. 1998-03-27 00:37:40 +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 050be83da9 Python HOWTO template document, with lots of help from AMK. 1998-03-25 15:39:49 +00:00
Fred Drake f6b55106a7 Update. 1998-03-25 14:56:01 +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 f558e3188e Make $MYDIR absolute -- bug reported by AMK. 1998-03-24 17:48:20 +00:00
Fred Drake 2543769ca5 Use "/usr/bin/env perl" for the #! line, and change the -i option to:
use English;
	$INPLACE_EDIT = '';

to get the inplace-editing behavior.
1998-03-19 05:17:49 +00:00
Fred Drake 1125488b24 build_dvi(): Make sure we run latex enough times; this now matches the #
of times pdflatex would be run, which is correct.
1998-03-18 22:06:13 +00:00
Guido van Rossum 685ef4e604 According to Tim Peters, there should be 'print' statements in one
particular example.
1998-03-17 14:37:48 +00:00
Fred Drake cce1090d49 Change "\," to just "," in function signatures. This is easier to maintain,
works better with LaTeX2HTML, and allows some simplification of the python.sty
macros.
1998-03-17 06:33:25 +00:00
Fred Drake c9a4438c16 Coding cleanups.
Fix some small but messy buglets.
1998-03-17 06:29:13 +00:00
Fred Drake 13210ed55f Get the index working at least partway again.
Some small cleanups.
1998-03-17 06:28:05 +00:00
Fred Drake bd2796e972 Update.... 1998-03-17 06:24:10 +00:00
Fred Drake f3aa0e0627 Revert the index stuff to work better with LaTeX2HTML. 1998-03-17 06:23:13 +00:00
Fred Drake 396a7cfb94 Reverting some the index stuff to use tools/newind.py again; this works
better with LaTeX2HTML.

Run pdflatex twice to generate the PDF files, even though LaTeX has already
been run a couple of times.  This ensures that font metrics for the final
run match those for the first run, and seesm to get (somewhat) better
outline results.
1998-03-17 06:22:12 +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 af5c0fc65f Logical markup, consistency. 1998-03-17 02:02:51 +00:00
Fred Drake e603cb1073 Revive newind.py. -sigh- 1998-03-16 16:15:49 +00:00
Fred Drake d98329cdf0 Logical markup.
Convert a {description} list to a {tableii} environment.
1998-03-16 06:38:42 +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 1a855fad30 Markup nits.
Adjusted some index entries.
1998-03-16 05:23:50 +00:00
Fred Drake abdea226dc Adjusted an index entry. 1998-03-16 05:22:08 +00:00
Fred Drake 52405c899a Added an index entry. 1998-03-16 05:21:08 +00:00
Fred Drake 7bf5e0828f Use {classdesc} consistently. 1998-03-16 05:07:04 +00:00
Fred Drake c9808b3af2 Logical markup.
Emphasized title "4Sight User's Guide".
1998-03-15 02:04:59 +00:00
Fred Drake 5f874d618f Markup nits.
Some additional index entries.
1998-03-15 01:59:57 +00:00
Fred Drake ebce37087d Logical markup. 1998-03-14 22:22:14 +00:00
Fred Drake f90dbc9c87 Logical markup. 1998-03-14 21:53:48 +00:00
Fred Drake bd9ded8190 Logical markup.
Replace ugly {description} with a {tableii}, for the what() return values.
1998-03-14 20:09:15 +00:00
Fred Drake 434493b207 Logical markup.
Replace ugly {description} with a {tableii}, for the option descriptions.
1998-03-14 19:47:23 +00:00
Fred Drake a891230688 Logical markup, using {classdesc} as appropriate. 1998-03-14 07:08:02 +00:00
Fred Drake f9e1f658ed Logical markup. 1998-03-14 07:00:41 +00:00
Fred Drake 2e495c93b0 Logical markup, using {classdesc} as appropriate. 1998-03-14 06:48:33 +00:00
Fred Drake be2b6d7f42 Logical markup. 1998-03-14 06:40:34 +00:00
Fred Drake ff79a21119 Logical markup.
Use {classdesc} environments to describe the constructors, and place them
at the top.
1998-03-14 06:30:13 +00:00
Fred Drake cdea8a3c60 Logical markup.
Wrap general Message class description in a {classdesc} instead of nothing at
all.
1998-03-14 06:17:43 +00:00