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