Commit Graph

1415 Commits

Author SHA1 Message Date
Fred Drake 0f51fff57e Logical markup. 1998-03-14 06:16:57 +00:00
Fred Drake fc16e78f3c Bring this up to date. Some things still don't work right. 1998-03-12 21:03:26 +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 3b5da76182 Logical markup. 1998-03-12 15:33:05 +00:00
Fred Drake 2dde74c778 Logical markup. 1998-03-12 14:42:23 +00:00
Fred Drake 51375ae07b Use {classdesc} instead of {funcdesc} for HTMLParser.
Clean up index reference to SGMLParser class.
1998-03-12 14:39:09 +00:00
Fred Drake 6ef871ce2f Logical markup.
Lots of nits in both.
1998-03-12 06:52:05 +00:00
Fred Drake 7be8fcb42a Use \envvar{FOO} instead of \code{\$FOO}. 1998-03-12 06:47:48 +00:00
Fred Drake 4e7e11abe5 Use \withsubitem{} for indexing extra-module functions. 1998-03-12 06:46:16 +00:00
Fred Drake 371ecc0c1b Use \withsubitem{} for indexing functions from other modules. This fixes
things in the index.
1998-03-12 06:44:58 +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 6a1eefe535 Logical markup. 1998-03-12 06:04:53 +00:00
Fred Drake a2e9818467 Logical markup.
Improve some index entries.
1998-03-12 05:54:02 +00:00
Fred Drake c71585e069 Logical markup.
Markup consistency.

