Commit Graph

788 Commits

Author SHA1 Message Date
Fred Drake 616b23b2e4 img_tag(), top_navigation_panel(): Generate markup the same case as other
functions in this file.
1997-12-18 14:16:46 +00:00
Fred Drake 8da9e6a8a0 make_mod_index_entry(): Generate markup the same case as other functions in
this file.
1997-12-18 14:14:16 +00:00
Fred Drake 304474f315 Make the word "Module" in the section header start with an upper-case "M".
Include "()" when naming functions in the text.

Fixed reference to the built-in str() function.

Format constant names using \code{}.
1997-12-17 15:30:07 +00:00
Fred Drake 20417b7afb Make the word "Module" in the section header start with an upper-case "M".
Added index entry for RFC 1014.
1997-12-17 14:17:35 +00:00
Fred Drake b78da332fa Make the word "Module" in the section header start with an upper-case "M"
for all three modules described here.

Added a \label{} for each of the two modules missing it.
1997-12-17 14:12:31 +00:00
Fred Drake a47bce54a6 Make the word "Module" in the section header start with an upper-case "M".
Added a \label{} for the module.

Fixed one minor grammatical nit:  use plural pronoun to refer to a pair of
referents.

Include "()" when naming functions in the text.
1997-12-17 14:11:18 +00:00
Fred Drake 9c483191d6 Make the word "Module" in the section header start with an upper-case "M". 1997-12-17 14:08:01 +00:00
Fred Drake 2303d31cc0 Make the word "Module" in the section header start with an upper-case "M".
Added a \label{} for the module.

Changed one \code{} to a \samp{}.
1997-12-17 14:07:25 +00:00
Fred Drake bcda484bc4 Make the word "Module" in the section header start with an upper-case "M". 1997-12-17 14:01:52 +00:00
Fred Drake 36499b8e62 Make the word "Module" in the section header start with an upper-case "M"
for both modules documented here.
1997-12-17 14:01:31 +00:00
Fred Drake 14f8521952 Make the word "Module" in the section header start with an upper-case "M". 1997-12-17 13:52:04 +00:00
Fred Drake 7372e5793d Make the word "Module" in the section header start with an upper-case "M".
Minor grammatical nit.
1997-12-17 13:51:08 +00:00
Fred Drake 045c7fc9b9 Make the word "Module" in the section header start with an upper-case "M".
Remove the leading comment declaring this to be a template for module
documentation.
1997-12-17 13:47:39 +00:00
Fred Drake 6f070108df Make the word "Module" in the section header start with an upper-case "M"
for both modules documented here.
1997-12-17 13:45:50 +00:00
Fred Drake dccd9dbf52 Make the word "Module" in the section header start with an upper-case "M"
for both built-in and standard modules.  They were different.
1997-12-17 13:44:37 +00:00
Fred Drake 819b789f36 gen_index_id(): New function. Construct an index key such that the sort
is stable and the form is only defined in one place, since we do
	some fancy footwork with the keys to separate the defining instance
	of a module reference from other references in the HTML index.

make_index_entry():  Override the standard definition to use get_index_id().

make_str_index_entry():  Moved to myformat.perl; only needed there.

index_key_eq():  Override the standard definition.  Add key transforms to
	remove extra junk from the end of the keys; it was only there to
	maintain ordering.

clean_key():  Remove key transform no longer needed at this stage, because
	keeping it makes the sort unstable.

add_idx():  Add key transforms to undo the mess we do to separate a module's
	defining and reference entries.  Don't make the text bold.
1997-12-17 03:08:27 +00:00
Fred Drake 84818d7aad make_mod_index_entry(): New function. Create the index entry for a module.
my_module_index_helper():  Do the actual work for \*modindex{}, including
	both the defining and reference forms.

make_str_index_entry():  Moved from .latex2html-init; it's really specific
	to the presentation.
