summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-07-23 17:55:31 (GMT)
committerFred Drake <fdrake@acm.org>1998-07-23 17:55:31 (GMT)
commitfe7f3bc2aa5c59699aa87f6fbe6831f3742039a1 (patch)
treeb31bb7ae7e63ca3219475df2533dc298d06e34e6 /Doc
parentdfb658c3867260ae97a79f74df82a9278f319abb (diff)
downloadcpython-fe7f3bc2aa5c59699aa87f6fbe6831f3742039a1.zip
cpython-fe7f3bc2aa5c59699aa87f6fbe6831f3742039a1.tar.gz
cpython-fe7f3bc2aa5c59699aa87f6fbe6831f3742039a1.tar.bz2
Adjusted to use the new \declaremodule \modulesynopsis \localmoduletable
macros.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/mac/libctb.tex7
-rw-r--r--Doc/mac/libframework.tex6
-rw-r--r--Doc/mac/libmac.tex63
-rw-r--r--Doc/mac/libmacconsole.tex6
-rw-r--r--Doc/mac/libmacdnr.tex6
-rw-r--r--Doc/mac/libmacfs.tex7
-rw-r--r--Doc/mac/libmacic.tex6
-rw-r--r--Doc/mac/libmacos.tex6
-rw-r--r--Doc/mac/libmacostools.tex12
-rw-r--r--Doc/mac/libmacspeech.tex6
-rw-r--r--Doc/mac/libmactcp.tex6
-rw-r--r--Doc/mac/libmacui.tex6
-rw-r--r--Doc/mac/libminiae.tex7
13 files changed, 64 insertions, 80 deletions
diff --git a/Doc/mac/libctb.tex b/Doc/mac/libctb.tex
index d7302be..59125d4 100644
--- a/Doc/mac/libctb.tex
+++ b/Doc/mac/libctb.tex
@@ -1,6 +1,9 @@
\section{Built-in Module \module{ctb}}
-\label{module-ctb}
-\bimodindex{ctb}
+\declaremodule{builtin}{ctb}
+
+\modulesynopsis{Interfaces to the Communications Tool Box. Only the Connection
+Manager is currently supported.}
+
This module provides a partial interface to the Macintosh
Communications Toolbox. Currently, only Connection Manager tools are
diff --git a/Doc/mac/libframework.tex b/Doc/mac/libframework.tex
index 5bd2e2a..e3151e8 100644
--- a/Doc/mac/libframework.tex
+++ b/Doc/mac/libframework.tex
@@ -1,6 +1,8 @@
\section{Standard Module \module{FrameWork}}
-\stmodindex{FrameWork}
-\label{module-FrameWork}
+\declaremodule{standard}{FrameWork}
+
+\modulesynopsis{Interactive application framework.}
+
The \module{FrameWork} module contains classes that together provide a
framework for an interactive Macintosh application. The programmer
diff --git a/Doc/mac/libmac.tex b/Doc/mac/libmac.tex
index 284c09c..8b943be 100644
--- a/Doc/mac/libmac.tex
+++ b/Doc/mac/libmac.tex
@@ -36,63 +36,15 @@ similar works.
The following modules are documented here:
-\begin{description}
+\localmoduletable
-\item[mac]
---- Similar interfaces to the \module{posix} module.
-\item[macpath]
---- Path manipulation functions; use via \code{os.path}.
-
-\item[ctb]
---- Interfaces to the Communications Tool Box. Only the Connection
-Manager is currently supported.
-
-\item[macconsole]
---- Think C's console package is available using this module.
-
-\item[macdnr]
---- Interfaces to the Macintosh Domain Name Resolver.
-
-\item[macfs]
---- Support for FSSpec, the Alias Manager, \program{finder} aliases,
-and the Standard File package.
-
-\item[macic]
---- Internet Config.
-
-\item[MacOS]
---- Access to MacOS specific interpreter features.
-
-\item[macostools]
---- Convenience routines for file manipulation.
-
-\item[findertools]
---- Wrappers around the \program{finder}'s Apple Events interface.
-
-\item[mactcp]
---- The MacTCP interfaces.
-
-\item[macspeech]
---- Interface to the Macintosh Speech Manager.
-
-\item[EasyDialogs]
---- Basic Macintosh dialogs.
-
-\item[FrameWork]
---- Interactive application framework.
-
-\item[MiniAEFrame]
---- Support to act as an Open Scripting Architecture (OSA) server
-(``Apple Events'').
+\section{Built-in Module \module{mac}}
+\declaremodule{builtin}{mac}
-\end{description}
+\modulesynopsis{Similar interfaces to the \module{posix} module.}
-\section{Built-in Module \module{mac}}
-\label{module-mac}
-\bimodindex{mac}
-
This module provides a subset of the operating system dependent
functionality provided by the optional built-in module \module{posix}.
It is best accessed through the more portable standard module
@@ -126,9 +78,12 @@ returns the same information as \function{stat()}, but with three extra
values appended: the size of the resource fork of the file and its
4-character creator and type.
+
\section{Standard Module \module{macpath}}
-\label{module-macpath}
-\stmodindex{macpath}
+\declaremodule{standard}{macpath}
+
+\modulesynopsis{MacOS path manipulation functions.}
+
This module provides a subset of the pathname manipulation functions
available from the optional standard module \module{posixpath}. It is
diff --git a/Doc/mac/libmacconsole.tex b/Doc/mac/libmacconsole.tex
index 0d1f350..ad7e4f5 100644
--- a/Doc/mac/libmacconsole.tex
+++ b/Doc/mac/libmacconsole.tex
@@ -1,6 +1,8 @@
\section{Built-in Module \module{macconsole}}
-\label{module-macconsole}
-\bimodindex{macconsole}
+\declaremodule{builtin}{macconsole}
+
+\modulesynopsis{Think C's console package is available using this module.}
+
This module is available on the Macintosh, provided Python has been
diff --git a/Doc/mac/libmacdnr.tex b/Doc/mac/libmacdnr.tex
index 2aa07f5..04c511b 100644
--- a/Doc/mac/libmacdnr.tex
+++ b/Doc/mac/libmacdnr.tex
@@ -1,6 +1,8 @@
\section{Built-in Module \module{macdnr}}
-\label{module-macdnr}
-\bimodindex{macdnr}
+\declaremodule{builtin}{macdnr}
+
+\modulesynopsis{Interfaces to the Macintosh Domain Name Resolver.}
+
This module provides an interface to the Macintosh Domain Name
Resolver. It is usually used in conjunction with the \module{mactcp}
diff --git a/Doc/mac/libmacfs.tex b/Doc/mac/libmacfs.tex
index 69611b4..d80e79f 100644
--- a/Doc/mac/libmacfs.tex
+++ b/Doc/mac/libmacfs.tex
@@ -1,6 +1,9 @@
\section{Built-in Module \module{macfs}}
-\label{module-macfs}
-\bimodindex{macfs}
+\declaremodule{builtin}{macfs}
+
+\modulesynopsis{Support for FSSpec, the Alias Manager, \program{finder} aliases,
+and the Standard File package.}
+
This module provides access to Macintosh FSSpec handling, the Alias
diff --git a/Doc/mac/libmacic.tex b/Doc/mac/libmacic.tex
index 33364cd..4548492 100644
--- a/Doc/mac/libmacic.tex
+++ b/Doc/mac/libmacic.tex
@@ -1,6 +1,8 @@
\section{Standard Module \module{ic}}
-\label{module-ic}
-\bimodindex{ic}
+\declaremodule{builtin}{ic}
+
+\modulesynopsis{None}
+
This module provides access to Macintosh Internet Config package,
diff --git a/Doc/mac/libmacos.tex b/Doc/mac/libmacos.tex
index e634772..7aa4104 100644
--- a/Doc/mac/libmacos.tex
+++ b/Doc/mac/libmacos.tex
@@ -1,6 +1,8 @@
\section{Built-in Module \module{MacOS}}
-\label{module-MacOS}
-\bimodindex{MacOS}
+\declaremodule{builtin}{MacOS}
+
+\modulesynopsis{Access to MacOS specific interpreter features.}
+
This module provides access to MacOS specific functionality in the
diff --git a/Doc/mac/libmacostools.tex b/Doc/mac/libmacostools.tex
index 9586285..4930d70 100644
--- a/Doc/mac/libmacostools.tex
+++ b/Doc/mac/libmacostools.tex
@@ -1,6 +1,8 @@
\section{Standard Module \module{macostools}}
-\label{module-macostools}
-\stmodindex{macostools}
+\declaremodule{standard}{macostools}
+
+\modulesynopsis{Convenience routines for file manipulation.}
+
This module contains some convenience routines for file-manipulation
on the Macintosh.
@@ -48,8 +50,10 @@ the Apple documentation. Hence, aliases created with \function{mkalias()}
could conceivably have incompatible behaviour in some cases.
\section{Standard Module \module{findertools}}
-\label{module-findertools}
-\stmodindex{findertools}
+\declaremodule{standard}{findertools}
+
+\modulesynopsis{Wrappers around the \program{finder}'s Apple Events interface.}
+
This module contains routines that give Python programs access to some
functionality provided by the finder. They are implemented as wrappers
diff --git a/Doc/mac/libmacspeech.tex b/Doc/mac/libmacspeech.tex
index 14a9c61..2d90d34 100644
--- a/Doc/mac/libmacspeech.tex
+++ b/Doc/mac/libmacspeech.tex
@@ -1,6 +1,8 @@
\section{Built-in Module \module{macspeech}}
-\label{module-macspeech}
-\bimodindex{macspeech}
+\declaremodule{builtin}{macspeech}
+
+\modulesynopsis{Interface to the Macintosh Speech Manager.}
+
This module provides an interface to the Macintosh Speech Manager,
diff --git a/Doc/mac/libmactcp.tex b/Doc/mac/libmactcp.tex
index b592247..f5590c5 100644
--- a/Doc/mac/libmactcp.tex
+++ b/Doc/mac/libmactcp.tex
@@ -1,6 +1,8 @@
\section{Built-in Module \module{mactcp}}
-\label{module-mactcp}
-\bimodindex{mactcp}
+\declaremodule{builtin}{mactcp}
+
+\modulesynopsis{The MacTCP interfaces.}
+
This module provides an interface to the Macintosh TCP/IP driver%
diff --git a/Doc/mac/libmacui.tex b/Doc/mac/libmacui.tex
index 7f5237b..7703c8f 100644
--- a/Doc/mac/libmacui.tex
+++ b/Doc/mac/libmacui.tex
@@ -1,6 +1,8 @@
\section{Standard Module \module{EasyDialogs}}
-\label{module-EasyDialogs}
-\stmodindex{EasyDialogs}
+\declaremodule{standard}{EasyDialogs}
+
+\modulesynopsis{Basic Macintosh dialogs.}
+
The \module{EasyDialogs} module contains some simple dialogs for
the Macintosh, modelled after the \module{stdwin} dialogs with similar
diff --git a/Doc/mac/libminiae.tex b/Doc/mac/libminiae.tex
index a1cd6f4..e72daf1 100644
--- a/Doc/mac/libminiae.tex
+++ b/Doc/mac/libminiae.tex
@@ -1,6 +1,9 @@
\section{Standard Module \module{MiniAEFrame}}
-\stmodindex{MiniAEFrame}
-\label{module-MiniAEFrame}
+\declaremodule{standard}{MiniAEFrame}
+
+\modulesynopsis{Support to act as an Open Scripting Architecture (OSA) server
+(``Apple Events'').}
+
The module \module{MiniAEFrame} provides a framework for an application
that can function as an Open Scripting Architecture