← Back to branch summary

~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/DocumentationTools/TemplatesListsStyle.py

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

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