Mercurial Repositories > eric / file comparison

comparison: DocumentationTools/TemplatesListsStyle.py

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

Mercurial Repository: eric

eric ide

mercurial