Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
2 | <html> | |
3 | <head> | |
4 | <link rel="STYLESHEET" href="doc.css" type='text/css' /> | |
5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> | |
6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> | |
7 | <link rel="first" href="doc.html" title='Documenting Python' /> | |
8 | <link rel='contents' href='contents.html' title="Contents" /> | |
9 | <link rel='last' href='about.html' title='About this document...' /> | |
10 | <link rel='help' href='about.html' title='About this document...' /> | |
11 | <link rel="next" href="table-markup.html" /> | |
12 | <link rel="prev" href="module-markup.html" /> | |
13 | <link rel="parent" href="special-constructs.html" /> | |
14 | <link rel="next" href="table-markup.html" /> | |
15 | <meta name='aesop' content='information' /> | |
16 | <title>6.8 Library-level Markup </title> | |
17 | </head> | |
18 | <body> | |
19 | <DIV CLASS="navigation"> | |
20 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> | |
21 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
22 | <tr> | |
23 | <td class='online-navigation'><a rel="prev" title="6.7 Module-specific Markup" | |
24 | href="module-markup.html"><img src='../icons/previous.png' | |
25 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
26 | <td class='online-navigation'><a rel="parent" title="6 Special Markup Constructs" | |
27 | href="special-constructs.html"><img src='../icons/up.png' | |
28 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
29 | <td class='online-navigation'><a rel="next" title="6.9 Table Markup" | |
30 | href="table-markup.html"><img src='../icons/next.png' | |
31 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
32 | <td align="center" width="100%">Documenting Python</td> | |
33 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
34 | href="contents.html"><img src='../icons/contents.png' | |
35 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
36 | <td class='online-navigation'><img src='../icons/blank.png' | |
37 | border='0' height='32' alt='' width='32' /></td> | |
38 | <td class='online-navigation'><img src='../icons/blank.png' | |
39 | border='0' height='32' alt='' width='32' /></td> | |
40 | </tr></table> | |
41 | <div class='online-navigation'> | |
42 | <b class="navlabel">Previous:</b> | |
43 | <a class="sectref" rel="prev" href="module-markup.html">6.7 Module-specific Markup</A> | |
44 | <b class="navlabel">Up:</b> | |
45 | <a class="sectref" rel="parent" href="special-constructs.html">6 Special Markup Constructs</A> | |
46 | <b class="navlabel">Next:</b> | |
47 | <a class="sectref" rel="next" href="table-markup.html">6.9 Table Markup</A> | |
48 | </div> | |
49 | <hr /></div> | |
50 | </DIV> | |
51 | <!--End of Navigation Panel--> | |
52 | ||
53 | <H2><A NAME="SECTION000780000000000000000"></A><A NAME="library-markup"></A> | |
54 | <BR> | |
55 | 6.8 Library-level Markup | |
56 | </H2> | |
57 | ||
58 | <P> | |
59 | This markup is used when describing a selection of modules. For | |
60 | example, the <em class="citetitle"><a | |
61 | href="../mac/mac.html" | |
62 | title="Macintosh Library | |
63 | Modules" | |
64 | >Macintosh Library | |
65 | Modules</a></em> document uses this to help provide an overview of the | |
66 | modules in the collection, and many chapters in the | |
67 | <em class="citetitle"><a | |
68 | href="../lib/lib.html" | |
69 | title="Python Library Reference" | |
70 | >Python Library Reference</a></em> use it for | |
71 | the same purpose. | |
72 | ||
73 | <P> | |
74 | ||
75 | <dl class='macrodesc'> | |
76 | <dt><b><tt class='macro'>\localmoduletable</tt></b> | |
77 | </dt> | |
78 | <dd> | |
79 | If a <span class="file">.syn</span> file exists for the current | |
80 | chapter (or for the entire document in <code>howto</code> documents), a | |
81 | <tt class='environment'>\synopsistable</tt> is created with the contents loaded from the | |
82 | <span class="file">.syn</span> file. | |
83 | </dd></dl> | |
84 | ||
85 | <P> | |
86 | ||
87 | <DIV CLASS="navigation"> | |
88 | <div class='online-navigation'> | |
89 | <p></p><hr /> | |
90 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
91 | <tr> | |
92 | <td class='online-navigation'><a rel="prev" title="6.7 Module-specific Markup" | |
93 | href="module-markup.html"><img src='../icons/previous.png' | |
94 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
95 | <td class='online-navigation'><a rel="parent" title="6 Special Markup Constructs" | |
96 | href="special-constructs.html"><img src='../icons/up.png' | |
97 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
98 | <td class='online-navigation'><a rel="next" title="6.9 Table Markup" | |
99 | href="table-markup.html"><img src='../icons/next.png' | |
100 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
101 | <td align="center" width="100%">Documenting Python</td> | |
102 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
103 | href="contents.html"><img src='../icons/contents.png' | |
104 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
105 | <td class='online-navigation'><img src='../icons/blank.png' | |
106 | border='0' height='32' alt='' width='32' /></td> | |
107 | <td class='online-navigation'><img src='../icons/blank.png' | |
108 | border='0' height='32' alt='' width='32' /></td> | |
109 | </tr></table> | |
110 | <div class='online-navigation'> | |
111 | <b class="navlabel">Previous:</b> | |
112 | <a class="sectref" rel="prev" href="module-markup.html">6.7 Module-specific Markup</A> | |
113 | <b class="navlabel">Up:</b> | |
114 | <a class="sectref" rel="parent" href="special-constructs.html">6 Special Markup Constructs</A> | |
115 | <b class="navlabel">Next:</b> | |
116 | <a class="sectref" rel="next" href="table-markup.html">6.9 Table Markup</A> | |
117 | </div> | |
118 | </div> | |
119 | <hr /> | |
120 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
121 | </DIV> | |
122 | <!--End of Navigation Panel--> | |
123 | <ADDRESS> | |
124 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
125 | </ADDRESS> | |
126 | </BODY> | |
127 | </HTML> |