Commit Graph

38 Commits

Author SHA1 Message Date
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
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 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 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 e3d5fc50a1 Add AMK's seealso environment that is now used in the library manual
at some places.
1997-07-17 18:27:53 +00:00
Guido van Rossum daff175611 Increase printable page size. 1997-06-02 17:35:01 +00:00
Guido van Rossum 36f3502151 Added cvardesc and ctypedesc macros, for api.tex. 1997-05-22 20:43:24 +00:00
Guido van Rossum 9231c8f176 Made a start with api.tex, the Python-C API Reference Manual.
Removed extref.tex (which provided the starting point).
Also removed qua.tex, which is out of date and no longer needed.
1997-05-15 21:43:21 +00:00
Fred Drake 30824246b3 (myformat.sty): Added a note about using \command{} v. {\command} wrt.
GNU info processing.
1996-12-13 21:53:07 +00:00
Fred Drake 9b550d992a (myformat.sty): Simplify \varvars definition. 1996-11-11 20:43:46 +00:00
Fred Drake eb33c781f3 (myformat.sty, extref.tex): Moved definition of cfuncdesc environment to
myformat.sty; having it in extref.tex confuses LaTeX2HTML.
1996-10-29 15:55:08 +00:00
Guido van Rossum ecae0b7ebb Fixed for Latex2e by Dave Ascher. 1996-06-26 19:03:20 +00:00
Guido van Rossum 45416028fb change \dfn to be \em not \sl 1995-03-30 16:00:58 +00:00
Guido van Rossum adb6bf65d1 add input time.sty; don't fiddle with sidemargins 1995-03-28 13:32:57 +00:00
Guido van Rossum 16d6e7109d Lots of small corrections by Andrew Kuchling (plus all new rotor docs) 1994-08-08 12:30:22 +00:00
Guido van Rossum e7af5a0816 Merge lost alpha100 revision 1994-08-01 12:39:35 +00:00
Guido van Rossum 95cd2ef162 Incorporated Jan-Hein's changes and texinfo conversion. 1992-12-08 14:37:55 +00:00
Guido van Rossum 1738388c59 Dumped \cbstart, \cbend 1992-08-13 14:10:17 +00:00
Guido van Rossum b7fc4afe1b Warn that _ must be in tt font. 1992-08-07 16:06:42 +00:00
Guido van Rossum ec24f1fc2c Input a4wide here 1992-04-06 14:02:23 +00:00
Guido van Rossum 6886c835aa Added \exindex and \obindex 1992-04-03 14:44:27 +00:00
Guido van Rossum 643d9326e4 Don't define the page lay-out here -- rely on A4wide, doubleside options. 1992-03-31 18:53:47 +00:00
Guido van Rossum 5badc75f8d Moved macros here from lib.tex. 1992-03-06 10:55:46 +00:00
Guido van Rossum 1d8428f3fc Minor reorg. 1992-02-11 15:52:03 +00:00
Guido van Rossum 79448288ba Use US paper size. 1992-01-17 10:42:38 +00:00
Guido van Rossum 92fba0293f ? 1991-11-12 15:44:51 +00:00
Guido van Rossum 4410c758a1 *** empty log message *** 1991-06-04 20:22:18 +00:00
Guido van Rossum 4c22cb2f31 Changed code environment into \bcode and \ecode macros.
Learned a lot about these things.
1991-01-25 13:28:15 +00:00
Guido van Rossum 44000edfce Better solution for code environment. 1991-01-24 16:54:29 +00:00
Guido van Rossum 515834a99b Initial revision 1991-01-22 11:45:29 +00:00