rdoc 2.3.0 → 2.4.0

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.

This version of rdoc might be problematic. Click here for more details.

Files changed (81) hide show
  1. data.tar.gz.sig +0 -0
  2. data/.autotest +14 -0
  3. data/History.txt +27 -0
  4. data/Manifest.txt +29 -9
  5. data/Rakefile +2 -0
  6. data/bin/rdoc +13 -2
  7. data/lib/rdoc.rb +11 -3
  8. data/lib/rdoc/alias.rb +54 -0
  9. data/lib/rdoc/anon_class.rb +10 -0
  10. data/lib/rdoc/any_method.rb +190 -0
  11. data/lib/rdoc/attr.rb +79 -0
  12. data/lib/rdoc/cache.rb +11 -2
  13. data/lib/rdoc/class_module.rb +87 -0
  14. data/lib/rdoc/code_object.rb +152 -0
  15. data/lib/rdoc/code_objects.rb +18 -1118
  16. data/lib/rdoc/constant.rb +36 -0
  17. data/lib/rdoc/context.rb +712 -0
  18. data/lib/rdoc/diagram.rb +8 -8
  19. data/lib/rdoc/generator.rb +3 -1140
  20. data/lib/rdoc/generator/darkfish.rb +107 -133
  21. data/lib/rdoc/generator/markup.rb +194 -0
  22. data/lib/rdoc/generator/ri.rb +4 -2
  23. data/lib/rdoc/generator/template/darkfish/classpage.rhtml +92 -113
  24. data/lib/rdoc/generator/template/darkfish/filepage.rhtml +33 -35
  25. data/lib/rdoc/generator/template/darkfish/index.rhtml +22 -15
  26. data/lib/rdoc/ghost_method.rb +8 -0
  27. data/lib/rdoc/include.rb +39 -0
  28. data/lib/rdoc/markup/attribute_manager.rb +46 -0
  29. data/lib/rdoc/markup/formatter.rb +11 -0
  30. data/lib/rdoc/markup/fragments.rb +42 -2
  31. data/lib/rdoc/markup/inline.rb +29 -4
  32. data/lib/rdoc/markup/lines.rb +4 -0
  33. data/lib/rdoc/markup/preprocess.rb +4 -0
  34. data/lib/rdoc/markup/to_flow.rb +27 -1
  35. data/lib/rdoc/markup/to_html.rb +33 -33
  36. data/lib/rdoc/markup/to_html_crossref.rb +4 -11
  37. data/lib/rdoc/markup/to_latex.rb +31 -31
  38. data/lib/rdoc/markup/to_test.rb +3 -0
  39. data/lib/rdoc/markup/to_texinfo.rb +18 -14
  40. data/lib/rdoc/meta_method.rb +8 -0
  41. data/lib/rdoc/normal_class.rb +18 -0
  42. data/lib/rdoc/normal_module.rb +34 -0
  43. data/lib/rdoc/options.rb +26 -159
  44. data/lib/rdoc/parser/c.rb +16 -8
  45. data/lib/rdoc/parser/ruby.rb +16 -10
  46. data/lib/rdoc/parser/simple.rb +1 -1
  47. data/lib/rdoc/rdoc.rb +50 -34
  48. data/lib/rdoc/require.rb +32 -0
  49. data/lib/rdoc/ri/descriptions.rb +1 -1
  50. data/lib/rdoc/ri/driver.rb +4 -4
  51. data/lib/rdoc/ri/formatter.rb +70 -32
  52. data/lib/rdoc/single_class.rb +8 -0
  53. data/lib/rdoc/top_level.rb +232 -0
  54. data/test/test_rdoc_any_method.rb +10 -0
  55. data/test/test_rdoc_code_object.rb +80 -0
  56. data/test/test_rdoc_constant.rb +15 -0
  57. data/test/test_rdoc_context.rb +250 -0
  58. data/test/test_rdoc_include.rb +17 -0
  59. data/test/test_rdoc_markup.rb +13 -2
  60. data/test/test_rdoc_markup_to_html.rb +22 -0
  61. data/test/test_rdoc_markup_to_html_crossref.rb +50 -115
  62. data/test/test_rdoc_normal_module.rb +26 -0
  63. data/test/test_rdoc_parser_c.rb +33 -0
  64. data/test/test_rdoc_parser_ruby.rb +54 -36
  65. data/test/test_rdoc_require.rb +25 -0
  66. data/test/test_rdoc_ri_default_display.rb +2 -1
  67. data/test/test_rdoc_ri_html_formatter.rb +141 -0
  68. data/test/test_rdoc_top_level.rb +85 -0
  69. data/test/xref_data.rb +46 -0
  70. data/test/xref_test_case.rb +48 -0
  71. metadata +42 -13
  72. metadata.gz.sig +0 -0
  73. data/lib/rdoc/generator/html.rb +0 -456
  74. data/lib/rdoc/generator/html/common.rb +0 -24
  75. data/lib/rdoc/generator/html/html.rb +0 -769
  76. data/lib/rdoc/generator/html/one_page_html.rb +0 -122
  77. data/lib/rdoc/generator/xml.rb +0 -124
  78. data/lib/rdoc/generator/xml/rdf.rb +0 -113
  79. data/lib/rdoc/generator/xml/xml.rb +0 -123
  80. data/lib/rdoc/parser/f95.rb +0 -1835
  81. data/lib/rdoc/template.rb +0 -68
