Mercurial Repositories > eric / file comparison
comparison: eric6/DocumentationTools/TemplatesListsStyle.py
eric6/DocumentationTools/TemplatesListsStyle.py
- changeset 6942
- 2602857055c5
- parent 6645
- ad476851d7e0
- child 7229
- 53054eb5b15a
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 # -*- coding: utf-8 -*- | |
| 2 | |
| 3 # Copyright (c) 2004 - 2019 Detlev Offenbach <detlev@die-offenbachs.de> | |
| 4 # | |
| 5 | |
| 6 """ | |
| 7 Module implementing templates for the documentation generator (lists style). | |
| 8 """ | |
| 9 | |
| 10 from __future__ import unicode_literals | |
| 11 | |
| 12 ################################################# | |
| 13 ## Common templates for index and docu files ## | |
| 14 ################################################# | |
| 15 | |
| 16 headerTemplate = \ | |
| 17 '''<!DOCTYPE html> | |
| 18 <html><head> | |
| 19 <title>{{Title}}</title> | |
| 20 <meta charset="UTF-8"> | |
| 21 </head> | |
| 22 <body style="background-color:{BodyBgColor};color:{BodyColor}">''' | |
| 23 | |
| 24 footerTemplate = ''' | |
| 25 </body></html>''' | |
| 26 | |
| 27 ######################################### | |
| 28 ## Templates for documentation files ## | |
| 29 ######################################### | |
| 30 | |
| 31 moduleTemplate = \ | |
| 32 '''<a NAME="top" ID="top"></a> | |
| 33 <h1 style="background-color:{Level1HeaderBgColor};color:{Level1HeaderColor}"> | |
| 34 {{Module}}</h1> | |
| 35 {{ModuleDescription}} | |
| 36 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 37 Global Attributes</h3> | |
| 38 {{GlobalsList}} | |
| 39 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 40 Classes</h3> | |
| 41 {{ClassList}} | |
| 42 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 43 Functions</h3> | |
| 44 {{FunctionList}} | |
| 45 <hr />''' | |
| 46 | |
| 47 rbFileTemplate = \ | |
| 48 '''<a NAME="top" ID="top"></a> | |
| 49 <h1 style="background-color:{Level1HeaderBgColor};color:{Level1HeaderColor}"> | |
| 50 {{Module}}</h1> | |
| 51 {{ModuleDescription}} | |
| 52 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 53 Global Attributes</h3> | |
| 54 {{GlobalsList}} | |
| 55 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 56 Classes</h3> | |
| 57 {{ClassList}} | |
| 58 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 59 Modules</h3> | |
| 60 {{RbModulesList}} | |
| 61 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 62 Functions</h3> | |
| 63 {{FunctionList}} | |
| 64 <hr />''' | |
| 65 | |
| 66 classTemplate = \ | |
| 67 '''<hr /> | |
| 68 <a NAME="{{Anchor}}" ID="{{Anchor}}"></a> | |
| 69 <h2 style="background-color:{CFBgColor};color:{CFColor}">{{Class}}</h2> | |
| 70 {{ClassDescription}} | |
| 71 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 72 Derived from</h3> | |
| 73 {{ClassSuper}} | |
| 74 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 75 Class Attributes</h3> | |
| 76 {{GlobalsList}} | |
| 77 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 78 Class Methods</h3> | |
| 79 {{ClassMethodList}} | |
| 80 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 81 Methods</h3> | |
| 82 {{MethodList}} | |
| 83 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 84 Static Methods</h3> | |
| 85 {{StaticMethodList}} | |
| 86 {{MethodDetails}} | |
| 87 <div align="right"><a style="color:{LinkColor}" href="#top">Up</a></div> | |
| 88 <hr />''' | |
| 89 | |
| 90 methodTemplate = \ | |
| 91 '''<a NAME="{{Anchor}}.{{Method}}" ID="{{Anchor}}.{{Method}}"></a> | |
| 92 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 93 {{Class}}.{{Method}}{{MethodClassifier}}</h3> | |
| 94 <b>{{Method}}</b>(<i>{{Params}}</i>) | |
| 95 {{MethodDescription}}''' | |
| 96 | |
| 97 constructorTemplate = \ | |
| 98 '''<a NAME="{{Anchor}}.{{Method}}" ID="{{Anchor}}.{{Method}}"></a> | |
| 99 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 100 {{Class}} (Constructor)</h3> | |
| 101 <b>{{Class}}</b>(<i>{{Params}}</i>) | |
| 102 {{MethodDescription}}''' | |
| 103 | |
| 104 rbModuleTemplate = \ | |
| 105 '''<hr /> | |
| 106 <a NAME="{{Anchor}}" ID="{{Anchor}}"></a> | |
| 107 <h2 style="background-color:{CFBgColor};color:{CFColor}">{{Module}}</h2> | |
| 108 {{ModuleDescription}} | |
| 109 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 110 Module Attributes</h3> | |
| 111 {{GlobalsList}} | |
| 112 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 113 Classes</h3> | |
| 114 {{ClassesList}} | |
| 115 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 116 Functions</h3> | |
| 117 {{FunctionsList}} | |
| 118 <hr /> | |
| 119 {{ClassesDetails}} | |
| 120 {{FunctionsDetails}} | |
| 121 <div align="right"><a style="color:{LinkColor}" href="#top">Up</a></div> | |
| 122 <hr />''' | |
| 123 | |
| 124 rbModulesClassTemplate = \ | |
| 125 '''<a NAME="{{Anchor}}" ID="{{Anchor}}"></a> | |
| 126 <h2 style="background-color:{CFBgColor};color:{CFColor}">{{Class}}</h2> | |
| 127 {{ClassDescription}} | |
| 128 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 129 Derived from</h3> | |
| 130 {{ClassSuper}} | |
| 131 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 132 Methods</h3> | |
| 133 {{MethodList}} | |
| 134 {{MethodDetails}} | |
| 135 <div align="right"><a style="color:{LinkColor}" href="#top">Up</a></div> | |
| 136 <hr />''' | |
| 137 | |
| 138 functionTemplate = \ | |
| 139 '''<hr /> | |
| 140 <a NAME="{{Anchor}}" ID="{{Anchor}}"></a> | |
| 141 <h2 style="background-color:{CFBgColor};color:{CFColor}">{{Function}}</h2> | |
| 142 <b>{{Function}}</b>(<i>{{Params}}</i>) | |
| 143 {{FunctionDescription}} | |
| 144 <div align="right"><a style="color:{LinkColor}" href="#top">Up</a></div> | |
| 145 <hr />''' | |
| 146 | |
| 147 listTemplate = \ | |
| 148 '''<table> | |
| 149 {{Entries}} | |
| 150 </table>''' | |
| 151 | |
| 152 listEntryTemplate = \ | |
| 153 '''<tr> | |
| 154 <td><a style="color:{LinkColor}" href="#{{Link}}">{{Name}}</a></td> | |
| 155 <td>{{Deprecated}}{{Description}}</td> | |
| 156 </tr>''' | |
| 157 | |
| 158 listEntryNoneTemplate = '''<tr><td>None</td></tr>''' | |
| 159 | |
| 160 listEntryDeprecatedTemplate = '''<b>Deprecated.</b>''' | |
| 161 | |
| 162 listEntrySimpleTemplate = '''<tr><td>{{Name}}</td></tr>''' | |
| 163 | |
| 164 paragraphTemplate = \ | |
| 165 '''<p> | |
| 166 {{Lines}} | |
| 167 </p>''' | |
| 168 | |
| 169 parametersListTemplate = \ | |
| 170 '''<dl> | |
| 171 {{Parameters}} | |
| 172 </dl>''' | |
| 173 | |
| 174 parametersListEntryTemplate = \ | |
| 175 '''<dt><i>{{Name}}</i></dt> | |
| 176 <dd> | |
| 177 {{Description}} | |
| 178 </dd>''' | |
| 179 | |
| 180 parameterTypesListEntryTemplate = \ | |
| 181 '''<dt><i>{{Name}}</i> ({{Type}})</dt> | |
| 182 <dd> | |
| 183 {{Description}} | |
| 184 </dd>''' | |
| 185 | |
| 186 returnsTemplate = \ | |
| 187 '''<dl> | |
| 188 <dt>Returns:</dt> | |
| 189 <dd> | |
| 190 {{0}} | |
| 191 </dd> | |
| 192 </dl>''' | |
| 193 | |
| 194 returnTypesTemplate = \ | |
| 195 '''<dl> | |
| 196 <dt>Return Type:</dt> | |
| 197 <dd> | |
| 198 {{0}} | |
| 199 </dd> | |
| 200 </dl>''' | |
| 201 | |
| 202 exceptionsListTemplate = \ | |
| 203 '''<dl> | |
| 204 {{Exceptions}} | |
| 205 </dl>''' | |
| 206 | |
| 207 exceptionsListEntryTemplate = \ | |
| 208 '''<dt>Raises <b>{{Name}}</b>:</dt> | |
| 209 <dd> | |
| 210 {{Description}} | |
| 211 </dd>''' | |
| 212 | |
| 213 signalsListTemplate = \ | |
| 214 '''<h4>Signals</h4> | |
| 215 <dl> | |
| 216 {{Signals}} | |
| 217 </dl>''' | |
| 218 | |
| 219 signalsListEntryTemplate = \ | |
| 220 '''<dt>{{Name}}</dt> | |
| 221 <dd> | |
| 222 {{Description}} | |
| 223 </dd>''' | |
| 224 | |
| 225 eventsListTemplate = \ | |
| 226 '''<h4>Events</h4> | |
| 227 <dl> | |
| 228 {{Events}} | |
| 229 </dl>''' | |
| 230 | |
| 231 eventsListEntryTemplate = \ | |
| 232 '''<dt>{{Name}}</dt> | |
| 233 <dd> | |
| 234 {{Description}} | |
| 235 </dd>''' | |
| 236 | |
| 237 deprecatedTemplate = \ | |
| 238 '''<p> | |
| 239 <b>Deprecated.</b> | |
| 240 {{Lines}} | |
| 241 </p>''' | |
| 242 | |
| 243 authorInfoTemplate = \ | |
| 244 '''<p> | |
| 245 <i>Author(s)</i>: | |
| 246 {{Authors}} | |
| 247 </p>''' | |
| 248 | |
| 249 seeListTemplate = \ | |
| 250 '''<dl> | |
| 251 <dt><b>See Also:</b></dt> | |
| 252 {{Links}} | |
| 253 </dl>''' | |
| 254 | |
| 255 seeListEntryTemplate = \ | |
| 256 '''<dd> | |
| 257 {{Link}} | |
| 258 </dd>''' | |
| 259 | |
| 260 seeLinkTemplate = '''<a style="color:{LinkColor}" {{Link}}''' | |
| 261 | |
| 262 sinceInfoTemplate = \ | |
| 263 '''<p> | |
| 264 <b>since</b> {{Info}} | |
| 265 </p>''' | |
| 266 | |
| 267 ################################# | |
| 268 ## Templates for index files ## | |
| 269 ################################# | |
| 270 | |
| 271 indexBodyTemplate = ''' | |
| 272 <h1 style="background-color:{Level1HeaderBgColor};color:{Level1HeaderColor}"> | |
| 273 {{Title}}</h1> | |
| 274 {{Description}} | |
| 275 {{Subpackages}} | |
| 276 {{Modules}}''' | |
| 277 | |
| 278 indexListPackagesTemplate = ''' | |
| 279 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 280 Packages</h3> | |
| 281 <table> | |
| 282 {{Entries}} | |
| 283 </table>''' | |
| 284 | |
| 285 indexListModulesTemplate = ''' | |
| 286 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}"> | |
| 287 Modules</h3> | |
| 288 <table> | |
| 289 {{Entries}} | |
| 290 </table>''' | |
| 291 | |
| 292 indexListEntryTemplate = \ | |
| 293 '''<tr> | |
| 294 <td><a style="color:{LinkColor}" href="{{Link}}">{{Name}}</a></td> | |
| 295 <td>{{Description}}</td> | |
| 296 </tr>''' | |
| 297 | |
| 298 # | |
| 299 # eflag: noqa = E122 |