1997-12-17 02:59:39 +00:00
Guido van Rossum e4eb2231fd AMK's latest 1997-12-17 00:23:39 +00:00
Fred Drake 72df9bcba2 do_cmd_refbimodindex(), do_cmd_refstmodindex(): New functions, handle the
reference form of \bimodindex{} and \stmodindex{}.

my_parword_index_helper():  Fixed to include proper anchor in result text.
1997-12-16 21:13:20 +00:00
Fred Drake 5ca9033062 Index the RFC822 reference (some other RFC references were alreaddy indexed).
Add index reference to mailbox module; also remove comment that it's
undocumented (it has been).
1997-12-16 15:19:47 +00:00
Fred Drake 8e0799817e The \indexsubitem definition for the actual exceptions did not actually
change the \indexsubitem value; fixed.
1997-12-16 14:54:32 +00:00
Fred Drake 9d2f7d414d Oops, ".pythonrc.py" should *always* be marked with \file{}; one occurrance
escaped with \var{}.
1997-12-16 14:43:37 +00:00
Fred Drake 5493205ba4 Module names should be in \code{}.
Added index reference to site module.
1997-12-16 14:41:36 +00:00
Fred Drake 0514ce126a Descriptions for delitem(), __delitem__(): These delete a value, not set it.
Lots of little nits:  parameter names in text should be \var{}, etc.
1997-12-16 14:29:48 +00:00
Fred Drake 4f496cc5b1 Fixed index module reference. 1997-12-16 04:08:24 +00:00
Fred Drake 90f2e5e202 Added a named target for referencing. 1997-12-16 04:06:33 +00:00
Fred Drake bfc28bcfdf Used a named target to form the reference to the Built-in Functions section. 1997-12-16 04:06:06 +00:00
Fred Drake 6d2bdb682d Fixed index module reference.
Changed references to regex/regsub modules to point to re.
1997-12-16 04:04:25 +00:00
Fred Drake 3aa289537c Fixed index references to modules. (This is *not* the spam module!) 1997-12-16 00:02:01 +00:00
Fred Drake e14388c4b8 Fixed index references to modules. 1997-12-15 22:28:38 +00:00
Fred Drake 19d58273c5 Fixed index references to modules.
Made references to files use \file{} instead of \code{}.
1997-12-15 22:23:52 +00:00
Fred Drake 356818eccb Fixed index references to modules. 1997-12-15 22:20:33 +00:00
Fred Drake 8274f32a6d Fixed index references to modules.
Changed regex reference to re.
1997-12-15 22:19:46 +00:00
Fred Drake f5eaa2efb8 Fixed index references to modules.
Added new index entry for mimetools module.
1997-12-15 22:13:50 +00:00
Fred Drake a51f5a48e5 Fixed index references to modules. 1997-12-15 22:09:42 +00:00
Fred Drake 4af1814858 \refmodindex{}: New macro, used to make an index reference to a module which
is neither standard nor built-in.  (Used for sitecustomize entry.)
1997-12-15 22:08:14 +00:00
Fred Drake 9ab2b2ec5b Fixed index references to modules.
Placed references closer to usage.
1997-12-15 21:59:33 +00:00
Fred Drake 54820dc8e4 Fixed index references to modules. 1997-12-15 21:56:05 +00:00
Fred Drake 6206394a4b Changed illegal \stmodindex{} to \refstmodindex{}, added index reference
to the stat module.
1997-12-15 21:42:51 +00:00
Fred Drake 8a528bd10d Added some module references to the index. 1997-12-15 21:40:15 +00:00
Fred Drake 207e57b617 Added definitions of \refbimodindex{} and \refstmodindex{}, which should be
used to add index references for built-in and standard modules, respectively.

Modified \bimodindex{} and \stmodindex{} to make the page number bold, to
allow the defining instance of a module to stand out in the index.

