Mercurial Repositories > eric / file comparison

comparison: DocumentationTools/TemplatesListsStyle.py

DocumentationTools/TemplatesListsStyle.py

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

Mercurial Repository: eric

eric ide

mercurial