Commit Graph

54 Commits

Author SHA1 Message Date
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
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
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
Fred Drake
30d17825ac Add magic to make PDF generation use maximal compression. 1998-02-17 15:56:55 +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
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
f1a4150b70 Make sure indexes begin on odd-numbered pages. 1998-02-16 05:30:27 +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
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
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
Fred Drake
63221124c0 Comment out the times package in the distributed version. 1998-02-12 03:48:50 +00:00
Fred Drake
06f169bb7f \rfcindex{}: Removed; no longer needed.
\file{}:  Use a sans-serif font for the filename itself.

Use the fncychap.sty package for fancy chapter headings.

Replace the \maketitle command with our own format.  This is new, but it
looks a lot better than the old one.

Use \renewcommand instead of \def when extending or overriding standard LaTeX
commands.  This makes it more LaTeX-like.
1998-02-11 23:08:20 +00:00
Fred Drake
b16166e56f Add macros to insert RFC references much like the \manpage{} macro. Also a
macro to insert an RFC index reference.

(RFC references were formatted three different ways.)
1998-02-09 19:14:54 +00:00
Fred Drake
b37a395231 \itembreak, \itemjoin: Remove unused macros.
\idxcode{}:  New macro; used to mark things that would be \code{} for entry
	into the index.  This allows easily switching things around for the
	font used in the index.  (O'Reilly seems to keep it all plain roman
	in the index.  Looks reasonable in the Python documentation as well.)

\*index{}:  Use \idxcode{} instead of {\codefont{}}.
1998-02-06 22:52:52 +00:00
Fred Drake
b19274704f \modindex{}: New macro; index module without declaring it "built-in" or
"standard".  This is mostly for documentation of modules outside the
	standard library.
1998-02-04 14:43:36 +00:00
Fred Drake
0f02628dce \seemodule{}: Use logical markup for the module name, to ensure it picks up
any changes introduced there.  Also ensure a little more space between
	the module name and the parenthesized comment.
1998-01-22 17:43:15 +00:00
Fred Drake
dd28d57fd0 Revised new macros after discussion with Guido: Always use full names of
semantic concepts.

Added two new ones (not discussed with Guido:

\constant{}:  Markup for constants defined in Python modules.

\cfunction{}:  Markup for C functions; these should probably be distinguished
	by font, but are not at this time (since they're typically \code{} at
	this point).
1998-01-22 15:55:21 +00:00
Fred Drake
311c19688d Proposed new macros: see comments. These are not yet used.
These are intended to support semantic markup.  There are a number
	of places in the documentation where the exact meaning of an
	indentifier marked \code{} in the running text is ambiguous (could
	be a module or a class, a function or a method, etc.).  These are
	intended to clarify the intent of the identifier for processing
	applications and more intelligent style processing.
1998-01-20 05:07:19 +00:00
Fred Drake
9e24309bb5 \funcitem{}, \dataitem{}, \excitem{}: Removed obsolete macros; there are no
longer used anywhere.  Use the {*desc} environments instead.

\var{}:  Ensure that the argument is always set in roman italic, in case an
	 alternate font is being used for code.  These keeps the result of
	 \var{} consistent.

Some minor changes to allow easier exploration of alternate fonts for code in
the running text.  Haven't changed the selected font; I haven't found one that
has everything required!  (The best non-monospaced font so far was missing
the <, >, and | characters, or at least had them at the wrong locations.  It
also allowed confusion between upper-case I and lower-case L.)
1998-01-18 05:09:54 +00:00
Fred Drake
737e73ec3d Augment \tableofcontents to do the right thing. 1998-01-13 22:40:08 +00:00
Fred Drake
bc5062f664 \kwindex{}: Removed obsolete macro. 1998-01-13 18:31:39 +00:00
Fred Drake
8362d005cf Added command at end to use times fonts; commented out. Instructions to use
times are there as well.

Doing it here means the switch only affects one file and gets everything
rebuilt as needed.
1998-01-13 17:29:31 +00:00
Fred Drake
6c886a8db1 \optional{}: Removed leading word space, allowing more flexibility.
{seealso} environment:  Always start a new paragraph after the "See Also:"
	line; this ensures that formatting is consistent for each subsequent
	\see*{} item.
1998-01-12 14:44:33 +00:00
Fred Drake
031ad4b2a0 \mytableofcontents New macro. Wrapper around \tableofcontents that
does the right thing if the openright option is given.  Allows a
	lot of crud to be removed from the document files' frontmatter
	sections.

\endabstract		Extend standard macro.  (Called as \end{abstract}.)
	Does the right thing if the openright option is given.

\optional		Adjust to get the brackets right under latex2e.
1998-01-09 05:34:23 +00:00
Fred Drake
da941ef27c Added support for storing information to build a module index.
Enhance the "theindex" environment to add an entry to the table of contents.
1998-01-02 02:57:41 +00:00