Mercurial Repositories > eric / file comparison

comparison: DocumentationTools/TemplatesListsStyle.py

DocumentationTools/TemplatesListsStyle.py

branch
Py2 comp.
changeset 3057
10516539f238
parent 2525
8b507a9a2d40
parent 2989
7efa8b8b6903
child 3060
5883ce99ee12
equal deleted inserted replaced
3056:9986ec0e559a 3057:10516539f238
28 ## Templates for documentation files ## 28 ## Templates for documentation files ##
29 ######################################### 29 #########################################
30 30
31 moduleTemplate = \ 31 moduleTemplate = \
32 '''<a NAME="top" ID="top"></a> 32 '''<a NAME="top" ID="top"></a>
33 <h1 style="background-color:{Level1HeaderBgColor};color:{Level1HeaderColor}">{{Module}}</h1> 33 <h1 style="background-color:{Level1HeaderBgColor};color:{Level1HeaderColor}">
34 {{Module}}</h1>
34 {{ModuleDescription}} 35 {{ModuleDescription}}
35 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Global Attributes</h3> 36 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
36 {{GlobalsList}} 37 Global Attributes</h3>
37 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Classes</h3> 38 {{GlobalsList}}
39 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
40 Classes</h3>
38 {{ClassList}} 41 {{ClassList}}
39 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Functions</h3> 42 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
43 Functions</h3>
40 {{FunctionList}} 44 {{FunctionList}}
41 <hr />''' 45 <hr />'''
42 46
43 rbFileTemplate = \ 47 rbFileTemplate = \
44 '''<a NAME="top" ID="top"></a> 48 '''<a NAME="top" ID="top"></a>
45 <h1 style="background-color:{Level1HeaderBgColor};color:{Level1HeaderColor}">{{Module}}</h1> 49 <h1 style="background-color:{Level1HeaderBgColor};color:{Level1HeaderColor}">
50 {{Module}}</h1>
46 {{ModuleDescription}} 51 {{ModuleDescription}}
47 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Global Attributes</h3> 52 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
48 {{GlobalsList}} 53 Global Attributes</h3>
49 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Classes</h3> 54 {{GlobalsList}}
55 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
56 Classes</h3>
50 {{ClassList}} 57 {{ClassList}}
51 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Modules</h3> 58 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
59 Modules</h3>
52 {{RbModulesList}} 60 {{RbModulesList}}
53 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Functions</h3> 61 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
62 Functions</h3>
54 {{FunctionList}} 63 {{FunctionList}}
55 <hr />''' 64 <hr />'''
56 65
57 classTemplate = \ 66 classTemplate = \
58 '''<hr /> 67 '''<hr />
59 <a NAME="{{Anchor}}" ID="{{Anchor}}"></a> 68 <a NAME="{{Anchor}}" ID="{{Anchor}}"></a>
60 <h2 style="background-color:{CFBgColor};color:{CFColor}">{{Class}}</h2> 69 <h2 style="background-color:{CFBgColor};color:{CFColor}">{{Class}}</h2>
61 {{ClassDescription}} 70 {{ClassDescription}}
62 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Derived from</h3> 71 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
72 Derived from</h3>
63 {{ClassSuper}} 73 {{ClassSuper}}
64 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Class Attributes</h3> 74 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
65 {{GlobalsList}} 75 Class Attributes</h3>
66 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Class Methods</h3> 76 {{GlobalsList}}
77 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
78 Class Methods</h3>
67 {{ClassMethodList}} 79 {{ClassMethodList}}
68 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Methods</h3> 80 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
81 Methods</h3>
69 {{MethodList}} 82 {{MethodList}}
70 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Static Methods</h3> 83 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
84 Static Methods</h3>
71 {{StaticMethodList}} 85 {{StaticMethodList}}
72 {{MethodDetails}} 86 {{MethodDetails}}
73 <div align="right"><a style="color:{LinkColor}" href="#top">Up</a></div> 87 <div align="right"><a style="color:{LinkColor}" href="#top">Up</a></div>
74 <hr />''' 88 <hr />'''
75 89
76 methodTemplate = \ 90 methodTemplate = \
77 '''<a NAME="{{Anchor}}.{{Method}}" ID="{{Anchor}}.{{Method}}"></a> 91 '''<a NAME="{{Anchor}}.{{Method}}" ID="{{Anchor}}.{{Method}}"></a>
78 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">{{Class}}.{{Method}}{{MethodClassifier}}</h3> 92 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
93 {{Class}}.{{Method}}{{MethodClassifier}}</h3>
79 <b>{{Method}}</b>(<i>{{Params}}</i>) 94 <b>{{Method}}</b>(<i>{{Params}}</i>)
80 {{MethodDescription}}''' 95 {{MethodDescription}}'''
81 96
82 constructorTemplate = \ 97 constructorTemplate = \
83 '''<a NAME="{{Anchor}}.{{Method}}" ID="{{Anchor}}.{{Method}}"></a> 98 '''<a NAME="{{Anchor}}.{{Method}}" ID="{{Anchor}}.{{Method}}"></a>
84 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">{{Class}} (Constructor)</h3> 99 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
100 {{Class}} (Constructor)</h3>
85 <b>{{Class}}</b>(<i>{{Params}}</i>) 101 <b>{{Class}}</b>(<i>{{Params}}</i>)
86 {{MethodDescription}}''' 102 {{MethodDescription}}'''
87 103
88 rbModuleTemplate = \ 104 rbModuleTemplate = \
89 '''<hr /> 105 '''<hr />
90 <a NAME="{{Anchor}}" ID="{{Anchor}}"></a> 106 <a NAME="{{Anchor}}" ID="{{Anchor}}"></a>
91 <h2 style="background-color:{CFBgColor};color:{CFColor}">{{Module}}</h2> 107 <h2 style="background-color:{CFBgColor};color:{CFColor}">{{Module}}</h2>
92 {{ModuleDescription}} 108 {{ModuleDescription}}
93 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Module Attributes</h3> 109 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
94 {{GlobalsList}} 110 Module Attributes</h3>
95 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Classes</h3> 111 {{GlobalsList}}
112 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
113 Classes</h3>
96 {{ClassesList}} 114 {{ClassesList}}
97 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Functions</h3> 115 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
116 Functions</h3>
98 {{FunctionsList}} 117 {{FunctionsList}}
99 <hr /> 118 <hr />
100 {{ClassesDetails}} 119 {{ClassesDetails}}
101 {{FunctionsDetails}} 120 {{FunctionsDetails}}
102 <div align="right"><a style="color:{LinkColor}" href="#top">Up</a></div> 121 <div align="right"><a style="color:{LinkColor}" href="#top">Up</a></div>
104 123
105 rbModulesClassTemplate = \ 124 rbModulesClassTemplate = \
106 '''<a NAME="{{Anchor}}" ID="{{Anchor}}"></a> 125 '''<a NAME="{{Anchor}}" ID="{{Anchor}}"></a>
107 <h2 style="background-color:{CFBgColor};color:{CFColor}">{{Class}}</h2> 126 <h2 style="background-color:{CFBgColor};color:{CFColor}">{{Class}}</h2>
108 {{ClassDescription}} 127 {{ClassDescription}}
109 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Derived from</h3> 128 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
129 Derived from</h3>
110 {{ClassSuper}} 130 {{ClassSuper}}
111 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Methods</h3> 131 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
132 Methods</h3>
112 {{MethodList}} 133 {{MethodList}}
113 {{MethodDetails}} 134 {{MethodDetails}}
114 <div align="right"><a style="color:{LinkColor}" href="#top">Up</a></div> 135 <div align="right"><a style="color:{LinkColor}" href="#top">Up</a></div>
115 <hr />''' 136 <hr />'''
116 137
236 ################################# 257 #################################
237 ## Templates for index files ## 258 ## Templates for index files ##
238 ################################# 259 #################################
239 260
240 indexBodyTemplate = ''' 261 indexBodyTemplate = '''
241 <h1 style="background-color:{Level1HeaderBgColor};color:{Level1HeaderColor}">{{Title}}</h1> 262 <h1 style="background-color:{Level1HeaderBgColor};color:{Level1HeaderColor}">
263 {{Title}}</h1>
242 {{Description}} 264 {{Description}}
243 {{Subpackages}} 265 {{Subpackages}}
244 {{Modules}}''' 266 {{Modules}}'''
245 267
246 indexListPackagesTemplate = ''' 268 indexListPackagesTemplate = '''
247 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Packages</h3> 269 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
270 Packages</h3>
248 <table> 271 <table>
249 {{Entries}} 272 {{Entries}}
250 </table>''' 273 </table>'''
251 274
252 indexListModulesTemplate = ''' 275 indexListModulesTemplate = '''
253 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">Modules</h3> 276 <h3 style="background-color:{Level2HeaderBgColor};color:{Level2HeaderColor}">
277 Modules</h3>
254 <table> 278 <table>
255 {{Entries}} 279 {{Entries}}
256 </table>''' 280 </table>'''
257 281
258 indexListEntryTemplate = \ 282 indexListEntryTemplate = \

Mercurial Repository: eric

eric ide

mercurial