Check-ins which fix improper use of \bimodindex{} and \stmodindex{} will be
made as fixes are applied.  Misc. indexing updates will occur as a side
effect in some cases.
1997-12-15 21:37:45 +00:00
Fred Drake d9dbfbd33c At the top, made it clear that the \bimodindex{} and \stmodindex{} are only
used for the defining entry for the module, not every index reference.
1997-12-15 21:20:03 +00:00
Guido van Rossum c0cc6351e5 regex -> re 1997-12-15 17:53:31 +00:00
Fred Drake 095f35ad60 Changed \indexsubitem from ({\tt HTMLParser} method) to just
(HTMLParser method).

This makes it more consistent with other modules.  All three *mllib modules
need this change.
1997-12-12 05:34:35 +00:00
Fred Drake 1247ceab94 Changed \indexsubitem from ({\tt SGMLParser} method) to just
(SGMLParser method).

This makes it more consistent with other modules.  All three *mllib modules
need this change.
1997-12-12 05:33:34 +00:00
Fred Drake 0add4c120d Changed \indexsubitem from ({\tt XMLParser} method) to just (XMLParser method).
This makes it more consistent with other modules.  All three *mllib modules
need this change.
1997-12-12 05:32:31 +00:00
Fred Drake d56924258a add_idx(): Don't add unnecessary markup around the little markers stuck in the
index to cross-references; an image doesn't benefit by being bold!
1997-12-11 21:46:07 +00:00
Guido van Rossum 48d0437d1d AMK's latest version. 1997-12-11 20:19:08 +00:00
Guido van Rossum bd49ac4492 The 'l' flag (locale specific matching) has been renamed to 'L'. 1997-12-10 23:05:53 +00:00
Guido van Rossum d58daff686 Planned release date for 1.5b2. 1997-12-10 18:56:48 +00:00
Guido van Rossum 736fe5e918 Document binary format and __init__-free unpickling. Added a pointer
to cPickle.
1997-12-09 20:45:08 +00:00
Guido van Rossum a42c17851c Turn the table for flags into a nested itemized environment. 1997-12-09 20:41:47 +00:00
Guido van Rossum eefcba61f4 Fix a little mess (Likecode{...} -> Like \code{...}) in recently added text. 1997-12-09 19:47:24 +00:00
Guido van Rossum 8291bb3693 Reference to PYTHONPATH should be PYTHONSTARTUP. 1997-12-09 19:46:45 +00:00
Guido van Rossum 28f9a68deb Added note about the module's obsolescence. 1997-12-09 19:45:47 +00:00
Guido van Rossum 138dac5a1b Added more warnings about ni's demise. 1997-12-09 15:03:41 +00:00
Fred Drake a2e268aa40 Mark file names with \file{} instead of \code{}. 1997-12-09 03:28:42 +00:00
Fred Drake c5aec05967 Separated the definitions of ntohs(), ntohl(), htons(), htonl(). Separate
descriptions really make things look a bit better, and should improve the
ability to re-purpose the content.
1997-12-08 21:25:41 +00:00
Fred Drake 8ca70069a6 Added Emacs turd so this file has the correct mode in Emacs / X/Emacs, even
if you don't have .perl in your mode table.
1997-12-08 20:59:54 +00:00
Fred Drake a5a3cdcf4d Added Emacs turd so this file has the correct mode in Emacs / X/Emacs.
clean_key():  Override the standard LaTeX2HTML clean_key() to remove a
	leading HTML tag, if present.  This broke the indexes for the library
	reference (at least) since many of the strings began with <code> or
	something similar.
1997-12-08 20:58:13 +00:00
Guido van Rossum a417b66204 Updated the README to the current status. Added a note about the
"times" option.
1997-12-08 20:51:26 +00:00
Guido van Rossum 0b334104ac New version from AMK -- with minor corrections to make it legal latex. 1997-12-08 17:33:40 +00:00
Fred Drake f3d729c8f9 Fixed SFT #23842: leave in non-standard style options when checking in an
update.  ;-(
1997-12-08 15:48:35 +00:00
Fred Drake e907208b30 Some reorganization (all limit operations & constants together, and all usage
functions and constants together).

Make explicit datadesc sections for each of the constants which might appear,
and have a description of each.  (Descriptions are based on the Linux
documentation and sources and the Solaris man pages.)

Hopefully Jeremy won't mind, because I didn't ask.  ;-)
1997-12-06 07:25:41 +00:00
Guido van Rossum a0eaa2200c Some manipulations with tags to get the TOC and Index to look better 1997-12-06 00:39:45 +00:00
Guido van Rossum 3e396cf9ff New WML file, this time with working Title and Author tags, and
mapping chapter and section headings to more appropriate nodes so that
the TOC actually works.  Now generates one HTML page per chapter.
1997-12-06 00:38:30 +00:00
Fred Drake eee08cdd54 Make examples consistently use 4-space indentation.
Use \file{} for file names.