Removed incorrect \setindexsubitem{}.
1998-03-12 05:33:40 +00:00
Fred Drake 4912beb9d8 Add copyright statement.
Add section on using A4 paper, since that's a common request.
1998-03-11 17:07:35 +00:00
Fred Drake 664b36ff59 *Sigh*
Add a -q option for "quiet" operation.  Nothing gets out (not even stderr,
since that's tossed to stdout for capture in the .how file).  It's a good
idea to use -l to get the log in case there are problems.  Maybe this should
be the default and add a --verbose option to get the stdout?  There's way
too much junk output.
1998-03-11 15:41:21 +00:00
Fred Drake dbc879e949 Allow the user to operate the script in debugging mode (-D), which just does
a "set -x".

Allow keeping a transcript, using -l, in $FILE.how.

Allow keeping of all the temp files created by the process, using -k.
1998-03-11 15:33:44 +00:00
Fred Drake c9f2c14d49 Somewhat more direct way of locating the file, using __FILE__.
Leave find_my_file() around for now, even though we're not using it at the
moment.
1998-03-11 12:08:21 +00:00
Fred Drake bc8ad5bdeb Replace lists of attributes for code and frame objects with a reference to the
Python Reference Manual.
1998-03-11 06:29:59 +00:00
Fred Drake fdbd51db8b Logical markup. 1998-03-11 06:24:46 +00:00
Fred Drake 60ba44750f Logical markup. 1998-03-11 06:18:15 +00:00
Fred Drake 295eaa84b0 Logical markup.
Changed example to use "import posixfile" instead of "from posixfile import *"
since only one symbol was used.
1998-03-11 06:11:37 +00:00
Fred Drake e42f595e5c Logical markup.
Made references to constants in other TERMIOS module explicit in termios
description.

Removed superfluous backslash from example.
1998-03-11 06:00:23 +00:00
Fred Drake db9693ec97 Logical markup. 1998-03-11 05:50:42 +00:00
Fred Drake 75aae9ad89 Logical markup.
Added information on the exception attributes when exceptions are classes.
1998-03-11 05:29:58 +00:00
Fred Drake e2e904f303 Script to format HOWTO documents. Currently only tested on the "Using
Kerberos from Python" HOWTO (this will change shortly, I hope).

This needs to be run from it's location in the Doc/tools directory, and
not via a symlink.  I'll try and fix this in the future.

The help message needs work.
1998-03-10 23:23:05 +00:00
Fred Drake db34a1e2d8 Use the location of the initialization file to augment the style-specific
.perl file search path, rather than making assumptions about the current
directory.
1998-03-10 23:02:57 +00:00
Fred Drake eff1f7622a clean_title(): Remove debugging prints. 1998-03-10 14:33:27 +00:00
Fred Drake ac77b79df6 clean_title(): Clean a little more carefully. Still does funny things with
underscores.  Might this be a fundamental PDF limitation?  Hm, could
	still be a TeX thing.
1998-03-10 14:02:35 +00:00
Fred Drake 45e564dd78 In the source dist., don't include:
- the .cvsignore files; these are only useful in the CVS tree

	- ref/ref.pdf

	- ref/ref.ps

After compression, these last two account for about one-half MB, and half
the tarball.  They can be picked up from the appropriate format dist if
needed.
1998-03-10 14:00:55 +00:00
Fred Drake b30d0164bf Logical markup. 1998-03-10 05:41:08 +00:00
Fred Drake 4ef3329259 Logical markup.
Correct misuse of indexsubutem.

Describe the Queue class using {classdesc}{Queue}, not {funcdesc}{__init__}.
1998-03-10 05:32:30 +00:00
Fred Drake 8aee0e0356 Add some more labels for logical addressing. 1998-03-10 05:21:39 +00:00
Fred Drake d883ca1dcb Logical markup. 1998-03-10 05:20:33 +00:00
Fred Drake 193338afeb Logical markup.
Convert one bulleted list to a {tableii} environment; the other should
probably be converted, but I haven't decided to what.
1998-03-10 04:23:12 +00:00
Fred Drake 2cb1074937 Use a {datadesc} environment to describe errorcode. 1998-03-10 03:53:03 +00:00
Fred Drake 92f31f1260 Logical markup. 1998-03-10 03:38:31 +00:00
Fred Drake a44d74086c Logical markup.
Use {funcdesc} and {excdesc} to describe the module, not just running text.
1998-03-10 03:36:00 +00:00
Fred Drake c4f15af7de Logical markup. small nits. 1998-03-10 03:17:26 +00:00
Fred Drake 520f8bd9b7 Ok, remove dependency on the obsolete tools/modindex.py. 1998-03-09 16:43:54 +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 7d20ffe245 Adjust the index inclusion for the new index support. 1998-03-09 16:39:22 +00:00
Fred Drake 568113a75b Obsolete. 1998-03-09 16:38:32 +00:00
Fred Drake 8bc965785e Adjust index file resetting; just remove the files. The new index support
doesn't fail if the files don't exist.

Use makeindex for the module index.
1998-03-09 16:37:52 +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 8fcad7beb1 Don't generate a \label{} here. 1998-03-09 14:48:00 +00:00
Fred Drake 2eda4ca4df Markup adjustments. 1998-03-08 08:13:53 +00:00
Fred Drake cd14a87c02 Mark the journal title. 1998-03-08 08:02:58 +00:00
Fred Drake 23bc85a8a6 Correct spelling of emdash. 1998-03-08 07:56:48 +00:00
Fred Drake 7ddd043191 Moved solitary "see also" paragraph into a {seealso} environment, and told
why the reader should see also.
1998-03-08 07:44:13 +00:00
Fred Drake 013ad9869e Cleaned up some remaining markup nits.
Andrew:  In description of (?iLmsx), you say it matches the empty string and
sets the corresponding flag.  Is this correct?  Or does it only set the flag?
1998-03-08 07:38:27 +00:00
Fred Drake 8fab8cf211 Logical markup. 1998-03-08 07:14:20 +00:00
Fred Drake b991f8d2e0 Some logical markup. 1998-03-08 07:09:19 +00:00
Fred Drake b55f9d3dfc Small nits.
Don't run into the right margin.
1998-03-08 07:03:27 +00:00
Fred Drake cc444e39e5 Nits. 1998-03-08 06:47:24 +00:00
Fred Drake bccc64020e Logical markup.
Spell emdash right.
1998-03-08 06:41:57 +00:00
Fred Drake 0c2af2bef6 Spell emdash with three hyphens.
Minor nits.
1998-03-08 06:28:00 +00:00
Fred Drake 266b4c1506 Logical markup.
Index entry.
1998-03-08 06:12:10 +00:00
Fred Drake c07ae9f4d2 Some logical markup.
Combine function pairs:  add() and __add__() go together.  This way they
share a single description and use less space.
1998-03-08 05:56:15 +00:00
Fred Drake 0fd72ee369 Logical markup.
Don't prepend the module name when referring to functions or data in the same
module.

Correct the description of "modules".
1998-03-08 05:43:51 +00:00
Fred Drake 580eb26044 Logical markup, a couple of index entries. 1998-03-08 05:41:11 +00:00
Fred Drake 2c954fa411 Remove info targets from "world" and "tarballs".
This is because it's not working again; the optional arg. for \seemodule{}
is not yet supported.
1998-03-07 19:59:45 +00:00
Fred Drake 473a90e831 Allow the user to specify the "biggest" section type from the command line;
default is "chapter".  Use 'python toc2bkm.py -c section' to use with
Python HOWTO documents.
1998-03-07 15:34:50 +00:00
Fred Drake cd05ca9762 Remove unnecessary blank line in long code sample.
Remove a confusing article.
1998-03-07 05:32:08 +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
Guido van Rossum 47e09c43fd Change the date to March 6, 1998.
Migration to Frame 5.5.

Checking in the PDF file.  (This is questionable -- but we check in the
Postscript as well.  Perhaps *both* should be removed from the CVS tree,
now everything is unbundled and we're distributing PS and PDF tarballs?)

Note -- the HTML generation using webmaker is currently broken.  I'll
have to look into generating HTML from Frame...
1998-03-06 21:43:09 +00:00
Fred Drake 1e9be5dbdd Relocating file to Doc/texinputs. 1998-03-06 21:30:41 +00:00
Fred Drake e4837a1671 Revised Makefile to handle the new directories correctly. 1998-03-06 21:29:34 +00:00
Fred Drake 361ee6582a Utility to help create outline information for PDF. 1998-03-06 21:29:00 +00:00
Fred Drake 1546fc3e10 Relocating file to Doc/tools. 1998-03-06 21:28:28 +00:00
Fred Drake 4074896a1e Add reference to the copy_reg module in the See Also: section. 1998-03-06 21:27:14 +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 8f9728b8da Ignore *.bkm files. 1998-03-06 21:22:34 +00:00
Fred Drake dbe132c7ac LaTeX class for Python HOWTO documents. 1998-03-06 21:21:56 +00:00
Fred Drake 6f7398b97b Relocating file to Doc/perl. 1998-03-06 21:20:37 +00:00
Fred Drake b3c9bca242 Misc. revisions to LaTeX2HTML support. 1998-03-06 21:20:08 +00:00
Fred Drake bc7101dff0 Relocated .latex2html-init to l2hinit.perl.
howto.perl is new; supports LaTeX2HTML for HOWTO documents.
1998-03-06 21:18:55 +00:00
Fred Drake bc772f466c Moved & renamed to perl/l2hinit.perl 1998-03-06 21:17:50 +00:00
Fred Drake 2023d38a58 Relocating file to Doc/tools. 1998-03-06 21:16:47 +00:00
Fred Drake 859c797a48 Fix the URL for the regex-to-re HOWTO. 1998-03-06 15:11:30 +00:00
Fred Drake 2135117542 Oops, I *thoughT* I had seen a better address for Andrew.... 1998-03-05 20:06:31 +00:00
Fred Drake 8b8eae3e68 Updated URL & email addresses related to the PCT.
Andrew, plase check to make sure these are the ones you want used and get
back to me; this stuff will be "published" in the near future.
1998-03-05 20:04:23 +00:00
Fred Drake 2c0ef4d625 Corrected citation markup in first paragraph. 1998-03-05 19:33:10 +00:00
Fred Drake 55a7cf3ee7 Update documentation release date. 1998-03-05 17:15:26 +00:00
Fred Drake c113745498 For verbatim text, don't bounce down a size. 1998-03-05 17:00:55 +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 e61d7af4db latex-$(VERSION).tar.gz, tarlatex: Create the source distribution.
clean:  Remove all the generatable tarballs.
1998-03-05 16:37:34 +00:00
Fred Drake 2888bf6cb9 Build a tarball that extracts to Python-$VERSION/Doc/ instead of Doc/,
at Guido's suggestion.
1998-03-05 16:31:22 +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 c7e76c885b Remove item on migration to LaTeX2e document classes. Done. 1998-03-04 17:35:00 +00:00
Fred Drake 85551a38f3 tarballs: Ok, we do support info for the moment, so add that to the tarballs
target.
1998-03-04 16:51:36 +00:00
Fred Drake b1cd7710ef pdf-$(VERSION).tar.gz: If ref/ref.pdf exists, include it in the tarball
along with the others.

html-$(VERSION).tar.gz:  Change the wildcard for picking up GIFs a little
	to avoid changes in what LaTeX2HTML generates.
1998-03-04 16:49:36 +00:00
Fred Drake 71472a5f20 Update URL to get Perl. (Anyone want to re-write LaTeX2HTML in Python? ;)
Add comments about what to do about bugs.
1998-03-04 15:21:02 +00:00
Fred Drake cefcb33d4e Oops, remove some debugging prints. 1998-03-04 06:34:21 +00:00
Fred Drake b98cd39e20 changeit(): Added support for \deprecated{}.
Chunk.__repr__(), main():  Allow Chunk objects to get the buffer, to make the
representation contain text instead of a pair of indexes.  This makes debugging
a little easier.
1998-03-04 06:33:43 +00:00
Fred Drake 34d6f5b0be Preliminary LaTeX2HTML 98.1p1 support. Includes patch from Ross Moore to
get some funky quoting of ']' in \item[...] to work right without having to
do really ugly things to the documents themselves.

There are a lot of things relating to indexing that are commented out;
parts need to be examined and dealt with with respect to changes in
LaTeX2HTML internals.  I'll work with Ross to see what it takes to make
this sort of stuff reasonable.
1998-03-04 05:36:59 +00:00
Fred Drake 2da947af87 Comment out the attempt to get index-related stuff processed in the right
order.  LaTeX2HTML just doesn't do things the same way as LaTeX, and this
wasn't the fix.

Simplify the generated HTML for \file{}.

For \samp{}, use "..." instead of `...'; many fonts make that look pretty
bad.   ;-(
1998-03-04 05:30:49 +00:00
Fred Drake 3fe985fc28 Simplify some of the escaping around ']' in \item[...] markup in light of
a fix to LaTeX2HTML from Ross Moore.  Yeah!
1998-03-04 03:51:42 +00:00
Fred Drake 12577abe2e For each of the l2h??? targets, remove the sed hack that rips out a comma;
it no longer appears to be needed.
1998-03-03 22:39:37 +00:00
Fred Drake 986c100735 Perish Evil Revelry and Lamentation. 1998-03-03 22:27:28 +00:00
Fred Drake 49d9b620a1 Obsolete. 1998-03-03 22:03:08 +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 53525379da Logical markup. 1998-03-03 21:56:15 +00:00
Fred Drake 34eefe59f2 Overhaul. 1998-03-03 21:41:22 +00:00
Fred Drake 40e72f7fbd Fix typo. 1998-03-03 19:37:38 +00:00
Fred Drake 4ad89bfe68 Nit for \refexmodindex{} (reference to extension module). 1998-03-03 18:52:55 +00:00
Fred Drake 791f2ae1fe Simplify the parameters passed to node2label.pl. 1998-03-03 18:05:13 +00:00
Fred Drake d7bb3032c1 Marked reference to the Python Library Reference with \emph{}.
Changed sample module creation of an exception to use PyErr_NewException().

Logical markup.
1998-03-03 17:52:07 +00:00
Fred Drake fcf275e0be Script to create a source distribution. See comments at top. 1998-03-03 17:22:44 +00:00
Fred Drake f611d37647 Ignore tarballs. 1998-03-03 17:14:23 +00:00
Guido van Rossum 9bdc436aaa Added msvcrt. 1998-03-03 02:00:14 +00:00
Fred Drake f7cfb9a7a7 &replace_verbatim,
&replace_verbatim_hook:  Clean up a little, avoid long lines.
1998-03-02 16:43:59 +00:00
Fred Drake 10026de6a3 Make the title page include all the interesting information. 1998-02-27 22:13:13 +00:00
Fred Drake ec9200a2fe &do_cmd_deprecated: New function.
Attempt to get \setindexsubitem{} handled at the right time under LaTeX2HTML
98.1; should still be fine under 97.1*.
1998-02-27 16:56:55 +00:00
Fred Drake 05073e99ab Update. 1998-02-27 16:21:58 +00:00
Fred Drake 92e31944f4 Deprecate the read() and write() methods.
Don't refer to them from the fromfile() and tofile() methods.
1998-02-27 16:21:31 +00:00
Fred Drake 26c73b7841 Added semi-structured support for feature deprecation. 1998-02-27 16:20:30 +00:00
Fred Drake f9fd4e8828 Put all the indexsubitem stuff together.
Support modified verbatim for both LaTeX2HTML 96.1* and 98.1.

Make table column headers bold.
1998-02-27 15:28:45 +00:00
Fred Drake 7186783f56 Make table column headings bold. 1998-02-27 15:20:20 +00:00
Fred Drake 8a13525274 Updates by AMK.
Markup corrected, logical markup.
1998-02-27 15:19:42 +00:00
Fred Drake 4f56f2d646 When "declaring" a module using \*modindex{}, and * doesn't start with "ref",
set up the indexsubitem to "(in module #1)" automatically.  This reduces the
amount of markup needed in the module docs and, more importantly, makes it
o.k. to leave out in simple sections.  \setindexsubitem{} can still be used
to change or reset it.
1998-02-27 14:54:06 +00:00
Fred Drake 8fa5eb8784 Logical markup. 1998-02-27 05:23:37 +00:00
Fred Drake c865eb0587 Nit to prevent empty node in formatted version. 1998-02-27 05:21:36 +00:00
Fred Drake e65bb4e914 Reformulate how the info stuff is ignored. 1998-02-27 05:20:59 +00:00
Fred Drake 4f4e920889 Use a Python script to create "empty" indexes. This solves Guido's
corrupted file problem and avoids the shell escape interpretation
portability problem.  ;-(  See comments at top of newind.py for an
explanation.
1998-02-27 05:18:28 +00:00
Fred Drake bdab730cf3 Update.... 1998-02-27 02:23:15 +00:00
Fred Drake f39ed67fa2 Added \label{}s for logical addressing. 1998-02-26 22:01:23 +00:00
Fred Drake 6c2176eea7 Added \label{}s for logical addressing. 1998-02-26 21:47:54 +00:00
Fred Drake e817930a7b Adjusted to work with the newer version of LaTeX2HTML as well. 1998-02-26 18:49:58 +00:00
Fred Drake 3da06a69b9 Marked references to the other manuals as \emph{} in the abstract.
Added \label{}s for logical addressing.
1998-02-26 18:49:12 +00:00
Guido van Rossum 2474d68548 Fix up description of 'S' format; as Dave Ascher pointed out, it
was ungrammatical to the point of saying the opposite of what it
should say.
1998-02-26 17:07:11 +00:00
Fred Drake 74a11e59a2 Do a little bit more work on a table-driven basis. A little cleanup.
Seems to work at the moment.
1998-02-26 05:52:37 +00:00
Fred Drake 20ee206500 Add support for some of the newer commands, a little cleanup. 1998-02-26 05:49:37 +00:00
Fred Drake c88aa3594f &do_cmd_bcode, &do_cmd_ecode: Removed; no longer used.
&do_cmd_url:  Make sure the tilde gets treated right for the browsers.

&replace_verbatim:  Be sure we always have a leading vertical space.
1998-02-25 17:50:07 +00:00
Fred Drake 628f59814e Make sure the ']' in the content of the \item[] isn't used as the ending ']'. 1998-02-25 15:48:16 +00:00
Fred Drake b92dce38e7 PyFile_FromFile() description: make sure the closing brace for the arguments
comes after the arguments are complete.
1998-02-25 15:40:22 +00:00
Fred Drake 540e13dd1e Derive the name of the modules .ind from the jobname. 1998-02-25 15:31:20 +00:00
Fred Drake 888dfa90f3 Change quoting of the "echo" commands yet again.... why can't shells agree?
Derive the name of the modules .idx from the jobname.
1998-02-25 15:30:47 +00:00
Fred Drake 9cf4bbd630 Make this work better with a4 paper.
Make the table of contents "hot" for PDF output.  No additional packages are
needed.

Move code for \b@code, \e@code into the macros for the verbatim environment
directly since they're not used elsewhere.

Derive the name of the modules .idx from the jobname.

Some clean ups.
1998-02-25 15:29:43 +00:00
Fred Drake d10d0faaa5 Logical markup. 1998-02-24 21:43:05 +00:00
Fred Drake eb9b83104a Add support for hyperref package. This builds the PDF outline, makes the ToC
and index "hot", etc.

Updated a comment about fncychap.

Removed unused minitoc support; I'm not going to use it.  Something that makes
more sense with the Python lib ref can be done with reasonable effort, and can
wait a little while.
1998-02-23 21:37:27 +00:00
Fred Drake 4d3b2a2717 clean: Remove *.out (hyperref's internal files for building outlines for PDF). 1998-02-23 21:34:26 +00:00
Fred Drake f6dabaa57d Ignore hyperref's *.out files (used in building outlines for PDF). 1998-02-23 21:33:43 +00:00
Fred Drake 906f7ea429 Change quoting a little bit to avoid problems building it at CNRI. 1998-02-23 21:32:18 +00:00
Fred Drake 78f6aac73e Clean up some stuff in the {seealso} at the end. This avoids a little nit
(which causes processing to fail) when using the LaTeX hyperref package.
1998-02-23 21:31:24 +00:00
Fred Drake a705da7aa0 Marked the unmarked AttributeError. (AMK)
"Protect the class instance" --> "Protect the object"  It works for anything
with attributes to look up!  (AMK)

Logical markup.
1998-02-23 14:42:00 +00:00
Fred Drake 71f894ad56 "streans" --> "streams" (AMK) 1998-02-23 14:37:40 +00:00
Fred Drake eb72a275b4 Add a period to "Written by James Roskind" 1998-02-22 20:42:11 +00:00
Fred Drake 5ad78f39e7 Changed way *.ind are forced to exist; the files are now reset to contain
an empty index instead of touched.  Note that for modindex.ind, this also
includes "\label{modindex}" so that the modindex.py script doesn't change
the set of labels in the document.

Be more consistent in use of $* in commands.
1998-02-22 19:47:13 +00:00
Guido van Rossum d028ca989a Fixed and extended the example; the original example contained some
bogus code.
1998-02-22 04:41:51 +00:00
Guido van Rossum 3ffb715032 Added two subsections with extra hints and details, even for
extensions and embedding programs.
1998-02-22 04:23:51 +00:00
Fred Drake 1ee492e5d4 The list of module descriptions should be a {description} environment, not
{itemize}!
1998-02-21 06:30:17 +00:00
Fred Drake ed3515d541 Removed two items, correct one spelling error. 1998-02-20 21:55:10 +00:00
Fred Drake 5c19c7bade Tell TeX about a pathological hyphenation case (BaseHTTPRequestHandler). 1998-02-20 06:08:07 +00:00
Fred Drake 2c8aa650a8 Added \label{}s for logical addressing.
Logical markup.
1998-02-20 06:03:52 +00:00
Fred Drake d67e12e65c Added \label{}s for logical addressing. 1998-02-20 05:49:37 +00:00
Fred Drake 7baf3d4ea7 Fixed typo reported by Vladimir Marangozov <Vladimir.Marangozov@imag.fr>. 1998-02-20 00:45:52 +00:00
Fred Drake f7f2e70fd4 Don't ignore makeinfo errors. 1998-02-19 21:40:51 +00:00
Fred Drake 9c7c6bec98 Clean up name->name conversion a little, *make sure it happens in all the
right places*!
1998-02-19 21:40:22 +00:00
Guido van Rossum 505d80b39d Jeff Kunce writes (and he is right):
Also, I just ran across a [possible] minor glitch
in the library documentation for site.py. It says:

"For example, suppose sys.prefix and
sys.exec_prefix are set to `/usr/local'. The
Python 1.5 library is then installed in
`/usr/local/lib/python1.5'. Suppose this has a
subdirectory `/usr/local/python1.5/site-packages'
with three subsubdirectories, `foo', `bar' and
`spam'..."

I think it should be:
"...Suppose this has a subdirectory
`/usr/local/lib/python1.5/site-packages' with..."
          ^^^^
1998-02-19 21:02:32 +00:00
Fred Drake ef146222db Revise comment about the {fulllineitems} environment to be accurate. 1998-02-19 21:02:26 +00:00
Fred Drake 6eb1f6b251 Improve support for logical node names. 1998-02-19 21:00:41 +00:00
Fred Drake 0cf0cfbaa9 Adjusted \label{} for *consistent* logical addressing.
Logical markup.
1998-02-19 20:59:19 +00:00
Fred Drake c83db33781 Added \label{} for logical addressing. 1998-02-19 20:50:52 +00:00
Fred Drake 9168328572 Add missing files to $(LIBFILES).
Run node2label.pl on the HTML versions of all the LaTeX manuals.
1998-02-19 20:46:47 +00:00
Fred Drake c3e4549012 Added \label{} for logical addressing. 1998-02-19 20:22:13 +00:00
Fred Drake 83efb54562 Added \label{} for logical addressing. 1998-02-19 20:07:39 +00:00
Fred Drake af9b6e6607 Added itemized list of Macintosh modules, similar to the other chapters. 1998-02-19 19:45:19 +00:00
Fred Drake cea0e7350d Added \label{} for logical addressing. 1998-02-19 19:40:17 +00:00
Fred Drake 83c1a39c4b Separate chapter and section. 1998-02-19 18:59:48 +00:00
Fred Drake baa04a1c77 Make sure the general index and about nodes get labels assigned, so they get
real names instead of node#.html names.
1998-02-19 18:51:39 +00:00
Fred Drake 1aabe5e4d1 Separate binhex and binuu documentation from binascii. Support better
module addressing in HTML.
1998-02-19 18:29:18 +00:00
Fred Drake 05ce570e8b Remove debugging print.
Support {classdesc} and {fulllineitems} environments.

Support most recent logical markup.
1998-02-19 17:26:48 +00:00
Fred Drake 1f0fdde4fb Bring date into line with the last documentation release. 1998-02-19 16:18:19 +00:00
Fred Drake 526ebb4d97 Work on a temporary file, not the input file. 1998-02-19 16:01:41 +00:00
Fred Drake a799835460 Revised some targets to make better use of make "special" variables, to avoid
repeating file names.

Change lib.texi target to not overwrite the input file; work on a copy.
1998-02-19 16:01:04 +00:00
Fred Drake ef058037a5 Support environments {fulllineitems} and {classdesc}, more of the new logical
markup.

The info generation now works, yet again.
1998-02-19 15:20:30 +00:00
Fred Drake c92740708d Adjust grouping for the "b(reak)" command syntax description. This is
required to get the info generation back in operation, yet again.
1998-02-19 15:18:02 +00:00
Fred Drake 20e01966f5 Logical markup.
Several uses of "\^" could be simplified; this fixes part of the info
generation process.
1998-02-19 15:09:35 +00:00
Fred Drake ea8006a865 \nodename{} must immediately follow \chapter{} to be handled correctly;
adding the \label{} broke that.
1998-02-19 14:00:22 +00:00
Fred Drake 75bfb0f7bb {fulllineitems} is now an environment; use it as such. 1998-02-19 06:32:06 +00:00
Fred Drake 802a202d0d Logical markup.
Changed {funcdesc} to {classdesc}.  This is a test case for {classdesc}.
1998-02-19 06:26:35 +00:00
Fred Drake fb5e54d497 Mostly LaTeX style cleanup.
Use \newenvironment{envname} instead of \newcommand{\foo} &
\newcommand{\endfoo} (or \let\endfoo=...!) wherever reasonable.

Where {*desc} environment helper functions are not needed outside a
single environment definition, inline them.

Ensure that \seemodule{} and \seetext{} are only available within the
{seealso} environment.

Added "()" to the index entries for {funcdesc} and {cfuncdesc} environments.

Added {classdesc} environment which looks like the {funcdesc} environment
but doesn't add the parens in the index entry.
1998-02-19 06:23:06 +00:00
Fred Drake c02fbe52b2 breakable_re: Fix the RE so that module definition entries don't prevent
combining.
1998-02-19 06:05:29 +00:00
Guido van Rossum a73033fcc2 Feature added by Bill van Melle: when no timezone is present, assume
local time -- that's better than failure.
1998-02-19 00:28:58 +00:00
Fred Drake ce0e175554 &do_cmd_url,
&do_cmd_email:  Adjust to use a font similar to that used in the printed
	representation.

&my_module_index_helper:  Change to be only used for defining markup.  Don't
	prepend an <A NAME=...> to the result; use the containing page as
	the module target for the index.

&ref_module_index_helper:  New function.  Used only for references to modules
	described elsewhere.  Generate the right target.

&init_myformat:  Set the anchor_mark to an empty string; this avoids junky
	"&#160;"'s in the text, which could really screw up vertical spacing
	when that's all that's in a paragraph.

&do_cmd_seemodule:  Insert markup to jump right to the referred-to module.
1998-02-18 22:45:53 +00:00
Guido van Rossum 026d9626df Consistent spelling: "time zone" -> "timezone".
Clarify that the sign of the timezone offset returned by
parsedate_tz() is the opposite of time.timezone.
1998-02-18 21:47:29 +00:00
Fred Drake 4186cd3df2 Add named destinations for \label{} in the PDF.
Fix \email{} so it doesn't rely on \url{}.
1998-02-18 17:21:09 +00:00
Fred Drake 8ff4b8b05b Add new files from the Mac user interface breakup. 1998-02-18 17:19:53 +00:00
Fred Drake b4efb6c8cb Separate Mac user interface modules into separate files, to better support
bookmarkable module sections in the HTML.
1998-02-18 17:19:11 +00:00
Jeremy Hylton 9caa110141 assure a consistent assignment for nodes with multiple labels 1998-02-18 16:10:22 +00:00
Fred Drake b866020f66 Added a number of items.... 1998-02-18 16:03:43 +00:00
Fred Drake dd94676865 Added libsymbol.tex, libtoken.tex to dependencies for the libref.
New targets:  ???-all, for each document.  This creates all formats of the
named document (DVI, HTML, PDF, PS).

l2hlib:  Added commands to translate node*.html to use the \label{} stuff,
	as supported by Jeremy's node2html.pl.  This gives us mostly
	bookmarkable nodes.
1998-02-18 16:02:14 +00:00
Fred Drake b0df567897 Separate the parse, symbol, and token documentation into separate files. 1998-02-18 15:59:13 +00:00
Fred Drake 710c035c05 Added \label{} for logical addressing. 1998-02-18 15:47:17 +00:00
Fred Drake 31ecd50d02 Added \label{} for logical addressing. 1998-02-18 15:40:11 +00:00
Fred Drake af0bfbee46 Added \label{} for logical addressing.
Logical markup.
1998-02-18 15:39:15 +00:00
Fred Drake 1f3ab1cb6c Added \label{} for logical addressing. 1998-02-18 15:22:08 +00:00
Fred Drake 55fca54ebb Added \label{} for logical addressing.
Logical markup.
1998-02-18 15:21:26 +00:00
Fred Drake 12918af83e Added \label{} for logical addressing. 1998-02-18 15:10:24 +00:00
Fred Drake ddf03bf8e1 Added \label{} for logical addressing.
Logical markup.
1998-02-18 15:05:47 +00:00
Fred Drake 9acafa8bb5 Don't make backups.
Use "mv" instead of "ln -s" to install the new names.
1998-02-18 14:52:24 +00:00
Fred Drake 0c17d661e0 \url{}: For pdflatex, make the link active & make it blue. If anyone figures
out how to make the border go away completely, please let me know!
1998-02-18 14:24:19 +00:00
Guido van Rossum 1931c0c961 Add normpath(). Clarify normcase(). (Note -- this doc section
probably needs more work, describing new functions and the differences
between unix/mac/win.
1998-02-18 14:00:05 +00:00
Jeremy Hylton daa2d5d4ea Patch HREFs in html files, replacing nodeXXX.html with label.html. 1998-02-18 13:53:48 +00:00
Guido van Rossum 8cf94e608e Add mktime_tz(). Add () to a function reference in parsedate_tz(). 1998-02-18 05:09:14 +00:00
Fred Drake a219e7976f main(): Include a \label{modindex} in the output so latex won't let us re-use
the name elsewhere.  This is useful for the logical filenames project,
	since the "modindex" label is hardcoded into .latex2html-init.
1998-02-17 23:13:19 +00:00
Fred Drake 45a40930e7 &do_cmd_textohtmlmoduleindex: Get the modindex key added to the label->node
association.
1998-02-17 23:11:40 +00:00
Fred Drake 57b5e42c0c Added \label{} for logical addressing. 1998-02-17 22:30:13 +00:00
Fred Drake e2f194b57d Use \manpage{} markup for referencing a UNIX man page.
Added index entry for DES cipher.
1998-02-17 22:24:45 +00:00
Fred Drake 8ecc705ba4 Added comment explaining the only warning produced by makeindex, since there
doesn't appear to be a way to fix that's reasonable.
1998-02-17 20:31:08 +00:00
Fred Drake 326e19700f Remove Macintosh ligatures item. Solution: Update your Times fonts.
Added native package semantics note.
1998-02-17 20:14:12 +00:00
Fred Drake 81f4b663b4 Started a TODO list with the latest bug reports.
In part prompted by questions from AMK.
1998-02-17 19:01:02 +00:00
Fred Drake 5fd242b085 Clarified comment about the PS generation when using the all-pdf target. 1998-02-17 18:20:30 +00:00
Fred Drake 30d17825ac Add magic to make PDF generation use maximal compression. 1998-02-17 15:56:55 +00:00
Fred Drake ddae414cb5 Added all-formats target: use this to get both PDF and PS files; using the
"alternate" rules for PDF generation doesn't ensure the PS files get
generated since distiller isn't used.

Switch to the "alternate" rules for PDF generation; this is starting to make
more sense than the distiller-based rule, and requires only free software.
I'm also confident it's working well (meaning I paged through all four
pdflatex-generated PDF files).
1998-02-17 15:45:25 +00:00
Fred Drake 5c4e648731 Updated date for interim documentation release. 1998-02-17 15:41:45 +00:00
Fred Drake 5374045271 If generating PDF, include the author and title information in acroread's
"File->General Info" dialog.
1998-02-17 15:13:01 +00:00
Fred Drake e8b46132e2 Massive changes. Fewer warnings from the Python Library Reference. Still
messy, but the thing seems to be working without bombing completely today.
Formatting lib.texi with TeX doesn't seem to do too badly, either!

Info formatting isn't quite there; that might just have to disappear this
time.
1998-02-17 05:54:46 +00:00
Fred Drake 7154d382c3 Update indexsubitem for file attributes correctly. 1998-02-17 02:11:21 +00:00
Fred Drake a200faac55 \nodename{} must appear immediately after \section{} for the info conversion. 1998-02-17 02:10:41 +00:00
Fred Drake 06e1664c77 Indent {verbatim} environments like in the printed version. 1998-02-16 22:50:06 +00:00
Fred Drake 76183c0ed8 Move optional package inclusions to the top, to make them easier to find.
Code elsewhere in this file tests for the inclusion of the package and does
not need to be uncommented.  Comments explain what they do and how to
disable them.

Added support for the optional "fancyhdr" package.  If used, page footers
include chapter information on the left and section information on the right.

Both optional packages, "fancyhdr" and "times", are enabled by default.  We
may want to disable them before shipping, but I'm not completely convinced.
(How many installations format their own documentation?)
1998-02-16 22:30:10 +00:00
Fred Drake fac431e7d5 NNTP.xgtitle() description: Add a missing ")" from the response value
description.

NNTP.xover() description:  Adjust some markup for consistency.
1998-02-16 21:57:37 +00:00
Fred Drake 009ab92c12 Made the area for wildcards in the description wider, so we don't invade the
left margin.
1998-02-16 21:37:58 +00:00
Fred Drake 75fc045bf5 Fixed formatting of the program name for crypt.
Added another index entry.
1998-02-16 21:36:57 +00:00
Fred Drake ad51192a4f In the example file name, use the current Python version, not a hardcoded
value.

Use logical markup.
1998-02-16 21:25:53 +00:00
Fred Drake 2705e801d9 For the lists which describe the regular expression syntax, increase the
width available so we don't run into the left page margin.
1998-02-16 21:21:13 +00:00
Fred Drake b0f77d65db Use \version to get the current Python version number, where possible. This
can only be done in the running text, and not in {verbatim} environments.
1998-02-16 20:58:58 +00:00
Fred Drake 7506298dfb Mark up filename extensions consistently.
Logical markup.
1998-02-16 20:40:37 +00:00
Fred Drake 3b26eeddea Added rule to generate the PDF format using pdflatex. Commented out since
this is still experimental software.  See the comment.
1998-02-16 17:06:10 +00:00
Fred Drake 9d20ac36a9 Removed various "(New in 1.5a?!)" constructs. Other notes pertaining to
versioning remain intact.
1998-02-16 15:27:08 +00:00
Fred Drake 70d289d04b Break up some long lines in the generated header & footer. 1998-02-16 15:23:11 +00:00
Fred Drake 1aedbd8b0a "--" --> "---" in two places. 1998-02-16 14:47:27 +00:00
Fred Drake 4de05a90be Place C typedef for Py_complex after brief description, to be more consistent
with the other example of a structure description (struct _frozen).

Added index entries for the modules referenced in the document.
1998-02-16 14:25:26 +00:00
Fred Drake 53fb7723ee Added index enties for the Python built-in functions, where appropriate. 1998-02-16 06:23:20 +00:00
Fred Drake e058b4f124 Lots of nitty-gritty stuff:
Use \emph{} when referring to title of any of the Python manuals, like is
done in the other manuals.

In some places, use \emph{} or \dfn{} instead of ``...''.

Use \samp{} instead of \code{} when marking identifier prefixes.

Use logical markup wherever it made sense.

Fixed a bunch of typos.

In several places, use "---" instead of "--" to get the emdash.

Start sentences with capital letters and end them with periods, as needed.

"it's" --> "its" in many places:  "it's" it *always* a contraction of "it is",
and "its" should always be used for the possessive.

"don't" --> "doesn't"

"should discards any" --> "should discard any"

In C function descriptions, use \var{} to mark parameters in the running
text instead of \code{}.  This matches usage in the other manauls better,
and is more consistent with the formatting of the function signatures.
Lots of little changes to implement this.

Lots of fixups needed due to appearant heavy cut-&-paste in the orignal
document.

Mention that the exception objects may be either classes or strings,
depending on the use of -X; they were unequivocally stated to be strings
in the section "Standard Exceptions".

"mkvalue()" --> "Py_BuildValue()"

Description of PyNumber_Power() indicates that the third value is option,
but not how to indicate that it was omitted.  Clarified.

Explain the behavior of PyString_FromStringAndSize() if the buffer is NULL.

Explain the Py_complex structure a little (tell what it's used for) and use
a {verbatim} environment for the structure definition itself.

Fix explanation of PyFile_SoftSpace().

Update the example version string to 1.5.

Combined the sections on defining new object types.
1998-02-16 06:15:35 +00:00
Fred Drake f1a4150b70 Make sure indexes begin on odd-numbered pages. 1998-02-16 05:30:27 +00:00
Fred Drake b666c15c4a Normalization of markup. 1998-02-13 22:22:36 +00:00
Fred Drake 6e99adb1c9 Don't capitalize identifiers at the beginning of the sentence; re-write to
place them elsewhere so they get the right capitalization.
1998-02-13 22:17:21 +00:00
Fred Drake 01dbb88831 Fix some markup so that the right characters are printed.
"EOF" --> "\EOF{}"
1998-02-13 22:13:07 +00:00
Fred Drake 4a1efb63a9 Capitalize subsection title. 1998-02-13 22:10:21 +00:00
Fred Drake ab875b9a32 Make one paragraph wrap a little better. 1998-02-13 22:07:33 +00:00
Fred Drake a19bb9bbcf Capitalize first word in sentences, use periods at end. 1998-02-13 21:57:33 +00:00
Fred Drake 86b5dcec86 Change {datadesc} environments with empty descriptions to \dataline{}s; this
removes extra vertical space from the list of names, and makes the display
more similar to that used in the socket module, where several constants share
a description.
1998-02-13 21:55:21 +00:00
Fred Drake fc931ecf92 In description of sound_similar(), break up the markup for long
\code{} at each embedded space, so that the words will wrap.  This keeps
it from being too ugly.
1998-02-13 21:49:12 +00:00
Fred Drake 315b5d8a7f In description of __import__, second paragraph, break up the markup for long
\code{} at each embedded space, so that the words will wrap.  This keeps it
from running off the side of the page, and is only slightly weird.
1998-02-13 21:26:35 +00:00