Mercurial Repositories > eric / file comparison

comparison: eric6/DocumentationTools/TemplatesListsStyleCSS.py

eric6/DocumentationTools/TemplatesListsStyleCSS.py

changeset 7252
c5e3705073eb
parent 7229
53054eb5b15a
child 7360
9190402e4505
equal deleted inserted replaced
7251:bc5b1b00560a 7252:c5e3705073eb
10 10
11 ################################################# 11 #################################################
12 ## Common templates for index and docu files ## 12 ## Common templates for index and docu files ##
13 ################################################# 13 #################################################
14 14
15 headerTemplate = \ 15 headerTemplate = '''<!DOCTYPE html>
16 '''<!DOCTYPE html>
17 <html><head> 16 <html><head>
18 <title>{Title}</title> 17 <title>{Title}</title>
19 <meta charset="UTF-8"> 18 <meta charset="UTF-8">
20 <style> 19 <style>
21 {Style} 20 {Style}
28 27
29 ######################################### 28 #########################################
30 ## Templates for documentation files ## 29 ## Templates for documentation files ##
31 ######################################### 30 #########################################
32 31
33 moduleTemplate = \ 32 moduleTemplate = '''
34 '''<a NAME="top" ID="top"></a> 33 <a NAME="top" ID="top"></a>
35 <h1>{Module}</h1> 34 <h1>{Module}</h1>
36 {ModuleDescription} 35 {ModuleDescription}
37 <h3>Global Attributes</h3> 36 <h3>Global Attributes</h3>
38 {GlobalsList} 37 {GlobalsList}
39 <h3>Classes</h3> 38 <h3>Classes</h3>
40 {ClassList} 39 {ClassList}
41 <h3>Functions</h3> 40 <h3>Functions</h3>
42 {FunctionList} 41 {FunctionList}
43 <hr />''' 42 <hr />'''
44 43
45 rbFileTemplate = \ 44 rbFileTemplate = '''
46 '''<a NAME="top" ID="top"></a> 45 <a NAME="top" ID="top"></a>
47 <h1>{Module}</h1> 46 <h1>{Module}</h1>
48 {ModuleDescription} 47 {ModuleDescription}
49 <h3>Global Attributes</h3> 48 <h3>Global Attributes</h3>
50 {GlobalsList} 49 {GlobalsList}
51 <h3>Classes</h3> 50 <h3>Classes</h3>
54 {RbModulesList} 53 {RbModulesList}
55 <h3>Functions</h3> 54 <h3>Functions</h3>
56 {FunctionList} 55 {FunctionList}
57 <hr />''' 56 <hr />'''
58 57
59 classTemplate = \ 58 classTemplate = '''
60 '''<hr /> 59 <hr />
61 <a NAME="{Anchor}" ID="{Anchor}"></a> 60 <a NAME="{Anchor}" ID="{Anchor}"></a>
62 <h2>{Class}</h2> 61 <h2>{Class}</h2>
63 {ClassDescription} 62 {ClassDescription}
64 <h3>Derived from</h3> 63 <h3>Derived from</h3>
65 {ClassSuper} 64 {ClassSuper}
73 {StaticMethodList} 72 {StaticMethodList}
74 {MethodDetails} 73 {MethodDetails}
75 <div align="right"><a href="#top">Up</a></div> 74 <div align="right"><a href="#top">Up</a></div>
76 <hr />''' 75 <hr />'''
77 76
78 methodTemplate = \ 77 methodTemplate = '''
79 '''<a NAME="{Anchor}.{Method}" ID="{Anchor}.{Method}"></a> 78 <a NAME="{Anchor}.{Method}" ID="{Anchor}.{Method}"></a>
80 <h4>{Class}.{Method}{MethodClassifier}</h4> 79 <h4>{Class}.{Method}{MethodClassifier}</h4>
81 <b>{Method}</b>(<i>{Params}</i>) 80 <b>{Method}</b>(<i>{Params}</i>)
82 {MethodDescription}''' 81 {MethodDescription}'''
83 82
84 constructorTemplate = \ 83 constructorTemplate = '''
85 '''<a NAME="{Anchor}.{Method}" ID="{Anchor}.{Method}"></a> 84 <a NAME="{Anchor}.{Method}" ID="{Anchor}.{Method}"></a>
86 <h4>{Class} (Constructor)</h4> 85 <h4>{Class} (Constructor)</h4>
87 <b>{Class}</b>(<i>{Params}</i>) 86 <b>{Class}</b>(<i>{Params}</i>)
88 {MethodDescription}''' 87 {MethodDescription}'''
89 88
90 rbModuleTemplate = \ 89 rbModuleTemplate = '''
91 '''<hr /> 90 <hr />
92 <a NAME="{Anchor}" ID="{Anchor}"></a> 91 <a NAME="{Anchor}" ID="{Anchor}"></a>
93 <h2>{Module}</h2> 92 <h2>{Module}</h2>
94 {ModuleDescription} 93 {ModuleDescription}
95 <h3>Module Attributes</h3> 94 <h3>Module Attributes</h3>
96 {GlobalsList} 95 {GlobalsList}
102 {ClassesDetails} 101 {ClassesDetails}
103 {FunctionsDetails} 102 {FunctionsDetails}
104 <div align="right"><a href="#top">Up</a></div> 103 <div align="right"><a href="#top">Up</a></div>
105 <hr />''' 104 <hr />'''
106 105
107 rbModulesClassTemplate = \ 106 rbModulesClassTemplate = '''
108 '''<a NAME="{Anchor}" ID="{Anchor}"></a> 107 <a NAME="{Anchor}" ID="{Anchor}"></a>
109 <h2>{Class}</h2> 108 <h2>{Class}</h2>
110 {ClassDescription} 109 {ClassDescription}
111 <h3>Derived from</h3> 110 <h3>Derived from</h3>
112 {ClassSuper} 111 {ClassSuper}
113 <h3>Methods</h3> 112 <h3>Methods</h3>
114 {MethodList} 113 {MethodList}
115 {MethodDetails} 114 {MethodDetails}
116 <div align="right"><a href="#top">Up</a></div> 115 <div align="right"><a href="#top">Up</a></div>
117 <hr />''' 116 <hr />'''
118 117
119 functionTemplate = \ 118 functionTemplate = '''
120 '''<hr /> 119 <hr />
121 <a NAME="{Anchor}" ID="{Anchor}"></a> 120 <a NAME="{Anchor}" ID="{Anchor}"></a>
122 <h2>{Function}</h2> 121 <h2>{Function}</h2>
123 <b>{Function}</b>(<i>{Params}</i>) 122 <b>{Function}</b>(<i>{Params}</i>)
124 {FunctionDescription} 123 {FunctionDescription}
125 <div align="right"><a href="#top">Up</a></div> 124 <div align="right"><a href="#top">Up</a></div>
126 <hr />''' 125 <hr />'''
127 126
128 listTemplate = \ 127 listTemplate = '''
129 '''<table> 128 <table>
130 {Entries} 129 {Entries}
131 </table>''' 130 </table>'''
132 131
133 listEntryTemplate = \ 132 listEntryTemplate = '''
134 '''<tr> 133 <tr>
135 <td><a href="#{Link}">{Name}</a></td> 134 <td><a href="#{Link}">{Name}</a></td>
136 <td>{Deprecated}{Description}</td> 135 <td>{Deprecated}{Description}</td>
137 </tr>''' 136 </tr>'''
138 137
139 listEntryNoneTemplate = '''<tr><td>None</td></tr>''' 138 listEntryNoneTemplate = '''<tr><td>None</td></tr>'''
140 139
141 listEntryDeprecatedTemplate = '''<b>Deprecated.</b>''' 140 listEntryDeprecatedTemplate = '''<b>Deprecated.</b>'''
142 141
143 listEntrySimpleTemplate = '''<tr><td>{Name}</td></tr>''' 142 listEntrySimpleTemplate = '''<tr><td>{Name}</td></tr>'''
144 143
145 paragraphTemplate = \ 144 paragraphTemplate = '''
146 '''<p> 145 <p>
147 {Lines} 146 {Lines}
148 </p>''' 147 </p>'''
149 148
150 parametersListTemplate = \ 149 parametersListTemplate = '''
151 '''<dl> 150 <dl>
152 {Parameters} 151 {Parameters}
153 </dl>''' 152 </dl>'''
154 153
155 parametersListEntryTemplate = \ 154 parametersListEntryTemplate = '''
156 '''<dt><i>{Name}</i></dt> 155 <dt><i>{Name}</i></dt>
157 <dd> 156 <dd>
158 {Description} 157 {Description}
159 </dd>''' 158 </dd>'''
160 159
161 parameterTypesListEntryTemplate = \ 160 parameterTypesListEntryTemplate = '''
162 '''<dt><i>{Name}</i> ({Type})</dt> 161 <dt><i>{Name}</i> ({Type})</dt>
163 <dd> 162 <dd>
164 {Description} 163 {Description}
165 </dd>''' 164 </dd>'''
166 165
167 returnsTemplate = \ 166 returnsTemplate = '''
168 '''<dl> 167 <dl>
169 <dt>Returns:</dt> 168 <dt>Returns:</dt>
170 <dd> 169 <dd>
171 {0} 170 {0}
172 </dd> 171 </dd>
173 </dl>''' 172 </dl>'''
174 173
175 returnTypesTemplate = \ 174 returnTypesTemplate = '''
176 '''<dl> 175 <dl>
177 <dt>Return Type:</dt> 176 <dt>Return Type:</dt>
178 <dd> 177 <dd>
179 {0} 178 {0}
180 </dd> 179 </dd>
181 </dl>''' 180 </dl>'''
182 181
183 exceptionsListTemplate = \ 182 exceptionsListTemplate = '''
184 '''<dl> 183 <dl>
185 {Exceptions} 184 {Exceptions}
186 </dl>''' 185 </dl>'''
187 186
188 exceptionsListEntryTemplate = \ 187 exceptionsListEntryTemplate = '''
189 '''<dt>Raises <b>{Name}</b>:</dt> 188 <dt>Raises <b>{Name}</b>:</dt>
190 <dd> 189 <dd>
191 {Description} 190 {Description}
192 </dd>''' 191 </dd>'''
193 192
194 signalsListTemplate = \ 193 signalsListTemplate = '''
195 '''<h3>Signals</h3> 194 <h3>Signals</h3>
196 <dl> 195 <dl>
197 {Signals} 196 {Signals}
198 </dl>''' 197 </dl>'''
199 198
200 signalsListEntryTemplate = \ 199 signalsListEntryTemplate = '''
201 '''<dt>{Name}</dt> 200 <dt>{Name}</dt>
202 <dd> 201 <dd>
203 {Description} 202 {Description}
204 </dd>''' 203 </dd>'''
205 204
206 eventsListTemplate = \ 205 eventsListTemplate = '''
207 '''<h3>Events</h3> 206 <h3>Events</h3>
208 <dl> 207 <dl>
209 {Events} 208 {Events}
210 </dl>''' 209 </dl>'''
211 210
212 eventsListEntryTemplate = \ 211 eventsListEntryTemplate = '''
213 '''<dt>{Name}</dt> 212 <dt>{Name}</dt>
214 <dd> 213 <dd>
215 {Description} 214 {Description}
216 </dd>''' 215 </dd>'''
217 216
218 deprecatedTemplate = \ 217 deprecatedTemplate = '''
219 '''<p> 218 <p>
220 <b>Deprecated.</b> 219 <b>Deprecated.</b>
221 {Lines} 220 {Lines}
222 </p>''' 221 </p>'''
223 222
224 authorInfoTemplate = \ 223 authorInfoTemplate = '''
225 '''<p> 224 <p>
226 <i>Author(s)</i>: 225 <i>Author(s)</i>:
227 {Authors} 226 {Authors}
228 </p>''' 227 </p>'''
229 228
230 seeListTemplate = \ 229 seeListTemplate = '''
231 '''<dl> 230 <dl>
232 <dt><b>See Also:</b></dt> 231 <dt><b>See Also:</b></dt>
233 {Links} 232 {Links}
234 </dl>''' 233 </dl>'''
235 234
236 seeListEntryTemplate = \ 235 seeListEntryTemplate = '''
237 '''<dd> 236 <dd>
238 {Link} 237 {Link}
239 </dd>''' 238 </dd>'''
240 239
241 seeLinkTemplate = '''<a {Link}''' 240 seeLinkTemplate = '''<a {Link}'''
242 241
243 sinceInfoTemplate = \ 242 sinceInfoTemplate = '''
244 '''<p> 243 <p>
245 <b>since</b> {Info} 244 <b>since</b> {Info}
246 </p>''' 245 </p>'''
247 246
248 ################################# 247 #################################
249 ## Templates for index files ## 248 ## Templates for index files ##
265 <h3>Modules</h3> 264 <h3>Modules</h3>
266 <table> 265 <table>
267 {Entries} 266 {Entries}
268 </table>''' 267 </table>'''
269 268
270 indexListEntryTemplate = \ 269 indexListEntryTemplate = '''
271 '''<tr> 270 <tr>
272 <td><a href="{Link}">{Name}</a></td> 271 <td><a href="{Link}">{Name}</a></td>
273 <td>{Description}</td> 272 <td>{Description}</td>
274 </tr>''' 273 </tr>'''
275 274
276 # 275 #

Mercurial Repository: eric

eric ide

mercurial