Prefer \code{blat} and \emph{blat} to {\tt blat} and {\em blat}; this matches
current style in the Library Reference a bit better.

Made the example startup banner current.  The version number should be
bumped before the next release.
1997-12-04 15:43:15 +00:00
Fred Drake 0d3b4f8beb Fixed unresolved reference problem; this module wasn't \label{}ed.
Remove spurious underscore following book title.  Added specific reference to
a Win32 networking book.

Changed \indexsubitem from (in module SocketServer) to (SocketServer protocol),
since it's talking about a protocol supported by a collection of classes.
1997-12-04 14:36:52 +00:00
Fred Drake 98b032a7c0 Removed unnecessary escaping. 1997-12-04 14:20:59 +00:00
Fred Drake 1cf87496a6 Arg; more nits, but I may as well finish the job.
Removed the large comment remaining from the template documentation
section; the template tells us to remove these once they're not needed.

Remove some trailing whitespace from VM instruction pseudo-code.
1997-12-04 04:57:56 +00:00
Fred Drake 7381e28399 Fixed BINARY_RSHIFT documentation to indicate a right shift instead of a left
shift.

Adjust whitespace around "=" in VM machine descriptions to be consistent
throughout the document.
1997-12-04 04:51:12 +00:00
Fred Drake c2297c1ce9 Changed {\sc gdbm} to \code{gdbm} everywhere.
Fixed \indexsubitem to gdbm instead of dbm.

Changed dbm to \code{dbm} everywhere.
1997-12-04 04:45:28 +00:00
Fred Drake 7c4cba8325 Added handler for opcodedesc environment.
Fixed weird index behavior.
1997-12-03 19:45:08 +00:00
Fred Drake f2d7e5528d make_str_index_entry(): New function. Similar to make_index_entry(), but
includes the string in the returned value instead of the dummy
	filler character.

add_idx():  Override the latex2html function of the same name; this gets
	the anchor properly embedded in the <dt> element, so the index
	works in Grail too.
1997-12-03 19:44:27 +00:00
Guido van Rossum ab76af3d65 Provide default for blocksize on retrbinary (Skip Montanaro). 1997-12-03 19:34:14 +00:00
Fred Drake 456035f4b1 The biggie: changed the funcdesc environments used for opcode descriptions
to use the opcodedesc environment.

Changed a \code{} to a \file{} near the start where a file is referenced.

Fixed a typo:  "on" --> "one" in ROT_THREE description.

Wherever opcodes were referenced by name, use \code{OPCODE_NAME}; usage was
inconsistent.  Ideally, another macro would be defined since these don't
represent code a programmer would type, but that's minor even for me.  It'll
probably get converted automatically in the SGML conversion project.  Whether
that matters or not isn't relevant at this point.
1997-12-03 04:06:57 +00:00
Fred Drake a610f9f8c1 Added environment for defining PyVM instructions. This is only used in
the libdis.tex file I'm about to check in.

I'm not sure this is really an optimal solution yet, but it may be the best
alternative.  It avoids describing the instructions as either data items or
functions.

