traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
cpython/Doc/myformat.sty

615 lines
19 KiB
Plaintext
Raw Normal View History

Fixed for Latex2e by Dave Ascher.
1996-06-26 16:03:20 -03:00
%
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 02:23:06 -04:00
% myformat.sty for the Python doc [works only with with Latex2e]
Fixed for Latex2e by Dave Ascher.
1996-06-26 16:03:20 -03:00
%
Initial revision
1991-01-22 07:45:29 -04:00
\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 19:08:20 -04:00
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
\ProvidesPackage{myformat}
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 18:30:10 -04:00
[1998/01/11
\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 19:08:20 -04:00
LaTeX package (Python manual markup)]
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 18:30:10 -04:00
% Optional packages:
%
% If processing of these documents fails at your TeX installation,
% these may be commented out (independently) to make things work.
% These are both supplied with the current version of the teTeX
% distribution.
%
% The "fancyhdr" package makes nicer page footers reasonable to
% implement, and is used to put the chapter and section information in
% the footers.
%
% The "times" package makes the default font the PostScript Times
% font, which makes for smaller PostScript and a font that more people
% like.
%
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 02:23:06 -04:00
% The "fncychap" package is used to get the nice chapter headers. The
% .sty file is distributed with Python, so you should not need to disable
% it.
%
\RequirePackage{fancyhdr}\typeout{Using fancier footers than usual.}
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 18:30:10 -04:00
\RequirePackage{times}\typeout{Using times fonts instead of Computer Modern.}
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 02:23:06 -04:00
\RequirePackage[Bjarne]{fncychap}\typeout{Using nice chapter headings.}
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 18:30:10 -04:00
Add named destinations for \label{} in the PDF. Fix \email{} so it doesn't rely on \url{}.
1998-02-18 13:21:09 -04:00
% for PDF output, use maximal compression, revise \label{} to support named
% targets for later linking operations.
\@ifundefined{pdfannotlink}{}{%
\pdfcompresslevel=9
\let\OldLabel=\label
\renewcommand{\label}[1]{%
\OldLabel{#1}%
{\pdfdest name {#1} fit}%
}
}
Add magic to make PDF generation use maximal compression.
1998-02-17 11:56:55 -04:00
Increase printable page size.
1997-06-02 14:35:01 -03:00
% Increase printable page size (copied from fullpage.sty)
\topmargin 0pt
\advance \topmargin by -\headheight
\advance \topmargin by -\headsep
\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 01:09:54 -04:00
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 18:30:10 -04:00
\textheight 8.7in
\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 01:09:54 -04:00
Increase printable page size.
1997-06-02 14:35:01 -03:00
\oddsidemargin 0pt
\evensidemargin \oddsidemargin
\marginparwidth 0.5in
\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 01:09:54 -04:00
Increase printable page size.
1997-06-02 14:35:01 -03:00
\textwidth 6.5in
Fixed for Latex2e by Dave Ascher.
1996-06-26 16:03:20 -03:00
% Style parameters and macros used by most documents here
Moved macros here from lib.tex.
1992-03-06 06:55:46 -04:00
\raggedbottom
\sloppy
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 02:23:06 -04:00
\parindent = 0mm
\parskip = 2mm
\hbadness = 5000 % don't print trivial gripes
Moved macros here from lib.tex.
1992-03-06 06:55:46 -04:00
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 02:23:06 -04:00
\pagestyle{empty} % start this way; change for
\pagenumbering{roman} % ToC & chapters
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 02:48:05 -04:00
\setcounter{secnumdepth}{1}
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 02:23:06 -04:00
% Use this to set the font family for headers and other decor:
\newcommand{\HeaderFamily}{\sffamily}
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 18:30:10 -04:00
% Redefine the 'normal' header/footer style when using "fancyhdr" package:
\@ifundefined{fancyhf}{}{
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 02:23:06 -04:00
% Use \pagestyle{normal} as the primary pagestyle for text.
\fancypagestyle{normal}{
\fancyhf{}
\fancyfoot[LE,RO]{{\HeaderFamily\thepage}}
\fancyfoot[LO]{{\HeaderFamily\nouppercase{\rightmark}}}
\fancyfoot[RE]{{\HeaderFamily\nouppercase{\leftmark}}}
\renewcommand{\headrulewidth}{0pt}
\renewcommand{\footrulewidth}{0.4pt}
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 18:30:10 -04:00
}
% Update the plain style so we get the page number & footer line,
% but not a chapter or section title. This is to keep the first
% page of a chapter and the blank page between chapters `clean.'
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 02:23:06 -04:00
\fancypagestyle{plain}{
\fancyhf{}
\fancyfoot[LE,RO]{{\HeaderFamily\thepage}}
\renewcommand{\headrulewidth}{0pt}
\renewcommand{\footrulewidth}{0.4pt}
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 18:30:10 -04:00
}
% Redefine \cleardoublepage so that the blank page between chapters
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 02:23:06 -04:00
% gets the plain style and not the fancy style. This is described
% in the documentation for the fancyhdr package by Piet von Oostrum.
\renewcommand{\cleardoublepage}{
\clearpage\if@twoside \ifodd\c@page\else
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 18:30:10 -04:00
\hbox{}
\thispagestyle{plain}
\newpage
\if@twocolumn\hbox{}\newpage\fi\fi\fi}
}
\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 01:09:54 -04:00
% old code font selections:
\let\codefont=\tt
\let\sectcodefont=\tt
% (Haven't found a new one that gets <, >, and _ right without being
% monospaced.)
Changed code environment into \bcode and \ecode macros. Learned a lot about these things.
1991-01-25 09:28:15 -04:00
% Variable used by begin code command
Better solution for code environment.
1991-01-24 12:54:29 -04:00
\newlength{\codewidth}
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 02:48:05 -04:00
\newcommand{\examplevspace}{2mm}
\newcommand{\exampleindent}{1cm}
Moved macros here from lib.tex.
1992-03-06 06:55:46 -04:00
% Command to start a code block (follow this by \begin{verbatim})
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 02:48:05 -04:00
\newcommand{\b@code}{%
\begingroup%
\setlength{\parindent}\exampleindent%
% Calculate the text width for the minipage:
\setlength{\codewidth}{\linewidth}%
\addtolength{\codewidth}{-\parindent}%
%
\par%
\vspace\examplevspace%
\indent%
\begin{minipage}[t]{\codewidth}%
\small%
Changed code environment into \bcode and \ecode macros. Learned a lot about these things.
1991-01-25 09:28:15 -04:00
}
Moved macros here from lib.tex.
1992-03-06 06:55:46 -04:00
% Command to end a code block (precede this by \end{verbatim})
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 02:48:05 -04:00
\newcommand{\e@code}{%
\end{minipage}%
\endgroup%
Changed code environment into \bcode and \ecode macros. Learned a lot about these things.
1991-01-25 09:28:15 -04:00
}
Moved macros here from lib.tex.
1992-03-06 06:55:46 -04:00
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 02:48:05 -04:00
\let\OldVerbatim=\verbatim
\let\OldEndVerbatim=\endverbatim
\renewcommand{\verbatim}{\b@code\OldVerbatim}
\renewcommand{\endverbatim}{\OldEndVerbatim\e@code}
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 02:23:06 -04:00
% Augment the sectioning commands used to get our own font family in place:
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 02:48:05 -04:00
\renewcommand{\section}{\@startsection {section}{1}{\z@}%
{-3.5ex \@plus -1ex \@minus -.2ex}%
{2.3ex \@plus.2ex}%
{\reset@font\Large\HeaderFamily}}
\renewcommand{\subsection}{\@startsection{subsection}{2}{\z@}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\reset@font\large\HeaderFamily}}
\renewcommand{\subsubsection}{\@startsection{subsubsection}{3}{\z@}%
{-3.25ex\@plus -1ex \@minus -.2ex}%
{1.5ex \@plus .2ex}%
{\reset@font\normalsize\HeaderFamily}}
\renewcommand{\paragraph}{\@startsection{paragraph}{4}{\z@}%
{3.25ex \@plus1ex \@minus.2ex}%
{-1em}%
{\reset@font\normalsize\HeaderFamily}}
\renewcommand{\subparagraph}{\@startsection{subparagraph}{5}{\parindent}%
{3.25ex \@plus1ex \@minus .2ex}%
{-1em}%
{\reset@font\normalsize\HeaderFamily}}
Fixed for Latex2e by Dave Ascher.
1996-06-26 16:03:20 -03:00
% Underscore hack (only act like subscript operator if in math mode)
%
% The following is due to Mark Wooding (the old version didn't work with
% Latex 2e.
\DeclareRobustCommand\hackscore{%
\ifmmode_\else\textunderscore\fi%
}
\begingroup
\catcode`\_\active
\def\next{%
\AtBeginDocument{\catcode`\_\active\def_{\hackscore{}}}%
}
\expandafter\endgroup\next
%
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 02:48:05 -04:00
% This is the old hack, which didn't work with 2e.
% You should not need this since the rest of the documentation is now
% LaTeX2e-only.
Fixed for Latex2e by Dave Ascher.
1996-06-26 16:03:20 -03:00
%
%\def\_{\ifnum\fam=\ttfamily \char'137\else{\tt\char'137}\fi}
%\catcode`\_=12
%\catcode`\_=\active\def_{\ifnum\fam=\ttfamily \char'137 \else{\tt\char'137}\fi}
Moved macros here from lib.tex.
1992-03-06 06:55:46 -04:00
\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 18:52:52 -04:00
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 02:48:05 -04:00
\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 18:52:52 -04:00
%% Lots of index-entry generation support.
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 02:48:05 -04:00
% Command to wrap around stuff that refers to function / module /
% attribute names in the index. Default behavior: like \code{}. To
% just keep the index entries in the roman font, uncomment the second
% definition to use instead; it matches O'Reilly style more.
%
\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 18:52:52 -04:00
\newcommand{\idxcode}[1]{\codefont{#1}}
%\renewcommand{\idxcode}[1]{#1}
Moved macros here from lib.tex.
1992-03-06 06:55:46 -04:00
% Command to generate two index entries (using subentries)
Lots of small corrections by Andrew Kuchling (plus all new rotor docs)
1994-08-08 09:30:22 -03:00
\newcommand{\indexii}[2]{\index{#1!#2}\index{#2!#1}}
Moved macros here from lib.tex.
1992-03-06 06:55:46 -04:00
% And three entries (using only one level of subentries)
Lots of small corrections by Andrew Kuchling (plus all new rotor docs)
1994-08-08 09:30:22 -03:00
\newcommand{\indexiii}[3]{\index{#1!#2 #3}\index{#2!#3, #1}\index{#3!#1 #2}}
Moved macros here from lib.tex.
1992-03-06 06:55:46 -04:00
% And four (again, using only one level of subentries)
\newcommand{\indexiv}[4]{
\index{#1!#2 #3 #4}
\index{#2!#3 #4, #1}
\index{#3!#4, #1 #2}
\index{#4!#1 #2 #3}
}
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 02:48:05 -04:00
% Command to generate a reference to a function, statement, keyword,
% operator.
\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 18:52:52 -04:00
\newcommand{\stindex}[1]{\indexii{statement}{#1@{\idxcode{#1}}}}
\newcommand{\opindex}[1]{\indexii{operator}{#1@{\idxcode{#1}}}}
\newcommand{\exindex}[1]{\indexii{exception}{#1@{\idxcode{#1}}}}
Added \exindex and \obindex
1992-04-03 10:44:27 -04:00
\newcommand{\obindex}[1]{\indexii{object}{#1}}
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 02:23:06 -04:00
\newcommand{\bifuncindex}[1]{\index{#1@{\idxcode{#1()}} (built-in function)}}
Moved macros here from lib.tex.
1992-03-06 06:55:46 -04:00
% Add an index entry for a module
\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 18:52:52 -04:00
\newcommand{\refmodule}[2]{\index{#1@{\idxcode{#1}} (#2module)}}
\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 18:08:14 -04:00
\newcommand{\refmodindex}[1]{\refmodule{#1}{}}
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 17:37:45 -04:00
\newcommand{\refbimodindex}[1]{\refmodule{#1}{built-in }}
\newcommand{\refstmodindex}[1]{\refmodule{#1}{standard }}
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-01 22:57:41 -04:00
% support for the module index
\newwrite\modindexfile
\openout\modindexfile=modules.idx
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 17:37:45 -04:00
% Add the defining entry for a module
\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 18:52:52 -04:00
\newcommand{\defmodindex}[2]{%
\index{#1@{\idxcode{#1}} (#2module)|textbf}%
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-01 22:57:41 -04:00
\write\modindexfile{#1 \thepage}}
\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 10:43:36 -04:00
\newcommand{\modindex}[1]{\defmodindex{#1}{}}
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 17:37:45 -04:00
\newcommand{\bimodindex}[1]{\defmodindex{#1}{built-in }}
\newcommand{\stmodindex}[1]{\defmodindex{#1}{standard }}
Moved macros here from lib.tex.
1992-03-06 06:55:46 -04:00
% Additional string for an index entry
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 02:48:05 -04:00
\newcommand{\index@subitem}{}
\newcommand{\setindexsubitem}[1]{\renewcommand{\index@subitem}{#1}}
\newcommand{\ttindex}[1]{\index{#1@{\idxcode{#1}} \index@subitem}}
Moved macros here from lib.tex.
1992-03-06 06:55:46 -04:00
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
% from user-level, fulllineitems should be called as an environment
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 02:23:06 -04:00
\newenvironment{fulllineitems}{
\begin{list}{}{\labelwidth \leftmargin \labelsep 0pt
\rightmargin 0pt \topsep -\parskip \partopsep \parskip
\itemsep -\parsep
\let\makelabel=\itemnewline}
}{\end{list}}
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
Added cvardesc and ctypedesc macros, for api.tex.
1997-05-22 17:43:24 -03:00
% cfuncdesc should be called as
% \begin{cfuncdesc}{type}{name}{arglist}
% ... description ...
% \end{cfuncdesc}
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 02:23:06 -04:00
\newenvironment{cfuncdesc}[3]{%
\begin{fulllineitems}%
\item[\code{#1 \bfcode{#2}(\varvars{#3})}]%
\index{#2@{\idxcode{#2()}}}%
}{\end{fulllineitems}}
\newenvironment{cvardesc}[2]{%
\begin{fulllineitems}%
\item[\code{#1 \bfcode{#2}}]%
\index{#2@{\idxcode{#2}}}%
}{\end{fulllineitems}}
\newenvironment{ctypedesc}[1]{%
\begin{fulllineitems}%
\item[\bfcode{#1}]\ttindex{#1}
}{\end{fulllineitems}}
\newcommand{\funcline}[2]{\funclineni{#1}{#2}\ttindex{#1()}}
\newenvironment{funcdesc}[2]{%
\begin{fulllineitems}%
\funcline{#1}{#2}%
}{\end{fulllineitems}}
\newcommand{\optional}[1]{%
{\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
Lots of small corrections by Andrew Kuchling (plus all new rotor docs)
1994-08-08 09:30:22 -03:00
Two new environments: datadescni and funcdescni. These are similar to datadesc and funcdesc, but don't add entries to the index.
1998-02-13 10:34:04 -04:00
% similar to {funcdesc}, but doesn't add to the index
\newcommand{\funclineni}[2]{\item[\code{\bfcode{#1}(\varvars{#2})}]}
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 02:23:06 -04:00
\newenvironment{funcdescni}[2]{%
\begin{fulllineitems}%
\funclineni{#1}{#2}%
}{\end{fulllineitems}}
\newenvironment{classdesc}[2]{%
\begin{fulllineitems}%
\item[\code{\bfcode{#1}(\varvars{#2})}]%
\ttindex{#1}%
\def\baseclasses##1{}%
}{\end{fulllineitems}}
\newenvironment{excdesc}[1]{%
\begin{fulllineitems}%
\item[\bfcode{#1}]\ttindex{#1}%
}{\end{fulllineitems}}
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
Two new environments: datadescni and funcdescni. These are similar to datadesc and funcdesc, but don't add entries to the index.
1998-02-13 10:34:04 -04:00
\newcommand{\dataline}[1]{\datalineni{#1}\ttindex{#1}}
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 02:23:06 -04:00
\newenvironment{datadesc}[1]{%
\begin{fulllineitems}%
\dataline{#1}%
}{\end{fulllineitems}}
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
Two new environments: datadescni and funcdescni. These are similar to datadesc and funcdesc, but don't add entries to the index.
1998-02-13 10:34:04 -04:00
% similar to {datadesc}, but doesn't add to the index
\newcommand{\datalineni}[1]{\item[\bfcode{#1}]}
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 02:23:06 -04:00
\newenvironment{datadescni}[1]{%
\begin{fulllineitems}%
\datalineni{#1}%
}{\end{fulllineitems}}
Two new environments: datadescni and funcdescni. These are similar to datadesc and funcdesc, but don't add entries to the index.
1998-02-13 10:34:04 -04:00
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 02:23:06 -04:00
\newenvironment{opcodedesc}[2]{%
\begin{fulllineitems}%
\item[\bfcode{#1}\quad\var{#2}]%
}{\end{fulllineitems}}
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-02 23:42:39 -04:00
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
\let\nodename=\label
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 02:48:05 -04:00
% For these commands, use \command{} to get the typography right, not
% {\command}. This works better with the texinfo translation.
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
\newcommand{\ABC}{{\sc abc}}
\newcommand{\UNIX}{{\sc Unix}}
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 01:07:19 -04:00
\newcommand{\POSIX}{POSIX}
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
\newcommand{\ASCII}{{\sc ascii}}
Lots of small corrections by Andrew Kuchling (plus all new rotor docs)
1994-08-08 09:30:22 -03:00
\newcommand{\Cpp}{C\protect\raisebox{.18ex}{++}}
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
\newcommand{\C}{C}
\newcommand{\EOF}{{\sc eof}}
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 18:43:21 -03:00
\newcommand{\NULL}{\code{NULL}}
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
% code is the most difficult one...
\newcommand{\code}[1]{{\@vobeyspaces\@noligs\def\{{\char`\{}\def\}{\char`\}}\def\~{\char`\~}\def\^{\char`\^}\def\e{\char`\\}\def\${\char`\$}\def\#{\char`\#}\def\&{\char`\&}\def\%{\char`\%}%
\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 01:09:54 -04:00
\mbox{\codefont{#1}}}}
Fixed for Latex2e by Dave Ascher.
1996-06-26 16:03:20 -03:00
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 02:23:06 -04:00
\newcommand{\bfcode}[1]{\code{\bfseries#1}} % bold-faced code font
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
\newcommand{\kbd}[1]{\mbox{\tt #1}}
\newcommand{\key}[1]{\mbox{\tt #1}}
\newcommand{\samp}[1]{\mbox{`\code{#1}'}}
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 02:48:05 -04:00
% This weird definition of \var{} allows it to always appear in roman
% italics, and won't get funky in code fragments when we play around
% with fonts.
\newcommand{\var}[1]{\mbox{\normalsize\textrm{\textit{#1\/}}}}
Fixed for Latex2e by Dave Ascher.
1996-06-26 16:03:20 -03:00
\renewcommand{\emph}[1]{{\em #1\/}}
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 02:23:06 -04:00
\newcommand{\dfn}[1]{\emph{#1}}
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
\newcommand{\strong}[1]{{\bf #1}}
\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 19:08:20 -04:00
% let's experiment with a new font:
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 02:48:05 -04:00
\newcommand{\file}[1]{\mbox{`\small\textsf{#1}'}}
\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 10:24:19 -04:00
\@ifundefined{pdfannotlink}{%
If generating PDF, include the author and title information in acroread's "File->General Info" dialog.
1998-02-17 11:13:01 -04:00
\newcommand{\url}[1]{\mbox{\small\textsf{#1}}}%
\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 10:24:19 -04:00
}{
\input{pdfcolor}% this really isn't a package
\newcommand{\url}[1]{{%
\pdfannotlink user{/C [1 1 1] /S /URI /URI (#1)}%
\NavyBlue% color of the link text
\mbox{\small\textsf{#1}}%
\Black% Turn it back off; these are declarative
\pdfendlink}}% and don't appear bound to the current
}% formatting "box".
Add named destinations for \label{} in the PDF. Fix \email{} so it doesn't rely on \url{}.
1998-02-18 13:21:09 -04:00
\newcommand{\email}[1]{\mbox{\small\textsf{#1}}}
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
(myformat.sty): Simplify \varvars definition.
1996-11-11 16:43:46 -04:00
\newcommand{\varvars}[1]{{\def\,{\/{\char`\,}}\var{#1}}}
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
\newif\iftexi\texifalse
Fixed for Latex2e by Dave Ascher.
1996-06-26 16:03:20 -03:00
\newif\iflatex\latextrue
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
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 02:48:05 -04:00
% These should be used for all references to identifiers which are
% used to refer to instances of specific language constructs. See the
% names for specific semantic assignments.
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 01:07:19 -04:00
%
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 02:48:05 -04:00
% For now, don't do anything really fancy with them; just use them as
% logical markup. This might change in the future.
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 01:07:19 -04:00
%
\let\module=\code
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 11:55:21 -04:00
\let\keyword=\code
\let\exception=\code
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 01:07:19 -04:00
\let\class=\code
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 11:55:21 -04:00
\let\function=\code
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 02:23:06 -04:00
\let\member=\code
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 11:55:21 -04:00
\let\method=\code
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 02:23:06 -04:00
\let\cfunction=\code
\let\ctype=\code
\let\cdata=\code
% constants defined in Python modules or C headers, not language constants:
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 11:55:21 -04:00
\let\constant=\code
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 01:07:19 -04:00
\newcommand{\manpage}[2]{{\emph{#1}(#2)}}
\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 19:08:20 -04:00
\newcommand{\rfc}[1]{RFC #1\index{RFC!RFC #1}}
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 02:48:05 -04:00
\newcommand{\program}[1]{\strong{#1}}
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 01:07:19 -04:00
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 02:23:06 -04:00
\newenvironment{tableii}[4]{%
\begin{center}%
\def\lineii##1##2{\csname#2\endcsname{##1}&##2\\}%
\begin{tabular}{#1}\hline#3&#4\\ \hline%
}{%
\hline%
\end{tabular}%
\end{center}%
}
Merge lost alpha100 revision
1994-08-01 09:39:35 -03:00
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 02:23:06 -04:00
\newenvironment{tableiii}[5]{%
\begin{center}%
\def\lineiii##1##2##3{\csname#2\endcsname{##1}&##2&##3\\}%
\begin{tabular}{#1}\hline#3&#4&#5\\%
\hline%
}{%
\hline%
\end{tabular}%
\end{center}%
}
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
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 02:23:06 -04:00
\newcommand{\itemnewline}[1]{%
\@tempdima\linewidth%
\advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}%
}
Incorporated Jan-Hein's changes and texinfo conversion.
1992-12-08 10:37:55 -04:00
\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 01:09:54 -04:00
\newcommand{\sectcode}[1]{{\sectcodefont{#1}}}
Add AMK's seealso environment that is now used in the library manual at some places.
1997-07-17 15:27:53 -03:00
% Cross-referencing (AMK)
% Sample usage:
% \begin{seealso}
% \seemodule{rand}{Uniform random number generator}; % Module xref
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 02:48:05 -04:00
% \seetext{\emph{Encyclopedia Britannica}}. % Ref to a book
Add AMK's seealso environment that is now used in the library manual at some places.
1997-07-17 15:27:53 -03:00
% \end{seealso}
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 02:23:06 -04:00
\newenvironment{seealso}[0]{
\strong{See Also:}\par
% These should only be defined within the {seealso} environment:
\def\seemodule##1##2{\ref{module-##1}:\quad Module \module{##1}\quad (##2)}
\def\seetext##1{\par{##1}}
}{\par}
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-01 22:57:41 -04:00
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 02:48:05 -04:00
% Fix the theindex environment to add an entry to the Table of
% Contents; this is much nicer than just having to jump to the end of
% the book and flip around, especially with multiple indexes.
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-01 22:57:41 -04:00
%
\let\OldTheindex=\theindex
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 02:23:06 -04:00
\renewcommand{\theindex}{
\cleardoublepage
\OldTheindex
\addcontentsline{toc}{chapter}{\indexname}
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-01 22:57:41 -04:00
}
\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 01:34:23 -04:00
% Use a similar trick to catch the end of the {abstract} environment,
% but here make sure the abstract is followed by a blank page if the
% 'openright' option is used.
%
\let\OldEndAbstract=\endabstract
\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 19:08:20 -04:00
\renewcommand{\endabstract}{
Augment \tableofcontents to do the right thing.
1998-01-13 18:40:08 -04:00
\if@openright
\ifodd\value{page}
\typeout{Adding blank page after the abstract.}
\vfil\pagebreak
\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 01:34:23 -04:00
\fi
Augment \tableofcontents to do the right thing.
1998-01-13 18:40:08 -04:00
\fi
\OldEndAbstract
\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 01:34:23 -04:00
}
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 02:48:05 -04:00
% This wraps the \tableofcontents macro with all the magic to get the
% spacing right and have the right number of pages if the 'openright'
\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 01:34:23 -04:00
% option has been used. This eliminates a fair amount of crud in the
% individual document files.
%
Augment \tableofcontents to do the right thing.
1998-01-13 18:40:08 -04:00
\let\OldTableofcontents=\tableofcontents
\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 19:08:20 -04:00
\renewcommand{\tableofcontents}[0]{%
\setcounter{page}{1}%
\pagebreak%
\pagestyle{plain}%
{%
\parskip = 0mm%
\OldTableofcontents%
\if@openright%
\ifodd\value{page}%
\typeout{Adding blank page after the table of contents.}%
\pagebreak\hspace{0pt}%
\fi%
\fi%
}%
Fix weirdness with single-page table of contents, reported by Guido.
1998-02-13 12:58:49 -04:00
\cleardoublepage%
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 02:48:05 -04:00
\pagenumbering{arabic}%
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 18:30:10 -04:00
\@ifundefined{fancyhf}{}{\pagestyle{normal}}%
\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 19:08:20 -04:00
}
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 02:48:05 -04:00
% Allow the release number to be specified independently of the
% \date{}. This allows the date to reflect the document's date and
% release to specify the Python release that is documented.
%
\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 19:08:20 -04:00
\newcommand{\@release}{}
\newcommand{\version}{}
\newcommand{\releasename}{Release}
\newcommand{\release}[1]{%
\renewcommand{\@release}{\releasename\space\version}%
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 02:48:05 -04:00
\renewcommand{\version}{#1}}
\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 19:08:20 -04:00
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 02:48:05 -04:00
% Allow specification of the author's address separately from the
% author's name. This can be used to format them differently, which
% is a good thing.
%
\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 19:08:20 -04:00
\newcommand{\@authoraddress}{}
\newcommand{\authoraddress}[1]{\renewcommand{\@authoraddress}{#1}}
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 02:48:05 -04:00
% Change the title page to look a bit better, and fit in with the
% fncychap ``Bjarne'' style a bit better.
%
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 02:23:06 -04:00
\renewcommand{\maketitle}{%
\begin{titlepage}%
\let\footnotesize\small
\let\footnoterule\relax
\@ifundefined{ChTitleVar}{}{%
\mghrulefill{\RW}}%
\@ifundefined{pdfinfo}{}{
\pdfinfo
author {\@author}
title {\@title}
}
\begin{flushright}%
{\rm\Huge\HeaderFamily \@title \par}%
{\em\LARGE\HeaderFamily \@release \par}
\vfill
{\LARGE\HeaderFamily \@author \par}
\vfill\vfill
{\large
\@date \par
\vskip 3em
\@authoraddress \par
}%
\end{flushright}%\par
\@thanks
\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 19:08:20 -04:00
\end{titlepage}%
\setcounter{footnote}{0}%
\let\thanks\relax\let\maketitle\relax
\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
}
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 02:48:05 -04:00
% ``minitoc'' support; works fairly well but not all chapters do well
% with it. Has some weird side effects that I haven't tracked down;
% don't use it for real at this time.
\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 19:08:20 -04:00
%
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 02:48:05 -04:00
% To enable, uncomment the following line only (don't do it!):
\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 19:08:20 -04:00
%\RequirePackage{minitoc}
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 02:48:05 -04:00
%
% Maybe this should all be removed. But I think something like this
% would be really nice if it can be integrated with the ``list of
% modules'' at the top of module-documentation chapters. But it might
% require a completely new environment, perhaps based on {list}.
\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 19:08:20 -04:00
\newif\if@minitocprinted
\newcommand{\suppressminitoc}{\@minitocprintedtrue}
\@ifundefined{minitoc}{
% allow \minitoc to be used even if the package hasn't been loaded.
\newcommand{\minitoc}{\@minitocprintedtrue}
}{
\dominitoc
\newif\if@firstsection
\let\OldChapter=\chapter
\let\OldSection=\section
\let\OldMinitoc=\minitoc
% This will only include the minitoc once per chapter
\renewcommand{\minitoc}{%
\if@minitocprinted{}\else%
\OldMinitoc%
\@minitocprintedtrue%
\fi%
}
% This includes a minitoc before the first \section{}, if it hasn't
% already been printed using an explicit \minitoc call.
\newcommand{\NewSection}[1]{%
\if@firstsection%
\if@minitocprinted{}\else%
\vskip 15pt%
\minitoc%
\@firstsectionfalse%
\fi%
\fi%
\OldSection{#1}%
}
% Reset the flags for each chaper to let the automatic stuff work.
\newcommand{\NewChapter}[1]{%
\OldChapter{#1}%
\@firstsectiontrue%
\@minitocprintedfalse%
}
\let\chapter=\NewChapter
\let\section=\NewSection
\typeout{Including mini Tables of Contents in each chapter.}
}
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 02:48:05 -04:00
% This sets up the fancy chapter headings that make the documents look
% at least a little better than the usual LaTeX output.
\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 19:08:20 -04:00
%
\@ifundefined{ChTitleVar}{}{
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 02:48:05 -04:00
\ChNameVar{\raggedleft\normalsize\HeaderFamily}
\ChNumVar{\raggedleft \bfseries\Large\HeaderFamily}
\ChTitleVar{\raggedleft \rm\Huge\HeaderFamily}
\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 19:08:20 -04:00
% This creates chapter heads without the leading \vspace*{}:
\def\@makechapterhead#1{%
{\parindent \z@ \raggedright \normalfont
\ifnum \c@secnumdepth >\m@ne
\DOCH
\fi
\interlinepenalty\@M
\DOTI{#1}
}
\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 01:34:23 -04:00
}
\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 19:08:20 -04:00
\typeout{Using fancy chapter headings.}
\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 01:34:23 -04:00
}