erbook 5.0.0 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (68) hide show
  1. data/LICENSE +1 -1
  2. data/Rakefile +6 -79
  3. data/bin/erbook +25 -319
  4. data/doc/HelloWorld.spec +23 -21
  5. data/doc/README +4 -3
  6. data/doc/api/ERBook.html +35 -0
  7. data/doc/api/ERBook/Document.html +673 -0
  8. data/doc/api/ERBook/Document/Node.html +102 -0
  9. data/doc/api/ERBook/Template.html +670 -0
  10. data/doc/api/RDoc.html +23 -0
  11. data/doc/api/RDoc/AnyMethod.html +302 -0
  12. data/doc/api/RDoc/DummyMarkup.html +73 -0
  13. data/doc/api/RDoc/DummyMixin.html +23 -0
  14. data/doc/api/RDoc/DummyOptions.html +140 -0
  15. data/doc/api/RDoc/TopLevel.html +465 -0
  16. data/doc/api/String.html +372 -0
  17. data/doc/api/all-methods.html +253 -0
  18. data/doc/api/all-namespaces.html +42 -0
  19. data/doc/api/app.js +18 -0
  20. data/doc/api/index.html +16 -22
  21. data/doc/api/jquery.js +11 -0
  22. data/doc/api/readme.html +35 -0
  23. data/doc/api/style.css +68 -0
  24. data/doc/api/syntax_highlight.css +21 -0
  25. data/doc/erbook.png +0 -0
  26. data/doc/erbook.svg +150 -88
  27. data/doc/formats.erb +387 -0
  28. data/doc/history.erb +62 -0
  29. data/doc/index.erb +8 -0
  30. data/doc/index.xhtml +846 -654
  31. data/doc/intro.erb +97 -0
  32. data/doc/setup.erb +62 -0
  33. data/doc/theory.erb +187 -0
  34. data/doc/usage.erb +39 -0
  35. data/fmt/xhtml.yaml +497 -372
  36. data/lib/erbook.rb +18 -10
  37. data/lib/erbook/document.rb +233 -0
  38. data/lib/erbook/template.rb +210 -0
  39. data/lib/erbook/to_xhtml.rb +25 -17
  40. metadata +39 -45
  41. data/README +0 -14
  42. data/doc/api/classes/ERBook.html +0 -164
  43. data/doc/api/classes/RDoc.html +0 -112
  44. data/doc/api/classes/RDoc/AnyMethod.html +0 -195
  45. data/doc/api/classes/RDoc/AnyMethod.src/M000003.html +0 -18
  46. data/doc/api/classes/RDoc/AnyMethod.src/M000004.html +0 -23
  47. data/doc/api/classes/RDoc/AnyMethod.src/M000005.html +0 -18
  48. data/doc/api/classes/RDoc/AnyMethod.src/M000006.html +0 -22
  49. data/doc/api/classes/RDoc/TopLevel.html +0 -250
  50. data/doc/api/classes/RDoc/TopLevel.src/M000007.html +0 -18
  51. data/doc/api/classes/RDoc/TopLevel.src/M000008.html +0 -18
  52. data/doc/api/classes/RDoc/TopLevel.src/M000009.html +0 -18
  53. data/doc/api/classes/RDoc/TopLevel.src/M000010.html +0 -29
  54. data/doc/api/classes/RDoc/TopLevel.src/M000011.html +0 -25
  55. data/doc/api/classes/RDoc/TopLevel.src/M000012.html +0 -18
  56. data/doc/api/classes/String.html +0 -196
  57. data/doc/api/classes/String.src/M000001.html +0 -18
  58. data/doc/api/classes/String.src/M000002.html +0 -31
  59. data/doc/api/created.rid +0 -1
  60. data/doc/api/files/lib/erbook/rdoc_rb.html +0 -116
  61. data/doc/api/files/lib/erbook/to_xhtml_rb.html +0 -125
  62. data/doc/api/files/lib/erbook_rb.html +0 -107
  63. data/doc/api/fr_class_index.html +0 -31
  64. data/doc/api/fr_file_index.html +0 -29
  65. data/doc/api/fr_method_index.html +0 -38
  66. data/doc/api/rdoc-style.css +0 -208
  67. data/doc/feed-icon-28x28.png +0 -0
  68. data/doc/manual.erb +0 -812
