root/trunk/idldoc/src/templates/profile.tt @ 626

Revision 626, 14.4 KB (checked in by mgalloy, 3 years ago)

Modifying appearance of source code link for individual routines.
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4<!-- Generated by IDLdoc [% idldoc_version %] on [% date %] -->
5
6<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html;charset=[% charset %]"/>
9    <title>[% basename %] ([% title %])</title>
10
11    [% IF embed %]
12    <style type="text/css" media="all">
13      [% INCLUDE css_location %]
14    </style>
15    <style type="text/css" media="print">
16      [% INCLUDE print_css_location %]
17    </style>
18    [% ELSE %]
19    <link rel="stylesheet" type="text/css" media="all"
20          href="[% relative_root %]idldoc-resources/main.css" />
21    <link rel="stylesheet" type="text/css" media="print"
22          href="[% relative_root %]idldoc-resources/main-print.css" />
23    [% END %]
24   
25    <script type="text/javascript">
26      function setTitle() {
27        parent.document.title="[% basename %] ([% title %])";
28      }
29    </script>
30  </head>
31   
32  <body onload="setTitle();" id="root">
33
34    [% INCLUDE_TEMPLATE idldoc_header_location %]
35   
36    <div class="content">
37      <h2 class="directory">[% location %]</h2>
38      <h1 class="basename">[% basename %]<span class="file-attributes">[% IF is_abstract %]abstract&nbsp; [% END %][% IF is_obsolete %]obsolete&nbsp; [% END %]</span></h1>
39            [% IF has_categories %]
40            <p class="small categories">[% strjoin(categories, ', ') %]</p>
41            [% END %]     
42     
43      [% IF is_batch %]<span class="file_attribute small">batch file</span>[% END %]
44      [% IF has_main_level %]<span class="file_attribute small">includes main-level program</span>[% END %]
45            [% IF is_private %]<span class="file_attribute small">private</span>[% END %]
46
47      [% IF has_comments %]
48      <div id="file_comments">
49        <div class="small [% IF preformat %]pre[% END %]">[% comments %]</div>
50      </div>
51      [% END %]
52
53      [% IF has_examples %]
54      <h2>Examples</h2>
55     
56      <div class="small">[% examples %]</div>     
57      [% END %]
58     
59      [% IF has_class %][% FOREACH class IN classes %][% SCOPE class %]
60      <div class="class-description">
61        <h2>Class description for [% classname %]</h2>
62     
63          [% IF n_ancestors gt 0 %]
64          <h3>Inheritance</h3>
65            <ul>
66              [% FOREACH p IN parents %]
67              <li>[% IF p->hasUrl() %]<a href="[% relative_root %][% p->getUrl() %]">[% END %][% p->getClassname() %][% IF p->hasUrl() %]</a>[% END %]</li>
68              [% END %]
69            </ul>
70       
71            [% IF n_ancestors gt n_parents %]     
72            <p class="small">All ancestor classes:
73                        [% FOREACH a IN ancestors %]
74                        [% IF a->hasUrl() %]<a href="[% relative_root %][% a->getUrl() %]">[% END %][% a->getClassname() %][% IF a->hasUrl() %]</a>[% END %]
75                        [% END %]
76                </p>
77                [% END %]
78          [% END %]
79     
80          [% IF n_children gt 0 %]
81            <p class="small">Subclasses:
82              [% FOREACH c IN children %]
83              [% IF c->hasUrl() %]<a href="[% relative_root %][% c->getUrl() %]">[% END %][% c->getClassname() %][% IF c->hasUrl() %]</a>[% END %]
84              [% END %]
85            </p>     
86          [% END %]
87     
88          [% IF n_properties gt 0 %]
89          <h3>Properties</h3>
90                <div class="details">
91                <dl>
92                  [% FOREACH p IN properties %][% SCOPE p %]
93                  <dt>[% name %] <span class="smaller">[% IF is_get %]get [% END %][% IF is_set %]set [% END %][% IF is_init %]init [% END %][% IF has_type %]type=[% type %][% END %]</span></dt>
94                  <dd class="small">[% comments %]</dd>
95                  [% END %][% END %]
96                </dl> 
97            </div>   
98          [% END %]
99     
100          [% IF n_fields gt 0 && ~user %]
101          <h3>Fields</h3>
102                <div class="details">
103                <dl>
104                  [% FOREACH f IN fields %][% SCOPE f %]
105                  <dt>[% name %] <span class="smaller">[% type %]</span></dt>
106                  <dd class="small">[% comments %]</dd>
107                  [% END %][% END %]
108                </dl>           
109                </div>
110          [% END %]
111     
112          [% IF n_ancestors gt 0 && ~user %]
113          [% FOREACH a IN ancestors %][% SCOPE a %]
114                [% IF n_fields gt 0 %]
115                <h4>Fields in [% IF has_url %]<a href="[% relative_root %][% url %]">[% END %][% classname %][% IF has_url %]</a>[% END %]</h4>
116                <ul class="fieldslist smaller">
117                  [% FOREACH f IN fields %][% SCOPE f %]
118                  <li><span class="fieldname">[% name %]</span> [% type %]</li>
119                  [% END %][% END %]
120                </ul>
121                [% END %]
122          [% END %][% END %]
123        [% END %]
124      </div>     
125      [% END %][% END %][% END %]
126     
127      [% IF has_author_info %]
128      <h2>Author information</h2>
129
130        <dl class="attribute small" summary="File author information">
131          [% IF has_author %]
132            <dt>Author</dt>
133            <dd>[% author %]</dd>       
134          [% END %]
135         
136          [% IF has_copyright %]
137            <dt>Copyright</dt>
138            <dd>[% copyright %]</dd>       
139          [% END %]
140         
141          [% IF has_history %]
142            <dt>History</dt>
143            <dd>[% history %]</dd>       
144          [% END %]
145
146          [% IF has_version %]
147            <dt>Version</dt>
148            <dd>[% version %]</dd> 
149          [% END %]         
150        </dl>         
151      [% END %]
152                       
153      [% IF has_others %]
154      <h2>Other file information</h2>
155     
156        <dl class="attribute small" summary="Other file attributes">
157        [% IF has_bugs %]
158            <dt>Bugs:</dt>
159            <dd>[% bugs %]</dd>
160        [% END %]
161               
162        [% IF has_customer_id %]
163            <dt>Customer ID:</dt>
164            <dd>[% customer_id %]</dd>
165        [% END %]
166
167        [% IF has_requires %]
168            <dt>Requires:</dt>
169            <dd>[% requires %]</dd>     
170        [% END %]
171               
172        [% IF has_restrictions %]
173            <dt>Restrictions:</dt>
174            <dd>[% restrictions %]</dd>
175        [% END %]
176
177        [% IF has_todo %]
178            <dt>Todo:</dt>
179            <dd>[% todo %]</dd>
180        [% END %]
181               
182        [% IF has_uses %]
183            <dt>Uses:</dt>
184            <dd>[% uses %]</dd>
185        [% END %]
186        </dl>
187      [% END %]
188     
189      [% IF n_visible_routines gt 1 %]
190      <div>
191        <h2>Routines</h2>
192     
193        <dl class="routine-summary">
194          [% FOREACH r IN visible_routines %][% SCOPE r %]
195            <dt class="syntax"><a href="#[% name %]"><code>[% IF is_function %]<span class="var">result</span> = [% END %][% name %][% IF is_function %]([% END %][% IF n_visible_parameters gt 0 %][% FOREACH p IN visible_parameters %][% SCOPE p %]<span class="argument">[% IF is_optional %] [[% END %][% prefix %][% name %][% suffix %][% IF is_optional %]][% END %]</span>[% END %][% END %][% END %][% IF n_visible_keywords gt 0 %][% FOREACH k IN visible_keywords %][% SCOPE k %]<span class="argument">[% IF is_optional %] [[% END %][% prefix %][% IF is_boolean %]/[% END %][% name %][% IF ~is_boolean %]=<span class="var">[% IF type ne '' %][% type %][% ELSE %][% name %][% END %]</span>[% END %][% suffix %][% IF is_optional %]][% END %]</span>[% END %][% END %][% END %][% IF is_function %])[% END %]</code></a></dt>
196            <dd class="small">[% comments_first_line %]</dd>
197          [% END %][% END %]
198        </dl>
199      </div>
200      [% END %]
201     
202               
203        [% IF n_visible_routines gt 0 %]
204        <div id="routine-details">
205          [% IF n_visible_routines gt 1 %]<h2>Routine details</h2>[% END %]
206       
207        [% FOREACH r IN visible_routines %][% SCOPE r %]
208        <div class="routine-details details" id="[% name %]">
209                <h2 class="routine-name"><a href="#root" class="top">top</a>[% name %]<span class="routine-attributes">[% IF is_private %]private [% END %][% IF is_obsolete %]obsolete [% END %][% IF is_abstract %]abstract [% END %]</span></h2>
210                [% IF ~nosource %]<a href="[% source_url %]#[% name %]:source">source</a>[% END %]
211               
212                [% IF has_categories %]
213                <p class="small categories">[% strjoin(categories, ', ') %]</p>
214                [% END %]
215               
216          <p class="syntax"><code>[% IF is_function %]<span class="var">result</span> = [% END %][% name %][% IF is_function %]([% END %][% IF n_visible_parameters gt 0 %][% FOREACH p IN visible_parameters %][% SCOPE p %]<span class="argument">[% IF is_optional %] [[% END %][% prefix %]<a href="#[% id %]">[% name %]</a>[% suffix %][% IF is_optional %]][% END %]</span>[% END %][% END %][% END %][% IF n_visible_keywords gt 0 %][% FOREACH k IN visible_keywords %][% SCOPE k %]<span class="argument">[% IF is_optional %] [[% END %][% prefix %][% IF is_boolean %]/[% END %]<a href="#[% id %]">[% name %]</a>[% IF ~is_boolean %]=<span class="var">[% IF type ne '' %][% type %][% ELSE %][% name %][% END %]</span>[% END %][% suffix %][% IF is_optional %]][% END %]</span>[% END %][% END %][% END %][% IF is_function %])[% END %]</code></p>
217         
218          [% IF has_comments %]
219          <div class="small [% IF preformat %]pre[% END %]">[% comments %]</div>
220          [% END %]
221         
222          [% IF is_function and has_returns %]
223          <h3>Return value</h3>
224                <div class="small">[% returns %]</div>
225          [% END %]
226         
227          [% IF n_parameters gt 0 %]
228          <h3>Parameters</h3>
229            <dl>
230              [% FOREACH p IN parameters %][% SCOPE p %]
231              <dt id="[% id %]">[% name %] <span class="smaller">[% IF is_input %]in [% END %][% IF is_output %]out [% END %][% IF is_optional %]optional [% END %][% IF is_required %]required [% END %][% IF is_private %]private [% END %][% IF is_hidden %]hidden [% END %][% IF is_obsolete %]obsolete [% END %][% IF type ne '' %]type=[% type %] [% END %][% IF default_value ne '' %]default=[% default_value %][% END %]</span></dt>
232              <dd class="small">[% comments %]</dd>
233              [% END %][% END %]
234            </dl>
235          [% END %]
236         
237          [% IF n_keywords gt 0 %]
238          <h3>Keywords</h3>
239            <dl>
240              [% FOREACH k IN keywords %][% SCOPE k %]
241              <dt id="[% id %]">[% name %] <span class="smaller">[% IF is_input %]in [% END %][% IF is_output %]out [% END %][% IF is_optional %]optional [% END %][% IF is_required %]required [% END %][% IF is_private %]private [% END %][% IF is_hidden %]hidden [% END %][% IF is_obsolete %]obsolete [% END %][% IF type ne '' %]type=[% type %] [% END %][% IF default_value ne '' %]default=[% default_value %][% END %]</span></dt>
242              <dd class="small">[% comments %]</dd>
243              [% END %][% END %]
244            </dl>
245          [% END %]
246         
247          [% IF has_examples %]
248          <h3>Examples</h3>
249          <div>[% examples %]</div>
250          [% END %]
251         
252          [% IF has_author_info %]
253          <h3>Author information</h3>
254
255            <dl class="attribute small" summary="Routine author information">
256              [% IF has_author %]
257                <dt>Author:</dt>
258                <dd>[% author %]</dd>       
259              [% END %]
260             
261              [% IF has_copyright %]
262                <dt>Copyright:</dt>
263                <dd>[% copyright %]</dd>       
264              [% END %]
265             
266              [% IF has_history %]
267                <dt>History:</dt>
268                <dd>[% history %]</dd>   
269              [% END %]
270
271              [% IF has_version %]
272                <dt>Version:</dt>
273                <dd>[% version %]</dd>     
274              [% END %]             
275            </dl>         
276          [% END %]
277         
278          [% IF has_others %]
279          <h3>Other attributes</h3>
280
281            <dl class="attribute small" summary="Other routine attributes">                           
282              [% IF has_todo %]
283                <dt>Todo:</dt>
284                <dd>[% todo %]</dd>
285              [% END %]
286
287              [% IF has_restrictions %]
288                <dt>Restrictions:</dt>
289                <dd>[% restrictions %]</dd>
290              [% END %]
291
292              [% IF has_requires %]
293                <dt>Requires:</dt>
294                <dd>[% requires %]</dd>
295              [% END %]
296             
297              [% IF has_uses %]
298                <dt>Uses:</dt>
299                <dd>[% uses %]</dd>
300              [% END %]
301                                                     
302              [% IF has_bugs %]
303                <dt>Bugs:</dt>
304                <dd>[% bugs %]</dd>       
305              [% END %]
306
307              [% IF has_pre %]
308                <dt>Pre-condition:</dt>
309                <dd>[% pre %]</dd>
310              [% END %]
311
312              [% IF has_post %]
313                <dt>Post-condition:</dt>
314                <dd>[% post %]</dd>   
315              [% END %]     
316
317              [% IF has_customer_id %]
318                <dt>Customer ID:</dt>
319                <dd>[% customer_id %]</dd>         
320              [% END %]                                     
321            </dl>
322          [% END %]
323         
324          [% IF statistics %]
325          <h3>Statistics</h3>
326
327                        <table class="attribute small" summary="Routine statistics">
328                          <tr>
329                            <td class="name">Lines:</td>
330                            <td><div class="box [% n_lines_color %]"></div> [% n_lines %] lines</td>
331                          </tr>
332
333                          <tr>
334                            <td class="name">McCabe complexity:</td>
335                            <td><div class="box [% complexity_color %]"></div> [% complexity %]</td>
336                          </tr>                                                         
337                        </table>
338          [% END %]
339                   
340        </div>           
341        [% END %][% END %]
342           
343      </div>
344      [% END %]
345     
346      <div id="attributes">
347        <h2>File attributes</h2>
348               
349        <table class="attribute small" summary="File attributes">
350          <tr>
351            <td class="name">Modification date:</td>
352            <td>[% modification_time %]</td>
353          </tr>
354
355          <tr>
356            <td class="name">Lines:</td>
357            <td>[% n_lines %]</td>
358          </tr>
359               
360          [% IF format ne '' || markup ne '' %]             
361          <tr>
362            <td class="name">Docformat:</td>
363            <td>[% format %][% IF format ne '' %] [% END %][% markup %]</td>
364          </tr>
365          [% END %]
366        </table>
367      </div>
368     
369      [% IF footer ne '' %][% INCLUDE_TEMPLATE footer %][% END %]
370    </div>
371   
372    [% INCLUDE_TEMPLATE idldoc_footer_location %]   
373  </body>
374</html>
Note: See TracBrowser for help on using the browser.