annotate Doc/mac/mac.tex @ 21467:4e35fa5d5708 legacy-trunk

Add documentation for the help() built-in; contributed by Ka-Ping Yee. This is part of SF patch #494622.
author Fred Drake <fdrake@acm.org>
date Tue, 18 Dec 2001 16:31:08 +0000
parents 7ea04029d1ae
children 523efd773261
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15232
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
1 \documentclass{manual}
8078
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
2
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
3 \title{Macintosh Library Modules}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
4
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
5 \input{boilerplate}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
6
15232
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
7 \makeindex % tell \index to actually write the .idx file
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
8 \makemodindex % ... and the module index as well.
8078
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
9
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
10
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
11 \begin{document}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
12
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
13 \maketitle
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
14
8782
ae3e2eaef9b9 Update to use a separate page for front matter.
Fred Drake <fdrake@acm.org>
parents: 8078
diff changeset
15 \ifhtml
ae3e2eaef9b9 Update to use a separate page for front matter.
Fred Drake <fdrake@acm.org>
parents: 8078
diff changeset
16 \chapter*{Front Matter\label{front}}
ae3e2eaef9b9 Update to use a separate page for front matter.
Fred Drake <fdrake@acm.org>
parents: 8078
diff changeset
17 \fi
ae3e2eaef9b9 Update to use a separate page for front matter.
Fred Drake <fdrake@acm.org>
parents: 8078
diff changeset
18
8078
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
19 \input{copyright}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
20
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
21 \begin{abstract}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
22
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
23 \noindent
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
24 This library reference manual documents Python's extensions for the
11462
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10600
diff changeset
25 Macintosh. It should be used in conjunction with the
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10600
diff changeset
26 \citetitle[../lib/lib.html]{Python Library Reference}, which documents
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10600
diff changeset
27 the standard library and built-in types.
8078
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
28
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
29 This manual assumes basic knowledge about the Python language. For an
11462
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10600
diff changeset
30 informal introduction to Python, see the
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10600
diff changeset
31 \citetitle[../tut/tut.html]{Python Tutorial}; the
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10600
diff changeset
32 \citetitle[../ref/ref.html]{Python Reference Manual} remains the
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10600
diff changeset
33 highest authority on syntactic and semantic questions. Finally, the
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10600
diff changeset
34 manual entitled \citetitle[../ext/ext.html]{Extending and Embedding
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10600
diff changeset
35 the Python Interpreter} describes how to add new extensions to Python
95a9833b000e Use \citetitle as appropriate.
Fred Drake <fdrake@acm.org>
parents: 10600
diff changeset
36 and how to embed it in other applications.
8078
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
37
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
38 \end{abstract}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
39
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
40 \tableofcontents
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
41
15232
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
42
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
43 \input{using.tex} % Using Python on the Macintosh
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
44
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
45
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
46 \chapter{MacPython Modules \label{macpython-modules}}
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
47
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
48 The following modules are only available on the Macintosh, and are
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
49 documented here:
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
50
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
51 \localmoduletable
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
52
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
53 \input{libmac}
8078
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
54 \input{libctb}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
55 \input{libmacfs}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
56 \input{libmacic}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
57 \input{libmacos}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
58 \input{libmacostools}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
59 \input{libmacspeech}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
60 \input{libmacui}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
61 \input{libframework}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
62 \input{libminiae}
15232
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
63 \input{libaepack}
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
64 \input{libaetypes}
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
65
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
66 \input{toolbox} % MacOS Toolbox Modules
17464
f1ec52ef771c Documentation for Just's ColorPicker module, so the Mac OS guys get
Fred Drake <fdrake@acm.org>
parents: 15232
diff changeset
67 \input{libcolorpicker}
15232
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
68
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
69 \input{undoc} % Undocumented Modules
8078
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
70
18191
8e5b537f87a1 Update to include the license information in a less annoying place.
Fred Drake <fdrake@acm.org>
parents: 17464
diff changeset
71 \appendix
8e5b537f87a1 Update to include the license information in a less annoying place.
Fred Drake <fdrake@acm.org>
parents: 17464
diff changeset
72 \chapter{History and License}
8e5b537f87a1 Update to include the license information in a less annoying place.
Fred Drake <fdrake@acm.org>
parents: 17464
diff changeset
73 \input{license}
8e5b537f87a1 Update to include the license information in a less annoying place.
Fred Drake <fdrake@acm.org>
parents: 17464
diff changeset
74
8078
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
75 %
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
76 % The ugly "%begin{latexonly}" pseudo-environments are really just to
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
77 % keep LaTeX2HTML quiet during the \renewcommand{} macros; they're
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
78 % not really valuable.
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
79 %
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
80
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
81 %begin{latexonly}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
82 \renewcommand{\indexname}{Module Index}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
83 %end{latexonly}
15232
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
84 \input{modmac.ind} % Module Index
8078
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
85
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
86 %begin{latexonly}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
87 \renewcommand{\indexname}{Index}
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
88 %end{latexonly}
15232
864f1714af28 Update to include all the new chapters & sections.
Fred Drake <fdrake@acm.org>
parents: 11462
diff changeset
89 \input{mac.ind} % Index
8078
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
90
3317f72723bb Python HOWTO document that replaces the old Mac section from the reference
Fred Drake <fdrake@acm.org>
parents:
diff changeset
91 \end{document}