Mercurial Repositories > eric / file comparison

comparison: DocumentationTools/TemplatesListsStyleCSS.py

DocumentationTools/TemplatesListsStyleCSS.py

changeset 406
eacf81fad150
parent 13
1af94a91f439
child 407
1a3e06617b96
equal deleted inserted replaced
405:374066392929 406:eacf81fad150
14 headerTemplate = \ 14 headerTemplate = \
15 '''<?xml version="1.0" encoding="utf-8"?> 15 '''<?xml version="1.0" encoding="utf-8"?>
16 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 16 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
17 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> 17 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
18 <html><head> 18 <html><head>
19 <title>%(Title)s</title> 19 <title>{Title}</title>
20 <style> 20 <style>
21 %(Style)s 21 {Style}
22 </style> 22 </style>
23 </head> 23 </head>
24 <body>''' 24 <body>'''
25 25
26 footerTemplate = ''' 26 footerTemplate = '''
30 ## Templates for documentation files ## 30 ## Templates for documentation files ##
31 ######################################### 31 #########################################
32 32
33 moduleTemplate = \ 33 moduleTemplate = \
34 '''<a NAME="top" ID="top"></a> 34 '''<a NAME="top" ID="top"></a>
35 <h1>%(Module)s</h1> 35 <h1>{Module}</h1>
36 %(ModuleDescription)s 36 {ModuleDescription}
37 <h3>Global Attributes</h3> 37 <h3>Global Attributes</h3>
38 %(GlobalsList)s 38 {GlobalsList}
39 <h3>Classes</h3> 39 <h3>Classes</h3>
40 %(ClassList)s 40 {ClassList}
41 <h3>Functions</h3> 41 <h3>Functions</h3>
42 %(FunctionList)s 42 {FunctionList}
43 <hr />''' 43 <hr />'''
44 44
45 rbFileTemplate = \ 45 rbFileTemplate = \
46 '''<a NAME="top" ID="top"></a> 46 '''<a NAME="top" ID="top"></a>
47 <h1>%(Module)s</h1> 47 <h1>{Module}</h1>
48 %(ModuleDescription)s 48 {ModuleDescription}
49 <h3>Global Attributes</h3> 49 <h3>Global Attributes</h3>
50 %(GlobalsList)s 50 {GlobalsList}
51 <h3>Classes</h3> 51 <h3>Classes</h3>
52 %(ClassList)s 52 {ClassList}
53 <h3>Modules</h3> 53 <h3>Modules</h3>
54 %(RbModulesList)s 54 {RbModulesList}
55 <h3>Functions</h3> 55 <h3>Functions</h3>
56 %(FunctionList)s 56 {FunctionList}
57 <hr />''' 57 <hr />'''
58 58
59 classTemplate = \ 59 classTemplate = \
60 '''<hr /> 60 '''<hr />
61 <a NAME="%(Anchor)s" ID="%(Anchor)s"></a> 61 <a NAME="{Anchor}" ID="{Anchor}"></a>
62 <h2>%(Class)s</h2> 62 <h2>{Class}</h2>
63 %(ClassDescription)s 63 {ClassDescription}
64 <h3>Derived from</h3> 64 <h3>Derived from</h3>
65 %(ClassSuper)s 65 {ClassSuper}
66 <h3>Class Attributes</h3> 66 <h3>Class Attributes</h3>
67 %(GlobalsList)s 67 {GlobalsList}
68 <h3>Methods</h3> 68 <h3>Methods</h3>
69 %(MethodList)s 69 {MethodList}
70 %(MethodDetails)s 70 {MethodDetails}
71 <div align="right"><a href="#top">Up</a></div> 71 <div align="right"><a href="#top">Up</a></div>
72 <hr />''' 72 <hr />'''
73 73
74 methodTemplate = \ 74 methodTemplate = \
75 '''<a NAME="%(Anchor)s.%(Method)s" ID="%(Anchor)s.%(Method)s"></a> 75 '''<a NAME="{Anchor}.{Method}" ID="{Anchor}.{Method}"></a>
76 <h4>%(Class)s.%(Method)s</h4> 76 <h4>{Class}.{Method}</h4>
77 <b>%(Method)s</b>(<i>%(Params)s</i>) 77 <b>{Method}</b>(<i>{Params}</i>)
78 %(MethodDescription)s''' 78 {MethodDescription}'''
79 79
80 constructorTemplate = \ 80 constructorTemplate = \
81 '''<a NAME="%(Anchor)s.%(Method)s" ID="%(Anchor)s.%(Method)s"></a> 81 '''<a NAME="{Anchor}.{Method}" ID="{Anchor}.{Method}"></a>
82 <h4>%(Class)s (Constructor)</h4> 82 <h4>{Class} (Constructor)</h4>
83 <b>%(Class)s</b>(<i>%(Params)s</i>) 83 <b>{Class}</b>(<i>{Params}</i>)
84 %(MethodDescription)s''' 84 {MethodDescription}'''
85 85
86 rbModuleTemplate = \ 86 rbModuleTemplate = \
87 '''<hr /> 87 '''<hr />
88 <a NAME="%(Anchor)s" ID="%(Anchor)s"></a> 88 <a NAME="{Anchor}" ID="{Anchor}"></a>
89 <h2>%(Module)s</h2> 89 <h2>{Module}</h2>
90 %(ModuleDescription)s 90 {ModuleDescription}
91 <h3>Module Attributes</h3> 91 <h3>Module Attributes</h3>
92 %(GlobalsList)s 92 {GlobalsList}
93 <h3>Classes</h3> 93 <h3>Classes</h3>
94 %(ClassesList)s 94 {ClassesList}
95 <h3>Functions</h3> 95 <h3>Functions</h3>
96 %(FunctionsList)s 96 {FunctionsList}
97 <hr /> 97 <hr />
98 %(ClassesDetails)s 98 {ClassesDetails}
99 %(FunctionsDetails)s 99 {FunctionsDetails}
100 <div align="right"><a href="#top">Up</a></div> 100 <div align="right"><a href="#top">Up</a></div>
101 <hr />''' 101 <hr />'''
102 102
103 rbModulesClassTemplate = \ 103 rbModulesClassTemplate = \
104 '''<a NAME="%(Anchor)s" ID="%(Anchor)s"></a> 104 '''<a NAME="{Anchor}" ID="{Anchor}"></a>
105 <h2>%(Class)s</h2> 105 <h2>{Class}</h2>
106 %(ClassDescription)s 106 {ClassDescription}
107 <h3>Derived from</h3> 107 <h3>Derived from</h3>
108 %(ClassSuper)s 108 {ClassSuper}
109 <h3>Methods</h3> 109 <h3>Methods</h3>
110 %(MethodList)s 110 {MethodList}
111 %(MethodDetails)s 111 {MethodDetails}
112 <div align="right"><a href="#top">Up</a></div> 112 <div align="right"><a href="#top">Up</a></div>
113 <hr />''' 113 <hr />'''
114 114
115 functionTemplate = \ 115 functionTemplate = \
116 '''<hr /> 116 '''<hr />
117 <a NAME="%(Anchor)s" ID="%(Anchor)s"></a> 117 <a NAME="{Anchor}" ID="{Anchor}"></a>
118 <h2>%(Function)s</h2> 118 <h2>{Function}</h2>
119 <b>%(Function)s</b>(<i>%(Params)s</i>) 119 <b>{Function}</b>(<i>{Params}</i>)
120 %(FunctionDescription)s 120 {FunctionDescription}
121 <div align="right"><a href="#top">Up</a></div> 121 <div align="right"><a href="#top">Up</a></div>
122 <hr />''' 122 <hr />'''
123 123
124 listTemplate = \ 124 listTemplate = \
125 '''<table> 125 '''<table>
126 %(Entries)s 126 {Entries}
127 </table>''' 127 </table>'''
128 128
129 listEntryTemplate = \ 129 listEntryTemplate = \
130 '''<tr> 130 '''<tr>
131 <td><a href="#%(Link)s">%(Name)s</a></td> 131 <td><a href="#{Link}">{Name}</a></td>
132 <td>%(Deprecated)s%(Description)s</td> 132 <td>{Deprecated}{Description}</td>
133 </tr>''' 133 </tr>'''
134 134
135 listEntryNoneTemplate = \ 135 listEntryNoneTemplate = \
136 '''<tr><td>None</td></tr>''' 136 '''<tr><td>None</td></tr>'''
137 137
138 listEntryDeprecatedTemplate = \ 138 listEntryDeprecatedTemplate = \
139 '''<b>Deprecated.</b>''' 139 '''<b>Deprecated.</b>'''
140 140
141 listEntrySimpleTemplate = \ 141 listEntrySimpleTemplate = \
142 '''<tr><td>%(Name)s</td></tr>''' 142 '''<tr><td>{Name}</td></tr>'''
143 143
144 paragraphTemplate = \ 144 paragraphTemplate = \
145 '''<p> 145 '''<p>
146 %(Lines)s 146 {Lines}
147 </p>''' 147 </p>'''
148 148
149 parametersListTemplate = \ 149 parametersListTemplate = \
150 '''<dl> 150 '''<dl>
151 %(Parameters)s 151 {Parameters}
152 </dl>''' 152 </dl>'''
153 153
154 parametersListEntryTemplate = \ 154 parametersListEntryTemplate = \
155 '''<dt><i>%(Name)s</i></dt> 155 '''<dt><i>{Name}</i></dt>
156 <dd> 156 <dd>
157 %(Description)s 157 {Description}
158 </dd>''' 158 </dd>'''
159 159
160 returnsTemplate = \ 160 returnsTemplate = \
161 '''<dl> 161 '''<dl>
162 <dt>Returns:</dt> 162 <dt>Returns:</dt>
165 </dd> 165 </dd>
166 </dl>''' 166 </dl>'''
167 167
168 exceptionsListTemplate = \ 168 exceptionsListTemplate = \
169 '''<dl> 169 '''<dl>
170 %(Exceptions)s 170 {Exceptions}
171 </dl>''' 171 </dl>'''
172 172
173 exceptionsListEntryTemplate = \ 173 exceptionsListEntryTemplate = \
174 '''<dt>Raises <b>%(Name)s</b>:</dt> 174 '''<dt>Raises <b>{Name}</b>:</dt>
175 <dd> 175 <dd>
176 %(Description)s 176 {Description}
177 </dd>''' 177 </dd>'''
178 178
179 signalsListTemplate = \ 179 signalsListTemplate = \
180 '''<h4>Signals</h4> 180 '''<h4>Signals</h4>
181 <dl> 181 <dl>
182 %(Signals)s 182 {Signals}
183 </dl>''' 183 </dl>'''
184 184
185 signalsListEntryTemplate = \ 185 signalsListEntryTemplate = \
186 '''<dt>%(Name)s</dt> 186 '''<dt>{Name}</dt>
187 <dd> 187 <dd>
188 %(Description)s 188 {Description}
189 </dd>''' 189 </dd>'''
190 190
191 eventsListTemplate = \ 191 eventsListTemplate = \
192 '''<h4>Events</h4> 192 '''<h4>Events</h4>
193 <dl> 193 <dl>
194 %(Events)s 194 {Events}
195 </dl>''' 195 </dl>'''
196 196
197 eventsListEntryTemplate = \ 197 eventsListEntryTemplate = \
198 '''<dt>%(Name)s</dt> 198 '''<dt>{Name}</dt>
199 <dd> 199 <dd>
200 %(Description)s 200 {Description}
201 </dd>''' 201 </dd>'''
202 202
203 deprecatedTemplate = \ 203 deprecatedTemplate = \
204 '''<p> 204 '''<p>
205 <b>Deprecated.</b> 205 <b>Deprecated.</b>
206 %(Lines)s 206 {Lines}
207 </p>''' 207 </p>'''
208 208
209 authorInfoTemplate = \ 209 authorInfoTemplate = \
210 '''<p> 210 '''<p>
211 <i>Author(s)</i>: 211 <i>Author(s)</i>:
212 %(Authors)s 212 {Authors}
213 </p>''' 213 </p>'''
214 214
215 seeListTemplate = \ 215 seeListTemplate = \
216 '''<dl> 216 '''<dl>
217 <dt><b>See Also:</b></dt> 217 <dt><b>See Also:</b></dt>
218 %(Links)s 218 {Links}
219 </dl>''' 219 </dl>'''
220 220
221 seeListEntryTemplate = \ 221 seeListEntryTemplate = \
222 '''<dd> 222 '''<dd>
223 %(Link)s 223 {Link}
224 </dd>''' 224 </dd>'''
225 225
226 seeLinkTemplate = \ 226 seeLinkTemplate = \
227 '''<a %(Link)s''' 227 '''<a {Link}'''
228 228
229 sinceInfoTemplate = \ 229 sinceInfoTemplate = \
230 '''<p> 230 '''<p>
231 <b>since</b> %(Info)s 231 <b>since</b> {Info}
232 </p>''' 232 </p>'''
233 233
234 ################################# 234 #################################
235 ## Templates for index files ## 235 ## Templates for index files ##
236 ################################# 236 #################################
237 237
238 indexBodyTemplate = ''' 238 indexBodyTemplate = '''
239 <h1>%(Title)s</h1> 239 <h1>{Title}</h1>
240 %(Description)s 240 {Description}
241 %(Subpackages)s 241 {Subpackages}
242 %(Modules)s''' 242 {Modules}'''
243 243
244 indexListPackagesTemplate = ''' 244 indexListPackagesTemplate = '''
245 <h3>Packages</h3> 245 <h3>Packages</h3>
246 <table> 246 <table>
247 %(Entries)s 247 {Entries}
248 </table>''' 248 </table>'''
249 249
250 indexListModulesTemplate = ''' 250 indexListModulesTemplate = '''
251 <h3>Modules</h3> 251 <h3>Modules</h3>
252 <table> 252 <table>
253 %(Entries)s 253 {Entries}
254 </table>''' 254 </table>'''
255 255
256 indexListEntryTemplate = \ 256 indexListEntryTemplate = \
257 '''<tr> 257 '''<tr>
258 <td><a href="%(Link)s">%(Name)s</a></td> 258 <td><a href="{Link}">{Name}</a></td>
259 <td>%(Description)s</td> 259 <td>{Description}</td>
260 </tr>''' 260 </tr>'''

Mercurial Repository: eric

eric ide

mercurial