This change was discussed with Guido.  (Guido:  Take a look at the LaTeX
output for this; if this is reasonable I'll go ahead and update the perl
code in myformat.perl to match.)
1997-12-03 03:42:39 +00:00
Guido van Rossum 240ddc8a68 Typo in example (missing '=') discovered by Sandy Langbart. 1997-12-02 20:08:06 +00:00
Guido van Rossum 3593e5c4c3 Document new behavior of isinstance() when using a type object. 1997-12-02 19:15:01 +00:00
Guido van Rossum 0f280b6099 Use $LOGNAME instead of $USER to get the current user -- it seems to
be the state of the art.
1997-12-01 18:50:09 +00:00
Barry Warsaw 433c8ca328 Removed Queue.py. It's documented now. 1997-12-01 16:35:54 +00:00
Fred Drake 798654fc68 Added \indexsubitem definition; functions were previously indexed for the
wrong module.
1997-11-30 05:53:22 +00:00
Fred Drake 2478f9d5a2 Added \indexsubitem definition. Non-optimal, but two modules are sharing
the documentation here.
1997-11-30 05:38:44 +00:00
Fred Drake 92796d1f01 Added \indexsubitem definition; functions were previously indexed for the
wrong module.
1997-11-30 05:27:26 +00:00
Fred Drake 7730cc067f Updated \indexsubitem; functions had been indexed for the wrong module. 1997-11-30 05:23:47 +00:00
Guido van Rossum 73ec2c0081 Slip of the keyboard (f__ should be __). Dunno why I had a totally
messed up (but not checked in) version in my work files and didn't
notice before releasing 1.5 -- at least the distributed latex file
doesn't have the bogus warning about changed __init__ semantics.
1997-11-27 01:39:15 +00:00
Guido van Rossum 330c660f66 The dependency of tarhtml on l2h was a bad idea. 1997-11-26 15:31:32 +00:00
Guido van Rossum ee9f820cf1 Documented brand new behavior of sys.ps1 and sys.ps2 (str() is applied
to get the actual prompt).
1997-11-25 21:12:27 +00:00
Guido van Rossum 84cca446f2 Added utility target tarhtml to tar and gzip the HTML files plus their
support (GIFS, icons, style sheets).
1997-11-25 20:49:09 +00:00
Guido van Rossum 28fbe4dcd2 Adding the icons used by latex2html output to the CVS tree. 1997-11-25 20:14:07 +00:00
Guido van Rossum 628b4085b5 Ignore html files generated by webmaker. 1997-11-25 20:10:40 +00:00
Guido van Rossum 000eb0a138 Augmented the script so that (at CNRI anyway) it also invokes webmaker
to create the HTML.
1997-11-25 20:10:19 +00:00
Guido van Rossum 4323f7c7fd Simple index for the reference manuals (mostly for use on the Windows
platform).
1997-11-25 18:27:23 +00:00
Guido van Rossum 71ace95e12 Updated to the most pressing 1.5 issues. 1997-11-25 18:20:52 +00:00
Guido van Rossum 580aa8dbc3 Several changes, e.g. restructuring of the intro to be closer to what
it ought to be.  Maybe the last checkin before 1.5b1 is released.
1997-11-25 15:34:51 +00:00
Fred Drake cb91e7bbd3 Added the "italic correction" command ("\/") to the list of ignored commands.
There is at least one of there in the library reference, and this reduces
the warning count.  We *do* know what to do with it!
1997-11-25 04:06:21 +00:00
Fred Drake e624e0f99e Removed leading comment about this being "introductory" documentation;
compared to most, I'd say this section is fairly thorough.

Fixed \indexsubitem definitions for symbol and token module sub-documents.
Perhaps these should be moved to their own files, but they're awefully
small.
1997-11-25 04:04:00 +00:00
Guido van Rossum f259efe3d9 Get rid of math mode in some places. 1997-11-25 01:00:40 +00:00
Guido van Rossum 3e1e274d0b Don't use $math$ mode to typeset a simple '>' sign. Use \code, not \samp. 1997-11-25 00:43:34 +00:00
Guido van Rossum 9d62e80e46 Remove strange use of $math$ mode to produce a backslash. 1997-11-25 00:35:44 +00:00