@@ -0,0 +1,465 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
+ <html>
4
+ <head>
5
+ <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
6
+ <link rel="stylesheet" href="../style.css" type="text/css" charset="utf-8" />
7
+ <link rel="stylesheet" href="../syntax_highlight.css" type="text/css" charset="utf-8" />
8
+
9
+ <script src="../jquery.js" type="text/javascript" charset="utf-8"></script>
10
+ <script src="../app.js" type="text/javascript" charset="utf-8"></script>
11
+ <title>Class: RDoc::TopLevel</title>
12
+ </head>
13
+ <body>
14
+ <div id="content">
15
+ <div class="section class RDoc_TopLevel">
16
+ <h1 class="title">Class: RDoc::TopLevel</h1>
17
+ <div class="section constants">
18
+
19
+ </div> <div class="section visibilitygroup public">
20
+ <h1>Public Visibility</h1>
21
+ <div class="section methodsummary class public">
22
+ <h1>Public Class Method Summary</h1>
23
+ <table class="summary">
24
+
25
+ <tr>
26
+ <th class="signature">
27
+ <span class='name'><a href="#all_classes-class_method" title="all_classes">all_classes</a></span><span class='args'></span>
28
+ <span class='block'></span>
29
+
30
+ </th>
31
+ <td class="docstring">
32
+ <p>
33
+ Returns an array of all classes recorded thus far.
34
+ </p>
35
+
36
+
37
+ </td>
38
+ </tr>
39
+
40
+ <tr>
41
+ <th class="signature">
42
+ <span class='name'><a href="#all_methods-class_method" title="all_methods">all_methods</a></span><span class='args'></span>
43
+ <span class='block'></span>
44
+
45
+ </th>
46
+ <td class="docstring">
47
+ <p>
48
+ Returns an array of RDoc::AnyMethod objects representing all methods
49
+ recorded thus far.
50
+ </p>
51
+
52
+
53
+ </td>
54
+ </tr>
55
+
56
+ <tr>
57
+ <th class="signature">
58
+ <span class='name'><a href="#all_modules-class_method" title="all_modules">all_modules</a></span><span class='args'></span>
59
+ <span class='block'></span>
60
+
61
+ </th>
62
+ <td class="docstring">
63
+ <p>
64
+ Returns an array of all modules recorded thus far.
65
+ </p>
66
+
67
+
68
+ </td>
69
+ </tr>
70
+
71
+ <tr>
72
+ <th class="signature">
73
+ <span class='name'><a href="#parse-class_method" title="parse">parse</a></span><span class='args'>(aCodeString, aFileName = )</span>
74
+ <span class='block'></span>
75
+
76
+ </th>
77
+ <td class="docstring">
78
+ <p>
79
+ Returns a RDoc::TopLevel object containing information parsed from the
80
+ given code string.
81
+ </p>
82
+
83
+
84
+ </td>
85
+ </tr>
86
+
87
+ <tr>
88
+ <th class="signature">
89
+ <span class='name'><a href="#parse_file-class_method" title="parse_file">parse_file</a></span><span class='args'>(aFileName)</span>
90
+ <span class='block'></span>
91
+
92
+ </th>
93
+ <td class="docstring">
94
+ <p>
95
+ Returns a RDoc::TopLevel object containing information parsed from the code
96
+ in the given file.
97
+ </p>
98
+
99
+
100
+ </td>
101
+ </tr>
102
+
103
+ <tr>
104
+ <th class="signature">
105
+ <span class='name'><a href="#refresh_all_classes_and_modules-class_method" title="refresh_all_classes_and_modules">refresh_all_classes_and_modules</a></span><span class='args'></span>
106
+ <span class='block'></span>
107
+
108
+ </th>
109
+ <td class="docstring">
110
+ <p>
111
+ Update the return value of the all_classes_and_modules() method to
112
+ <b>really</b> include every class and every module seen thus far.
113
+ </p>
114
+
115
+
116
+ </td>
117
+ </tr>
118
+
119
+ </table>
120
+ </div>
121
+ <div class="section methoddetails class public">
122
+ <h1>Public Class Method Details</h1>
123
+
124
+ <div class="method">
125
+ <div class="method_header">
126
+ <h3>all_classes</h3>
127
+ </div><div id="all_classes-class_method" class="section method">
128
+ <div class="details_title">
129
+ <div class='section methodsignature'>
130
+ <tt class='def'>
131
+ <span class='visibility'>public</span>
132
+ <span class='return_types'></span>
133
+ <span class='name'>all_classes</span><span class='args'></span>
134
+ <span class='block'></span>
135
+ </tt>
136
+ </div>
137
+
138
+ </div><div class="section docstring">
139
+ <p>
140
+ Returns an array of all classes recorded thus far.
141
+ </p>
142
+
143
+ </div><div class="section source">
144
+ <span>[<a class="source_link" href="#">View source</a>]</span>
145
+ <div class="source_code">
146
+ <table>
147
+ <tr>
148
+ <td>
149
+ <pre class="lines">
150
+
151
+
152
+ 8
153
+ 9
154
+ 10</pre>
155
+ </td>
156
+ <td>
157
+ <pre class="code"><span class="info file"># File 'lib/erbook/rdoc.rb', line 8</span>
158
+
159
+ <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='all_classes identifier id'>all_classes</span>
160
+ <span class='@@all_classes ivar id'>@@all_classes</span><span class='dot token'>.</span><span class='values identifier id'>values</span>
161
+ <span class='end end kw'>end</span>
162
+ </pre>
163
+ </td>
164
+ </tr>
165
+ </table>
166
+ </div>
167
+ </div>
168
+ </div>
169
+ </div>
170
+
171
+ <div class="method">
172
+ <div class="method_header">
173
+ <h3>all_methods</h3>
174
+ </div><div id="all_methods-class_method" class="section method">
175
+ <div class="details_title">
176
+ <div class='section methodsignature'>
177
+ <tt class='def'>
178
+ <span class='visibility'>public</span>
179
+ <span class='return_types'></span>
180
+ <span class='name'>all_methods</span><span class='args'></span>
181
+ <span class='block'></span>
182
+ </tt>
183
+ </div>
184
+
185
+ </div><div class="section docstring">
186
+ <p>
187
+ Returns an array of RDoc::AnyMethod objects representing all methods
188
+ recorded thus far.
189
+ </p>
190
+
191
+ </div><div class="section source">
192
+ <span>[<a class="source_link" href="#">View source</a>]</span>
193
+ <div class="source_code">
194
+ <table>
195
+ <tr>
196
+ <td>
197
+ <pre class="lines">
198
+
199
+
200
+ 19
201
+ 20
202
+ 21</pre>
203
+ </td>
204
+ <td>
205
+ <pre class="code"><span class="info file"># File 'lib/erbook/rdoc.rb', line 19</span>
206
+
207
+ <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='all_methods identifier id'>all_methods</span>
208
+ <span class='all_classes_and_modules identifier id'>all_classes_and_modules</span><span class='dot token'>.</span><span class='map identifier id'>map</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='c identifier id'>c</span><span class='bitor op'>|</span> <span class='c identifier id'>c</span><span class='dot token'>.</span><span class='method_list identifier id'>method_list</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='flatten identifier id'>flatten</span>
209
+ <span class='end end kw'>end</span>
210
+ </pre>
211
+ </td>
212
+ </tr>
213
+ </table>
214
+ </div>
215
+ </div>
216
+ </div>
217
+ </div>
218
+
219
+ <div class="method">
220
+ <div class="method_header">
221
+ <h3>all_modules</h3>
222
+ </div><div id="all_modules-class_method" class="section method">
223
+ <div class="details_title">
224
+ <div class='section methodsignature'>
225
+ <tt class='def'>
226
+ <span class='visibility'>public</span>
227
+ <span class='return_types'></span>
228
+ <span class='name'>all_modules</span><span class='args'></span>
229
+ <span class='block'></span>
230
+ </tt>
231
+ </div>
232
+
233
+ </div><div class="section docstring">
234
+ <p>
235
+ Returns an array of all modules recorded thus far.
236
+ </p>
237
+
238
+ </div><div class="section source">
239
+ <span>[<a class="source_link" href="#">View source</a>]</span>
240
+ <div class="source_code">
241
+ <table>
242
+ <tr>
243
+ <td>
244
+ <pre class="lines">
245
+
246
+
247
+ 13
248
+ 14
249
+ 15</pre>
250
+ </td>
251
+ <td>
252
+ <pre class="code"><span class="info file"># File 'lib/erbook/rdoc.rb', line 13</span>
253
+
254
+ <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='all_modules identifier id'>all_modules</span>
255
+ <span class='@@all_modules ivar id'>@@all_modules</span><span class='dot token'>.</span><span class='values identifier id'>values</span>
256
+ <span class='end end kw'>end</span>
257
+ </pre>
258
+ </td>
259
+ </tr>
260
+ </table>
261
+ </div>
262
+ </div>
263
+ </div>
264
+ </div>
265
+
266
+ <div class="method">
267
+ <div class="method_header">
268
+ <h3>parse</h3>
269
+ </div><div id="parse-class_method" class="section method">
270
+ <div class="details_title">
271
+ <div class='section methodsignature'>
272
+ <tt class='def'>
273
+ <span class='visibility'>public</span>
274
+ <span class='return_types'></span>
275
+ <span class='name'>parse</span><span class='args'>(aCodeString, aFileName = )</span>
276
+ <span class='block'></span>
277
+ </tt>
278
+ </div>
279
+
280
+ </div><div class="section docstring">
281
+ <p>
282
+ Returns a RDoc::TopLevel object containing information parsed from the
283
+ given code string. This information is also added to the global TopLevel
284
+ class state, so you can access it via the class methods of the TopLevel
285
+ class.
286
+ </p>
287
+ <p>
288
+ If the file name (which signifies the origin of the given code) is given,
289
+ it MUST have a &quot;.c&quot; or &quot;.rb&quot; file extension. Otherwise,
290
+ RDoc will ignore the given code string! :-(
291
+ </p>
292
+
293
+ </div><div class="section source">
294
+ <span>[<a class="source_link" href="#">View source</a>]</span>
295
+ <div class="source_code">
296
+ <table>
297
+ <tr>
298
+ <td>
299
+ <pre class="lines">
300
+
301
+
302
+ 50
303
+ 51
304
+ 52
305
+ 53
306
+ 54
307
+ 55
308
+ 56
309
+ 57
310
+ 58
311
+ 59</pre>
312
+ </td>
313
+ <td>
314
+ <pre class="code"><span class="info file"># File 'lib/erbook/rdoc.rb', line 50</span>
315
+
316
+ <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='parse identifier id'>parse</span> <span class='aCodeString identifier id'>aCodeString</span><span class='comma token'>,</span> <span class='aFileName identifier id'>aFileName</span> <span class='assign token'>=</span> <span class='__FILE__ __file__ kw'>__FILE__</span>
317
+ <span class='top identifier id'>top</span> <span class='assign token'>=</span> <span class='ParserFactory constant id'>ParserFactory</span><span class='dot token'>.</span><span class='parser_for identifier id'>parser_for</span><span class='lparen token'>(</span>
318
+ <span class='TopLevel constant id'>TopLevel</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='aFileName identifier id'>aFileName</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='aFileName identifier id'>aFileName</span><span class='comma token'>,</span>
319
+ <span class='aCodeString identifier id'>aCodeString</span><span class='comma token'>,</span> <span class='DummyOptions constant id'>DummyOptions</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='comma token'>,</span> <span class='Stats constant id'>Stats</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
320
+ <span class='rparen token'>)</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span>
321
+
322
+ <span class='refresh_all_classes_and_modules identifier id'>refresh_all_classes_and_modules</span>
323
+
324
+ <span class='top identifier id'>top</span>
325
+ <span class='end end kw'>end</span>
326
+ </pre>
327
+ </td>
328
+ </tr>
329
+ </table>
330
+ </div>
331
+ </div>
332
+ </div>
333
+ </div>
334
+
335
+ <div class="method">
336
+ <div class="method_header">
337
+ <h3>parse_file</h3>
338
+ </div><div id="parse_file-class_method" class="section method">
339
+ <div class="details_title">
340
+ <div class='section methodsignature'>
341
+ <tt class='def'>
342
+ <span class='visibility'>public</span>
343
+ <span class='return_types'></span>
344
+ <span class='name'>parse_file</span><span class='args'>(aFileName)</span>
345
+ <span class='block'></span>
346
+ </tt>
347
+ </div>
348
+
349
+ </div><div class="section docstring">
350
+ <p>
351
+ Returns a RDoc::TopLevel object containing information parsed from the code
352
+ in the given file. This information is also added to the global TopLevel
353
+ class state, so you can access it via the class methods of the TopLevel
354
+ class.
355
+ </p>
356
+ <p>
357
+ The given file name MUST have a &quot;.c&quot; or &quot;.rb&quot; file
358
+ extension. Otherwise, RDoc will ignore the file! :-(
359
+ </p>
360
+
361
+ </div><div class="section source">
362
+ <span>[<a class="source_link" href="#">View source</a>]</span>
363
+ <div class="source_code">
364
+ <table>
365
+ <tr>
366
+ <td>
367
+ <pre class="lines">
368
+
369
+
370
+ 69
371
+ 70
372
+ 71</pre>
373
+ </td>
374
+ <td>
375
+ <pre class="code"><span class="info file"># File 'lib/erbook/rdoc.rb', line 69</span>
376
+
377
+ <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='parse_file identifier id'>parse_file</span> <span class='aFileName identifier id'>aFileName</span>
378
+ <span class='parse identifier id'>parse</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='read identifier id'>read</span><span class='lparen token'>(</span><span class='aFileName identifier id'>aFileName</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='aFileName identifier id'>aFileName</span>
379
+ <span class='end end kw'>end</span>
380
+ </pre>
381
+ </td>
382
+ </tr>
383
+ </table>
384
+ </div>
385
+ </div>
386
+ </div>
387
+ </div>
388
+
389
+ <div class="method">
390
+ <div class="method_header">
391
+ <h3>refresh_all_classes_and_modules</h3>
392
+ </div><div id="refresh_all_classes_and_modules-class_method" class="section method">
393
+ <div class="details_title">
394
+ <div class='section methodsignature'>
395
+ <tt class='def'>
396
+ <span class='visibility'>public</span>
397
+ <span class='return_types'></span>
398
+ <span class='name'>refresh_all_classes_and_modules</span><span class='args'></span>
399
+ <span class='block'></span>
400
+ </tt>
401
+ </div>
402
+
403
+ </div><div class="section docstring">
404
+ <p>
405
+ Update the return value of the all_classes_and_modules() method to
406
+ <b>really</b> include every class and every module seen thus far.
407
+ </p>
408
+
409
+ </div><div class="section source">
410
+ <span>[<a class="source_link" href="#">View source</a>]</span>
411
+ <div class="source_code">
412
+ <table>
413
+ <tr>
414
+ <td>
415
+ <pre class="lines">
416
+
417
+
418
+ 25
419
+ 26
420
+ 27
421
+ 28
422
+ 29
423
+ 30
424
+ 31
425
+ 32
426
+ 33
427
+ 34
428
+ 35
429
+ 36
430
+ 37
431
+ 38</pre>
432
+ </td>
433
+ <td>
434
+ <pre class="code"><span class="info file"># File 'lib/erbook/rdoc.rb', line 25</span>
435
+
436
+ <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='refresh_all_classes_and_modules identifier id'>refresh_all_classes_and_modules</span>
437
+ <span class='visit identifier id'>visit</span> <span class='assign token'>=</span> <span class='lambda identifier id'>lambda</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='node identifier id'>node</span><span class='bitor op'>|</span>
438
+ <span class='if if kw'>if</span> <span class='node identifier id'>node</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='NormalClass constant id'>NormalClass</span> <span class='or or kw'>or</span> <span class='node identifier id'>node</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='SingleClass constant id'>SingleClass</span>
439
+ <span class='@@all_classes ivar id'>@@all_classes</span><span class='lbrack token'>[</span><span class='node identifier id'>node</span><span class='dot token'>.</span><span class='full_name identifier id'>full_name</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='node identifier id'>node</span>
440
+
441
+ <span class='elsif elsif kw'>elsif</span> <span class='node identifier id'>node</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='NormalModule constant id'>NormalModule</span>
442
+ <span class='@@all_modules ivar id'>@@all_modules</span><span class='lbrack token'>[</span><span class='node identifier id'>node</span><span class='dot token'>.</span><span class='full_name identifier id'>full_name</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='node identifier id'>node</span>
443
+ <span class='end end kw'>end</span>
444
+
445
+ <span class='lparen token'>(</span><span class='node identifier id'>node</span><span class='dot token'>.</span><span class='classes identifier id'>classes</span> <span class='plus op'>+</span> <span class='node identifier id'>node</span><span class='dot token'>.</span><span class='modules identifier id'>modules</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='n identifier id'>n</span><span class='bitor op'>|</span> <span class='visit identifier id'>visit</span><span class='lbrack token'>[</span><span class='n identifier id'>n</span><span class='rbrack token'>]</span> <span class='rbrace token'>}</span>
446
+ <span class='end end kw'>end</span>
447
+
448
+ <span class='all_classes_and_modules identifier id'>all_classes_and_modules</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='n identifier id'>n</span><span class='bitor op'>|</span> <span class='visit identifier id'>visit</span><span class='lbrack token'>[</span><span class='n identifier id'>n</span><span class='rbrack token'>]</span> <span class='rbrace token'>}</span>
449
+ <span class='end end kw'>end</span>
450
+ </pre>
451
+ </td>
452
+ </tr>
453
+ </table>
454
+ </div>
455
+ </div>
456
+ </div>
457
+ </div>
458
+
459
+ </div>
460
+ </div>
461
+
462
+ </div>
463
+ </div>
464
+ </body>
465
+ </html>