data/lib/rdoc/generator/html/common.rb DELETED
@@ -1,24 +0,0 @@
1
- #
2
- # The templates require further refactoring. In particular,
3
- # * Some kind of HTML generation library should be used.
4
- #
5
- # Also, all of the templates require some TLC from a designer.
6
- #
7
- # Right now, this file contains some constants that are used by all
8
- # of the templates.
9
- #
10
- module RDoc::Generator::HTML::Common
11
- XHTML_STRICT_PREAMBLE = <<-EOF
12
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
13
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
14
- EOF
15
-
16
- XHTML_FRAME_PREAMBLE = <<-EOF
17
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
18
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
19
- EOF
20
-
21
- HTML_ELEMENT = <<-EOF
22
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
23
- EOF
24
- end
data/lib/rdoc/generator/html/html.rb DELETED
@@ -1,769 +0,0 @@
1
- require 'rdoc/generator/html'
2
- require 'rdoc/generator/html/common'
3
-
4
- ##
5
- # = CSS2 RDoc HTML template
6
- #
7
- # This is a template for RDoc that uses XHTML 1.0 Strict and dictates a
8
- # bit more of the appearance of the output to cascading stylesheets than the
9
- # default. It was designed for clean inline code display, and uses DHTMl to
10
- # toggle the visibility of each method's source with each click on the
11
- # '[source]' link.
12
- #
13
- # This template *also* forms the basis of the frameless template.
14
- #
15
- # == Authors
16
- #
17
- # * Michael Granger <ged@FaerieMUD.org>
18
- #
19
- # Copyright (c) 2002, 2003 The FaerieMUD Consortium. Some rights reserved.
20
- #
21
- # This work is licensed under the Creative Commons Attribution License. To
22
- # view a copy of this license, visit
23
- # http://creativecommons.org/licenses/by/1.0/ or send a letter to Creative
24
- # Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA.
25
-
26
- module RDoc::Generator::HTML::HTML
27
-
28
- include RDoc::Generator::HTML::Common
29
-
30
- FONTS = "Verdana,Arial,Helvetica,sans-serif"
31
-
32
- STYLE = <<-EOF
33
- body {
34
- font-family: #{FONTS};
35
- font-size: 90%;
36
- margin: 0;
37
- margin-left: 40px;
38
- padding: 0;
39
- background: white;
40
- color: black;
41
- }
42
-
43
- h1, h2, h3, h4 {
44
- margin: 0;
45
- background: transparent;
46
- }
47
-
48
- h1 {
49
- font-size: 150%;
50
- }
51
-
52
- h2,h3,h4 {
53
- margin-top: 1em;
54
- }
55
-
56
- :link, :visited {
57
- background: #eef;
58
- color: #039;
59
- text-decoration: none;
60
- }
61
-
62
- :link:hover, :visited:hover {
63
- background: #039;
64
- color: #eef;
65
- }
66
-
67
- /* Override the base stylesheet's Anchor inside a table cell */
68
- td > :link, td > :visited {
69
- background: transparent;
70
- color: #039;
71
- text-decoration: none;
72
- }
73
-
74
- /* and inside a section title */
75
- .section-title > :link, .section-title > :visited {
76
- background: transparent;
77
- color: #eee;
78
- text-decoration: none;
79
- }
80
-
81
- /* === Structural elements =================================== */
82
-
83
- .index {
84
- margin: 0;
85
- margin-left: -40px;
86
- padding: 0;
87
- font-size: 90%;
88
- }
89
-
90
- .index :link, .index :visited {
91
- margin-left: 0.7em;
92
- }
93
-
94
- .index .section-bar {
95
- margin-left: 0px;
96
- padding-left: 0.7em;
97
- background: #ccc;
98
- font-size: small;
99
- }
100
-
101
- #classHeader, #fileHeader {
102
- width: auto;
103
- color: white;
104
- padding: 0.5em 1.5em 0.5em 1.5em;
105
- margin: 0;
106
- margin-left: -40px;
107
- border-bottom: 3px solid #006;
108
- }
109
-
110
- #classHeader :link, #fileHeader :link,
111
- #classHeader :visited, #fileHeader :visited {
112
- background: inherit;
113
- color: white;
114
- }
115
-
116
- #classHeader td, #fileHeader td {
117
- background: inherit;
118
- color: white;
119
- }
120
-
121
- #fileHeader {
122
- background: #057;
123
- }
124
-
125
- #classHeader {
126
- background: #048;
127
- }
128
-
129
- .class-name-in-header {
130
- font-size: 180%;
131
- font-weight: bold;
132
- }
133
-
134
- #bodyContent {
135
- padding: 0 1.5em 0 1.5em;
136
- }
137
-
138
- #description {
139
- padding: 0.5em 1.5em;
140
- background: #efefef;
141
- border: 1px dotted #999;
142
- }
143
-
144
- #description h1, #description h2, #description h3,
145
- #description h4, #description h5, #description h6 {
146
- color: #125;
147
- background: transparent;
148
- }
149
-
150
- #validator-badges {
151
- text-align: center;
152
- }
153
-
154
- #validator-badges img {
155
- border: 0;
156
- }
157
-
158
- #copyright {
159
- color: #333;
160
- background: #efefef;
161
- font: 0.75em sans-serif;
162
- margin-top: 5em;
163
- margin-bottom: 0;
164
- padding: 0.5em 2em;
165
- }
166
-
167
- /* === Classes =================================== */
168
-
169
- table.header-table {
170
- color: white;
171
- font-size: small;
172
- }
173
-
174
- .type-note {
175
- font-size: small;
176
- color: #dedede;
177
- }
178
-
179
- .section-bar {
180
- color: #333;
181
- border-bottom: 1px solid #999;
182
- margin-left: -20px;
183
- }
184
-
185
- .section-title {
186
- background: #79a;
187
- color: #eee;
188
- padding: 3px;
189
- margin-top: 2em;
190
- margin-left: -30px;
191
- border: 1px solid #999;
192
- }
193
-
194
- .top-aligned-row {
195
- vertical-align: top
196
- }
197
-
198
- .bottom-aligned-row {
199
- vertical-align: bottom
200
- }
201
-
202
- #diagram img {
203
- border: 0;
204
- }
205
-
206
- /* --- Context section classes ----------------------- */
207
-
208
- .context-row { }
209
-
210
- .context-item-name {
211
- font-family: monospace;
212
- font-weight: bold;
213
- color: black;
214
- }
215
-
216
- .context-item-value {
217
- font-size: small;
218
- color: #448;
219
- }
220
-
221
- .context-item-desc {
222
- color: #333;
223
- padding-left: 2em;
224
- }
225
-
226
- /* --- Method classes -------------------------- */
227
-
228
- .method-detail {
229
- background: #efefef;
230
- padding: 0;
231
- margin-top: 0.5em;
232
- margin-bottom: 1em;
233
- border: 1px dotted #ccc;
234
- }
235
-
236
- .method-heading {
237
- color: black;
238
- background: #ccc;
239
- border-bottom: 1px solid #666;
240
- padding: 0.2em 0.5em 0 0.5em;
241
- }
242
-
243
- .method-signature {
244
- color: black;
245
- background: inherit;
246
- }
247
-
248
- .method-name {
249
- font-weight: bold;
250
- }
251
-
252
- .method-args {
253
- font-style: italic;
254
- }
255
-
256
- .method-description {
257
- padding: 0 0.5em 0 0.5em;
258
- }
259
-
260
- /* --- Source code sections -------------------- */
261
-
262
- :link.source-toggle, :visited.source-toggle {
263
- font-size: 90%;
264
- }
265
-
266
- div.method-source-code {
267
- background: #262626;
268
- color: #ffdead;
269
- margin: 1em;
270
- padding: 0.5em;
271
- border: 1px dashed #999;
272
- overflow: auto;
273
- }
274
-
275
- div.method-source-code pre {
276
- color: #ffdead;
277
- }
278
-
279
- /* --- Ruby keyword styles --------------------- */
280
-
281
- .standalone-code {
282
- background: #221111;
283
- color: #ffdead;
284
- overflow: auto;
285
- }
286
-
287
- .ruby-constant {
288
- color: #7fffd4;
289
- background: transparent;
290
- }
291
-
292
- .ruby-keyword {
293
- color: #00ffff;
294
- background: transparent;
295
- }
296
-
297
- .ruby-ivar {
298
- color: #eedd82;
299
- background: transparent;
300
- }
301
-
302
- .ruby-operator {
303
- color: #00ffee;
304
- background: transparent;
305
- }
306
-
307
- .ruby-identifier {
308
- color: #ffdead;
309
- background: transparent;
310
- }
311
-
312
- .ruby-node {
313
- color: #ffa07a;
314
- background: transparent;
315
- }
316
-
317
- .ruby-comment {
318
- color: #b22222;
319
- font-weight: bold;
320
- background: transparent;
321
- }
322
-
323
- .ruby-regexp {
324
- color: #ffa07a;
325
- background: transparent;
326
- }
327
-
328
- .ruby-value {
329
- color: #7fffd4;
330
- background: transparent;
331
- }
332
- EOF
333
-
334
-
335
- #####################################################################
336
- ### H E A D E R T E M P L A T E
337
- #####################################################################
338
-
339
- HEADER = XHTML_STRICT_PREAMBLE + HTML_ELEMENT + <<-EOF
340
- <head>
341
- <title><%= values[:title] %></title>
342
- <meta http-equiv="Content-Type" content="text/html; charset=<%= values[:charset] %>" />
343
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
344
- <link rel="stylesheet" href="<%= values[:style_url] %>" type="text/css" media="screen" />
345
- <script type="text/javascript">
346
- // <![CDATA[
347
-
348
- function popupCode( url ) {
349
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
350
- }
351
-
352
- function toggleCode( id ) {
353
- if ( document.getElementById )
354
- elem = document.getElementById( id );
355
- else if ( document.all )
356
- elem = eval( "document.all." + id );
357
- else
358
- return false;
359
-
360
- elemStyle = elem.style;
361
-
362
- if ( elemStyle.display != "block" ) {
363
- elemStyle.display = "block"
364
- } else {
365
- elemStyle.display = "none"
366
- }
367
-
368
- return true;
369
- }
370
-
371
- // Make codeblocks hidden by default
372
- document.writeln( "<style type=\\"text/css\\">div.method-source-code { display: none }<\\/style>" )
373
-
374
- // ]]>
375
- </script>
376
-
377
- </head>
378
- <body>
379
- EOF
380
-
381
- #####################################################################
382
- ### F O O T E R T E M P L A T E
383
- #####################################################################
384
-
385
- FOOTER = <<-EOF
386
- <div id="validator-badges">
387
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
388
- </div>
389
-
390
- </body>
391
- </html>
392
- EOF
393
-
394
-
395
- #####################################################################
396
- ### F I L E P A G E H E A D E R T E M P L A T E
397
- #####################################################################
398
-
399
- FILE_PAGE = <<-EOF
400
- <div id="fileHeader">
401
- <h1><%= values[:short_name] %></h1>
402
- <table class="header-table">
403
- <tr class="top-aligned-row">
404
- <td><strong>Path:</strong></td>
405
- <td><%= values[:full_path] %>
406
- <% if values[:cvsurl] then %>
407
- &nbsp;(<a href="<%= values[:cvsurl] %>"><acronym title="Concurrent Versioning System">CVS</acronym></a>)
408
- <% end %>
409
- </td>
410
- </tr>
411
- <tr class="top-aligned-row">
412
- <td><strong>Last Update:</strong></td>
413
- <td><%= values[:dtm_modified] %></td>
414
- </tr>
415
- </table>
416
- </div>
417
- EOF
418
-
419
- #####################################################################
420
- ### C L A S S P A G E H E A D E R T E M P L A T E
421
- #####################################################################
422
-
423
- CLASS_PAGE = <<-EOF
424
- <div id="classHeader">
425
- <table class="header-table">
426
- <tr class="top-aligned-row">
427
- <td><strong><%= values[:classmod] %></strong></td>
428
- <td class="class-name-in-header"><%= values[:full_name] %></td>
429
- </tr>
430
- <tr class="top-aligned-row">
431
- <td><strong>In:</strong></td>
432
- <td>
433
- <% values[:infiles].each do |infiles| %>
434
- <% if infiles[:full_path_url] then %>
435
- <a href="<%= infiles[:full_path_url] %>">
436
- <% end %>
437
- <%= infiles[:full_path] %>
438
- <% if infiles[:full_path_url] then %>
439
- </a>
440
- <% end %>
441
- <% if infiles[:cvsurl] then %>
442
- &nbsp;(<a href="<%= infiles[:cvsurl] %>"><acronym title="Concurrent Versioning System">CVS</acronym></a>)
443
- <% end %>
444
- <br />
445
- <% end %><%# values[:infiles] %>
446
- </td>
447
- </tr>
448
-
449
- <% if values[:parent] then %>
450
- <tr class="top-aligned-row">
451
- <td><strong>Parent:</strong></td>
452
- <td>
453
- <% if values[:par_url] then %>
454
- <a href="<%= values[:par_url] %>">
455
- <% end %>
456
- <%= values[:parent] %>
457
- <% if values[:par_url] then %>
458
- </a>
459
- <% end %>
460
- </td>
461
- </tr>
462
- <% end %>
463
- </table>
464
- </div>
465
- EOF
466
-
467
- #####################################################################
468
- ### M E T H O D L I S T T E M P L A T E
469
- #####################################################################
470
-
471
- METHOD_LIST = <<-EOF
472
- <div id="contextContent">
473
- <% if values[:diagram] then %>
474
- <div id="diagram">
475
- <%= values[:diagram] %>
476
- </div>
477
- <% end
478
-
479
- if values[:description] then %>
480
- <div id="description">
481
- <%= values[:description] %>
482
- </div>
483
- <% end
484
-
485
- if values[:requires] then %>
486
- <div id="requires-list">
487
- <h3 class="section-bar">Required files</h3>
488
-
489
- <div class="name-list">
490
- <% values[:requires].each do |requires| %>
491
- <%= href requires[:aref], requires[:name] %>&nbsp;&nbsp;
492
- <% end %><%# values[:requires] %>
493
- </div>
494
- </div>
495
- <% end
496
-
497
- if values[:toc] then %>
498
- <div id="contents-list">
499
- <h3 class="section-bar">Contents</h3>
500
- <ul>
501
- <% values[:toc].each do |toc| %>
502
- <li><a href="#<%= toc[:href] %>"><%= toc[:secname] %></a></li>
503
- <% end %><%# values[:toc] %>
504
- </ul>
505
- <% end %>
506
- </div>
507
-
508
- <% if values[:methods] then %>
509
- <div id="method-list">
510
- <h3 class="section-bar">Methods</h3>
511
-
512
- <div class="name-list">
513
- <% values[:methods].each do |methods| %>
514
- <%= href methods[:aref], methods[:name] %>&nbsp;&nbsp;
515
- <% end %><%# values[:methods] %>
516
- </div>
517
- </div>
518
- <% end %>
519
- </div>
520
-
521
- <!-- if includes -->
522
- <% if values[:includes] then %>
523
- <div id="includes">
524
- <h3 class="section-bar">Included Modules</h3>
525
-
526
- <div id="includes-list">
527
- <% values[:includes].each do |includes| %>
528
- <span class="include-name"><%= href includes[:aref], includes[:name] %></span>
529
- <% end %><%# values[:includes] %>
530
- </div>
531
- </div>
532
- <% end
533
-
534
- values[:sections].each do |sections| %>
535
- <div id="section">
536
- <% if sections[:sectitle] then %>
537
- <h2 class="section-title"><a name="<%= sections[:secsequence] %>"><%= sections[:sectitle] %></a></h2>
538
- <% if sections[:seccomment] then %>
539
- <div class="section-comment">
540
- <%= sections[:seccomment] %>
541
- </div>
542
- <% end
543
- end
544
-
545
- if sections[:classlist] then %>
546
- <div id="class-list">
547
- <h3 class="section-bar">Classes and Modules</h3>
548
-
549
- <%= sections[:classlist] %>
550
- </div>
551
- <% end
552
-
553
- if sections[:constants] then %>
554
- <div id="constants-list">
555
- <h3 class="section-bar">Constants</h3>
556
-
557
- <div class="name-list">
558
- <table summary="Constants">
559
- <% sections[:constants].each do |constants| %>
560
- <tr class="top-aligned-row context-row">
561
- <td class="context-item-name"><%= constants[:name] %></td>
562
- <td>=</td>
563
- <td class="context-item-value"><%= constants[:value] %></td>
564
- <% if constants[:desc] then %>
565
- <td>&nbsp;</td>
566
- <td class="context-item-desc"><%= constants[:desc] %></td>
567
- <% end %>
568
- </tr>
569
- <% end %><%# sections[:constants] %>
570
- </table>
571
- </div>
572
- </div>
573
- <% end
574
-
575
- if sections[:aliases] then %>
576
- <div id="aliases-list">
577
- <h3 class="section-bar">External Aliases</h3>
578
-
579
- <div class="name-list">
580
- <table summary="aliases">
581
- <% sections[:aliases].each do |aliases| %>
582
- <tr class="top-aligned-row context-row">
583
- <td class="context-item-name"><%= aliases[:old_name] %></td>
584
- <td>-&gt;</td>
585
- <td class="context-item-value"><%= aliases[:new_name] %></td>
586
- </tr>
587
- <% if aliases[:desc] then %>
588
- <tr class="top-aligned-row context-row">
589
- <td>&nbsp;</td>
590
- <td colspan="2" class="context-item-desc"><%= aliases[:desc] %></td>
591
- </tr>
592
- <% end
593
- end %><%# sections[:aliases] %>
594
- </table>
595
- </div>
596
- </div>
597
- <% end %>
598
-
599
- <% if sections[:attributes] then %>
600
- <div id="attribute-list">
601
- <h3 class="section-bar">Attributes</h3>
602
-
603
- <div class="name-list">
604
- <table>
605
- <% sections[:attributes].each do |attribute| %>
606
- <tr class="top-aligned-row context-row">
607
- <td class="context-item-name"><%= attribute[:name] %></td>
608
- <% if attribute[:rw] then %>
609
- <td class="context-item-value">&nbsp;[<%= attribute[:rw] %>]&nbsp;</td>
610
- <% end
611
- unless attribute[:rw] then %>
612
- <td class="context-item-value">&nbsp;&nbsp;</td>
613
- <% end %>
614
- <td class="context-item-desc"><%= attribute[:a_desc] %></td>
615
- </tr>
616
- <% end %><%# sections[:attributes] %>
617
- </table>
618
- </div>
619
- </div>
620
- <% end %>
621
-
622
- <!-- if method_list -->
623
- <% if sections[:method_list] then %>
624
- <div id="methods">
625
- <% sections[:method_list].each do |method_list|
626
- if method_list[:methods] then %>
627
- <h3 class="section-bar"><%= method_list[:type] %> <%= method_list[:category] %> methods</h3>
628
-
629
- <% method_list[:methods].each do |methods| %>
630
- <div id="method-<%= methods[:aref] %>" class="method-detail">
631
- <a name="<%= methods[:aref] %>"></a>
632
-
633
- <div class="method-heading">
634
- <% if methods[:codeurl] then %>
635
- <a href="<%= methods[:codeurl] %>" target="Code" class="method-signature"
636
- onclick="popupCode('<%= methods[:codeurl] %>');return false;">
637
- <% end
638
- if methods[:sourcecode] then %>
639
- <a href="#<%= methods[:aref] %>" class="method-signature">
640
- <% end
641
- if methods[:callseq] then %>
642
- <span class="method-name"><%= methods[:callseq] %></span>
643
- <% end
644
- unless methods[:callseq] then %>
645
- <span class="method-name"><%= methods[:name] %></span><span class="method-args"><%= methods[:params] %></span>
646
- <% end
647
- if methods[:codeurl] then %>
648
- </a>
649
- <% end
650
- if methods[:sourcecode] then %>
651
- </a>
652
- <% end %>
653
- </div>
654
-
655
- <div class="method-description">
656
- <% if methods[:m_desc] then %>
657
- <%= methods[:m_desc] %>
658
- <% end
659
- if methods[:sourcecode] then %>
660
- <p><a class="source-toggle" href="#"
661
- onclick="toggleCode('<%= methods[:aref] %>-source');return false;">[Source]</a></p>
662
- <div class="method-source-code" id="<%= methods[:aref] %>-source">
663
- <pre>
664
- <%= methods[:sourcecode] %>
665
- </pre>
666
- </div>
667
- <% end %>
668
- </div>
669
- </div>
670
-
671
- <% end %><%# method_list[:methods] %><%
672
- end
673
- end %><%# sections[:method_list] %>
674
-
675
- </div>
676
- <% end %>
677
- <% end %><%# values[:sections] %>
678
- EOF
679
-
680
- #####################################################################
681
- ### B O D Y T E M P L A T E
682
- #####################################################################
683
-
684
- BODY = HEADER + %{
685
-
686
- <%= template_include %> <!-- banner header -->
687
-
688
- <div id="bodyContent">
689
-
690
- } + METHOD_LIST + %{
691
-
692
- </div>
693
-
694
- } + FOOTER
695
-
696
- #####################################################################
697
- ### S O U R C E C O D E T E M P L A T E
698
- #####################################################################
699
-
700
- SRC_PAGE = XHTML_STRICT_PREAMBLE + HTML_ELEMENT + <<-EOF
701
- <head>
702
- <title><%= values[:title] %></title>
703
- <meta http-equiv="Content-Type" content="text/html; charset=<%= values[:charset] %>" />
704
- <link rel="stylesheet" href="<%= values[:style_url] %>" type="text/css" media="screen" />
705
- </head>
706
- <body class="standalone-code">
707
- <pre><%= values[:code] %></pre>
708
- </body>
709
- </html>
710
- EOF
711
-
712
-
713
- #####################################################################
714
- ### I N D E X F I L E T E M P L A T E S
715
- #####################################################################
716
-
717
- FR_INDEX_BODY = %{<%= template_include %>}
718
-
719
- FILE_INDEX = XHTML_STRICT_PREAMBLE + HTML_ELEMENT + <<-EOF
720
- <!--
721
-
722
- <%= values[:title] %>
723
-
724
- -->
725
- <head>
726
- <title><%= values[:title] %></title>
727
- <meta http-equiv="Content-Type" content="text/html; charset=<%= values[:charset] %>" />
728
- <link rel="stylesheet" href="<%= values[:style_url] %>" type="text/css" />
729
- <base target="docwin" />
730
- </head>
731
- <body>
732
- <div class="index">
733
- <h1 class="section-bar"><%= values[:list_title] %></h1>
734
- <div id="index-entries">
735
- <% values[:entries].each do |entries| %>
736
- <a href="<%= entries[:href] %>"><%= entries[:name] %></a><br />
737
- <% end %><%# values[:entries] %>
738
- </div>
739
- </div>
740
- </body>
741
- </html>
742
- EOF
743
-
744
- CLASS_INDEX = FILE_INDEX
745
- METHOD_INDEX = FILE_INDEX
746
-
747
- INDEX = XHTML_FRAME_PREAMBLE + HTML_ELEMENT + <<-EOF
748
- <!--
749
-
750
- <%= values[:title] %>
751
-
752
- -->
753
- <head>
754
- <title><%= values[:title] %></title>
755
- <meta http-equiv="Content-Type" content="text/html; charset=<%= values[:charset] %>" />
756
- </head>
757
- <frameset rows="20%, 80%">
758
- <frameset cols="25%,35%,45%">
759
- <frame src="fr_file_index.html" title="Files" name="Files" />
760
- <frame src="fr_class_index.html" name="Classes" />
761
- <frame src="fr_method_index.html" name="Methods" />
762
- </frameset>
763
- <frame src="<%= values[:initial_page] %>" name="docwin" />
764
- </frameset>
765
- </html>
766
- EOF
767
-
768
- end
769
-