Commit Graph

1001 Commits

Author SHA1 Message Date
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
Fred Drake 83bd081920 Minor stuff:
Explain what happens when a negative shift count is used (what exception).

Mark the title "Python Reference Manual" as \emph{}, for consistency.

"info" --> "information"

Tell more about the data attributes of file objects, using the {datadesc}
environment.

When refering the user to the language reference for information about
internal types, tell what internal types to expect information on.
1998-02-13 20:59:25 +00:00
Fred Drake 4c6896304b Fix weirdness with single-page table of contents, reported by Guido. 1998-02-13 16:58:49 +00:00
Fred Drake 2549249f79 &do_env_datadescni,
&do_env_funcdescni:  New functions.  These support the non-indexing variety
	of the {datadesc} and {funcdesc} environments.

There's still some flakiness with the new indexsubitem support, but that's
low priority.
1998-02-13 15:08:36 +00:00
Fred Drake fb74a463ad Add "Pretty Good Privacy" as well as "PGP" to the index. 1998-02-13 14:52:17 +00:00
Fred Drake c9c456ef69 In add_label_data() description, use "\samp{}" instead of "``\code{...}''"
to indicate the interpreted letters from the format string.
1998-02-13 14:48:00 +00:00
Fred Drake 7f6e2c45ec Use "\samp{...}" instead of "``\code{...}''" when showing markup fragments
in the running text.

For computed attribute and method names (where there's a \var{} part to
the name), use the non-indexing forms of \datadesc{} and \funcdesc{}.
This doesn't change the printed output, but removes 3 rejections from the
makeindex run and allows the LaTeX2HTML support to exclude these from the
index.
1998-02-13 14:38:23 +00:00
Fred Drake b441eb84d3 Use "\samp{...}" instead of "``\code{...}''" when showing markup fragments
in the running text.

For computed method names (where there's a \var{} part to the name), use
the non-indexing form of \funcdesc{}.  This doesn't change the printed
output, but removes 3 rejections from the makeindex run and allows the
LaTeX2HTML support to exclude these from the index.
1998-02-13 14:37:12 +00:00
Fred Drake aebc6f399e Two new environments: datadescni and funcdescni. These are similar to
datadesc and funcdesc, but don't add entries to the index.
1998-02-13 14:34:04 +00:00
Fred Drake 00dcfb2bc3 &get_indexsubitem: This now has a chance of working, thanks to:
&do_cmd_setindexsubitem:  New function.  Set the indexsubitem value from
	\setindexsubitem{(...)}.

&do_env_opcodedesc:  By default, don't index byte codes.

$INDEX_OPCODES:  New flag.  If true, index the byte codes.  Default is off.

Normalize indentation to 4 spaces everywhere.

Minor nits.
1998-02-13 07:21:03 +00:00
Fred Drake 8842e867af Remove \bcode / \ecode everywhere.
Make all the indentations in {verbatim} environments have column 0 of the
listing in column 0 of the file.

Remove pagenumbering / pagestyle cruft.

Use more logical and less physical markup.
1998-02-13 07:16:30 +00:00
Fred Drake 1e11a5c117 Remove \bcode / \ecode everywhere.
Make all the indentations in {verbatim} environments have column 0 of the
listing in column 0 of the file.

Remove pagenumbering / pagestyle cruft.
1998-02-13 07:11:32 +00:00
Fred Drake 2a4646c660 Remove obsolete pagenumbering / pagestyle cruft. 1998-02-13 07:08:56 +00:00
Fred Drake 1947991c2f Remove all \bcode / \ecode cruft; this is no longer needed. See previous
checkin of myformat.sty.

Change "\renewcommand{\indexsubitem}{(...)}" to "\setindexsubitem{(...)}"
everywhere.

Some other minor nits that I happened to come across.
1998-02-13 06:58:54 +00:00
Fred Drake dc8af0acc1 Lots of stuff:
Handle most (all?) of the page style / numbering magic here so the documents
don't have to do it individually.

Revise the \bcode / \ecode stuff so that the {verbatim} environment handles
it right directly.  \bcode / \ecode will be completely removed from all files
(to be checked in momentarily).

Have the {verbatim} environment get the samples indented a bit; this
appearantly had been attempted in the old code, but didn't work because
paragraphs weren't indented.

Make all headers, from chapters on down to subparagraphs, have sans-serif
titles.

\setindexsubitem{}:  New macro.  Replaces \renewcommand{\indexsubitem{}(...)}
	everywhere.  This allows LaTeX2HTML to be made to work correctly for
	this.  That was near impossible with the old mechanisms.

For all {*desc} environments, make the name of the described thing bold as
well as monospaced.

{opcodedesc} environment:  Don't index the byte code names; that doesn't seem
	terribly useful, and there are a lot of them.

\var{}:  More magic to make sure that the size is right even if embedded in
	\file{} or some other macro that uses the sans-serif font in running
	text.

\bfcode{}:  New macro.  Makes the font \code{} and bold.  (Was unreasonable
	using old LaTeX 2.09.)

\file{}:  Adjust the size of the sans-serif font a little.

\email{}, \url{},  Make these use the same font as \file{}, but not the
	surrounding single-quotes.

Update many comments.

Lots of minor nits and a little cleanliness.
1998-02-13 06:48:05 +00:00