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
@@ -1,195 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
- <head>
8
- <title>Class: RDoc::AnyMethod</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12
- <script type="text/javascript">
13
- // <![CDATA[
14
-
15
- function popupCode( url ) {
16
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
- }
18
-
19
- function toggleCode( id ) {
20
- if ( document.getElementById )
21
- elem = document.getElementById( id );
22
- else if ( document.all )
23
- elem = eval( "document.all." + id );
24
- else
25
- return false;
26
-
27
- elemStyle = elem.style;
28
-
29
- if ( elemStyle.display != "block" ) {
30
- elemStyle.display = "block"
31
- } else {
32
- elemStyle.display = "none"
33
- }
34
-
35
- return true;
36
- }
37
-
38
- // Make codeblocks hidden by default
39
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
-
41
- // ]]>
42
- </script>
43
-
44
- </head>
45
- <body>
46
-
47
-
48
-
49
- <div id="classHeader">
50
- <table class="header-table">
51
- <tr class="top-aligned-row">
52
- <td><strong>Class</strong></td>
53
- <td class="class-name-in-header">RDoc::AnyMethod</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../../files/lib/erbook/rdoc_rb.html">
59
- lib/erbook/rdoc.rb
60
- </a>
61
- <br />
62
- </td>
63
- </tr>
64
-
65
- <tr class="top-aligned-row">
66
- <td><strong>Parent:</strong></td>
67
- <td>
68
- Object
69
- </td>
70
- </tr>
71
- </table>
72
- </div>
73
- <!-- banner header -->
74
-
75
- <div id="bodyContent">
76
-
77
-
78
-
79
- <div id="contextContent">
80
-
81
-
82
-
83
- </div>
84
-
85
- <div id="method-list">
86
- <h3 class="section-bar">Methods</h3>
87
-
88
- <div class="name-list">
89
- <a href="#M000005">comment_html</a>&nbsp;&nbsp;
90
- <a href="#M000004">decl</a>&nbsp;&nbsp;
91
- <a href="#M000003">full_name</a>&nbsp;&nbsp;
92
- <a href="#M000006">top_level</a>&nbsp;&nbsp;
93
- </div>
94
- </div>
95
-
96
- </div>
97
-
98
-
99
- <!-- if includes -->
100
-
101
- <div id="section">
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
- <!-- if method_list -->
111
- <div id="methods">
112
- <h3 class="section-bar">Public Instance methods</h3>
113
-
114
- <div id="method-M000005" class="method-detail">
115
- <a name="M000005"></a>
116
-
117
- <div class="method-heading">
118
- <a href="AnyMethod.src/M000005.html" target="Code" class="method-signature"
119
- onclick="popupCode('AnyMethod.src/M000005.html');return false;">
120
- <span class="method-name">comment_html</span><span class="method-args">()</span>
121
- </a>
122
- </div>
123
-
124
- <div class="method-description">
125
- <p>
126
- Returns a HTML version of this method&#8216;s comment.
127
- </p>
128
- </div>
129
- </div>
130
-
131
- <div id="method-M000004" class="method-detail">
132
- <a name="M000004"></a>
133
-
134
- <div class="method-heading">
135
- <a href="AnyMethod.src/M000004.html" target="Code" class="method-signature"
136
- onclick="popupCode('AnyMethod.src/M000004.html');return false;">
137
- <span class="method-name">decl</span><span class="method-args">()</span>
138
- </a>
139
- </div>
140
-
141
- <div class="method-description">
142
- <p>
143
- Returns a complete method declaration with block parameters and all.
144
- </p>
145
- </div>
146
- </div>
147
-
148
- <div id="method-M000003" class="method-detail">
149
- <a name="M000003"></a>
150
-
151
- <div class="method-heading">
152
- <a href="AnyMethod.src/M000003.html" target="Code" class="method-signature"
153
- onclick="popupCode('AnyMethod.src/M000003.html');return false;">
154
- <span class="method-name">full_name</span><span class="method-args">()</span>
155
- </a>
156
- </div>
157
-
158
- <div class="method-description">
159
- <p>
160
- Returns the fully qualified name of this method.
161
- </p>
162
- </div>
163
- </div>
164
-
165
- <div id="method-M000006" class="method-detail">
166
- <a name="M000006"></a>
167
-
168
- <div class="method-heading">
169
- <a href="AnyMethod.src/M000006.html" target="Code" class="method-signature"
170
- onclick="popupCode('AnyMethod.src/M000006.html');return false;">
171
- <span class="method-name">top_level</span><span class="method-args">()</span>
172
- </a>
173
- </div>
174
-
175
- <div class="method-description">
176
- <p>
177
- Returns the <a href="TopLevel.html">RDoc::TopLevel</a> object which
178
- contains this method.
179
- </p>
180
- </div>
181
- </div>
182
-
183
-
184
- </div>
185
-
186
-
187
- </div>
188
-
189
-
190
- <div id="validator-badges">
191
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
192
- </div>
193
-
194
- </body>
195
- </html>
@@ -1,18 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html>
7
- <head>
8
- <title>full_name (RDoc::AnyMethod)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/erbook/rdoc.rb, line 76</span>
14
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">full_name</span>
15
- [<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">full_name</span>, <span class="ruby-identifier">name</span>].<span class="ruby-identifier">join</span>(<span class="ruby-identifier">singleton</span> <span class="ruby-value">? </span><span class="ruby-value str">'::'</span> <span class="ruby-operator">:</span> <span class="ruby-value str">'#'</span>)
16
- <span class="ruby-keyword kw">end</span></pre>
17
- </body>
18
- </html>
@@ -1,23 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html>
7
- <head>
8
- <title>decl (RDoc::AnyMethod)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/erbook/rdoc.rb, line 81</span>
14
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">decl</span>
15
- <span class="ruby-identifier">a</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">dup</span>
16
- <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">b</span> = <span class="ruby-identifier">block_params</span>
17
- <span class="ruby-identifier">a</span>.<span class="ruby-identifier">sub!</span> <span class="ruby-regexp re">%r/\s*\#.*(?=.$)/</span>, <span class="ruby-value str">''</span> <span class="ruby-comment cmt"># remove &quot;# :yields: ...&quot; string</span>
18
- <span class="ruby-identifier">a</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot; {|#{b}| ... }&quot;</span>
19
- <span class="ruby-keyword kw">end</span>
20
- <span class="ruby-identifier">full_name</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">a</span>
21
- <span class="ruby-keyword kw">end</span></pre>
22
- </body>
23
- </html>
@@ -1,18 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html>
7
- <head>
8
- <title>comment_html (RDoc::AnyMethod)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/erbook/rdoc.rb, line 91</span>
14
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">comment_html</span>
15
- <span class="ruby-constant">DummyMarkup</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">markup</span> <span class="ruby-identifier">comment</span>
16
- <span class="ruby-keyword kw">end</span></pre>
17
- </body>
18
- </html>
@@ -1,22 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html>
7
- <head>
8
- <title>top_level (RDoc::AnyMethod)</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
11
- </head>
12
- <body class="standalone-code">
13
- <pre><span class="ruby-comment cmt"># File lib/erbook/rdoc.rb, line 96</span>
14
- <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">top_level</span>
15
- <span class="ruby-identifier">n</span> = <span class="ruby-identifier">parent</span>
16
- <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">n</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">n</span>.<span class="ruby-identifier">parent</span>
17
- <span class="ruby-identifier">n</span> = <span class="ruby-identifier">n</span>.<span class="ruby-identifier">parent</span>
18
- <span class="ruby-keyword kw">end</span>
19
- <span class="ruby-identifier">n</span>
20
- <span class="ruby-keyword kw">end</span></pre>
21
- </body>
22
- </html>
@@ -1,250 +0,0 @@
1
- <?xml version="1.0" encoding="iso-8859-1"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
- <head>
8
- <title>Class: RDoc::TopLevel</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12
- <script type="text/javascript">
13
- // <![CDATA[
14
-
15
- function popupCode( url ) {
16
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
- }
18
-
19
- function toggleCode( id ) {
20
- if ( document.getElementById )
21
- elem = document.getElementById( id );
22
- else if ( document.all )
23
- elem = eval( "document.all." + id );
24
- else
25
- return false;
26
-
27
- elemStyle = elem.style;
28
-
29
- if ( elemStyle.display != "block" ) {
30
- elemStyle.display = "block"
31
- } else {
32
- elemStyle.display = "none"
33
- }
34
-
35
- return true;
36
- }
37
-
38
- // Make codeblocks hidden by default
39
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
-
41
- // ]]>
42
- </script>
43
-
44
- </head>
45
- <body>
46
-
47
-
48
-
49
- <div id="classHeader">
50
- <table class="header-table">
51
- <tr class="top-aligned-row">
52
- <td><strong>Class</strong></td>
53
- <td class="class-name-in-header">RDoc::TopLevel</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../../files/lib/erbook/rdoc_rb.html">
59
- lib/erbook/rdoc.rb
60
- </a>
61
- <br />
62
- </td>
63
- </tr>
64
-
65
- <tr class="top-aligned-row">
66
- <td><strong>Parent:</strong></td>
67
- <td>
68
- Object
69
- </td>
70
- </tr>
71
- </table>
72
- </div>
73
- <!-- banner header -->
74
-
75
- <div id="bodyContent">
76
-
77
-
78
-
79
- <div id="contextContent">
80
-
81
-
82
-
83
- </div>
84
-
85
- <div id="method-list">
86
- <h3 class="section-bar">Methods</h3>
87
-
88
- <div class="name-list">
89
- <a href="#M000007">all_classes</a>&nbsp;&nbsp;
90
- <a href="#M000009">all_methods</a>&nbsp;&nbsp;
91
- <a href="#M000008">all_modules</a>&nbsp;&nbsp;
92
- <a href="#M000011">parse</a>&nbsp;&nbsp;
93
- <a href="#M000012">parse_file</a>&nbsp;&nbsp;
94
- <a href="#M000010">refresh_all_classes_and_modules</a>&nbsp;&nbsp;
95
- </div>
96
- </div>
97
-
98
- </div>
99
-
100
-
101
- <!-- if includes -->
102
-
103
- <div id="section">
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
- <!-- if method_list -->
113
- <div id="methods">
114
- <h3 class="section-bar">Public Class methods</h3>
115
-
116
- <div id="method-M000007" class="method-detail">
117
- <a name="M000007"></a>
118
-
119
- <div class="method-heading">
120
- <a href="TopLevel.src/M000007.html" target="Code" class="method-signature"
121
- onclick="popupCode('TopLevel.src/M000007.html');return false;">
122
- <span class="method-name">all_classes</span><span class="method-args">()</span>
123
- </a>
124
- </div>
125
-
126
- <div class="method-description">
127
- <p>
128
- Returns an array of all classes recorded thus far.
129
- </p>
130
- </div>
131
- </div>
132
-
133
- <div id="method-M000009" class="method-detail">
134
- <a name="M000009"></a>
135
-
136
- <div class="method-heading">
137
- <a href="TopLevel.src/M000009.html" target="Code" class="method-signature"
138
- onclick="popupCode('TopLevel.src/M000009.html');return false;">
139
- <span class="method-name">all_methods</span><span class="method-args">()</span>
140
- </a>
141
- </div>
142
-
143
- <div class="method-description">
144
- <p>
145
- Returns an array of <a href="AnyMethod.html">RDoc::AnyMethod</a> objects
146
- representing all methods recorded thus far.
147
- </p>
148
- </div>
149
- </div>
150
-
151
- <div id="method-M000008" class="method-detail">
152
- <a name="M000008"></a>
153
-
154
- <div class="method-heading">
155
- <a href="TopLevel.src/M000008.html" target="Code" class="method-signature"
156
- onclick="popupCode('TopLevel.src/M000008.html');return false;">
157
- <span class="method-name">all_modules</span><span class="method-args">()</span>
158
- </a>
159
- </div>
160
-
161
- <div class="method-description">
162
- <p>
163
- Returns an array of all modules recorded thus far.
164
- </p>
165
- </div>
166
- </div>
167
-
168
- <div id="method-M000011" class="method-detail">
169
- <a name="M000011"></a>
170
-
171
- <div class="method-heading">
172
- <a href="TopLevel.src/M000011.html" target="Code" class="method-signature"
173
- onclick="popupCode('TopLevel.src/M000011.html');return false;">
174
- <span class="method-name">parse</span><span class="method-args">(aCodeString, aFileName = __FILE__)</span>
175
- </a>
176
- </div>
177
-
178
- <div class="method-description">
179
- <p>
180
- Returns a <a href="TopLevel.html">RDoc::TopLevel</a> object containing
181
- information parsed from the given code string. This information is also
182
- added to the global <a href="TopLevel.html">TopLevel</a> class state, so
183
- you can access it via the class methods of the <a
184
- href="TopLevel.html">TopLevel</a> class.
185
- </p>
186
- <p>
187
- If the file name (which signifies the origin of the given code) is given,
188
- it MUST have a &quot;.c&quot; or &quot;.rb&quot; file extension. Otherwise,
189
- <a href="../RDoc.html">RDoc</a> will ignore the given code string! :-(
190
- </p>
191
- </div>
192
- </div>
193
-
194
- <div id="method-M000012" class="method-detail">
195
- <a name="M000012"></a>
196
-
197
- <div class="method-heading">
198
- <a href="TopLevel.src/M000012.html" target="Code" class="method-signature"
199
- onclick="popupCode('TopLevel.src/M000012.html');return false;">
200
- <span class="method-name">parse_file</span><span class="method-args">(aFileName)</span>
201
- </a>
202
- </div>
203
-
204
- <div class="method-description">
205
- <p>
206
- Returns a <a href="TopLevel.html">RDoc::TopLevel</a> object containing
207
- information parsed from the code in the given file. This information is
208
- also added to the global <a href="TopLevel.html">TopLevel</a> class state,
209
- so you can access it via the class methods of the <a
210
- href="TopLevel.html">TopLevel</a> class.
211
- </p>
212
- <p>
213
- The given file name MUST have a &quot;.c&quot; or &quot;.rb&quot; file
214
- extension. Otherwise, <a href="../RDoc.html">RDoc</a> will ignore the file!
215
- :-(
216
- </p>
217
- </div>
218
- </div>
219
-
220
- <div id="method-M000010" class="method-detail">
221
- <a name="M000010"></a>
222
-
223
- <div class="method-heading">
224
- <a href="TopLevel.src/M000010.html" target="Code" class="method-signature"
225
- onclick="popupCode('TopLevel.src/M000010.html');return false;">
226
- <span class="method-name">refresh_all_classes_and_modules</span><span class="method-args">()</span>
227
- </a>
228
- </div>
229
-
230
- <div class="method-description">
231
- <p>
232
- Update the return value of the all_classes_and_modules() method to
233
- <b>really</b> include every class and every module seen thus far.
234
- </p>
235
- </div>
236
- </div>
237
-
238
-
239
- </div>
240
-
241
-
242
- </div>
243
-
244
-
245
- <div id="validator-badges">
246
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
247
- </div>
248
-
249
- </body>
250
- </html>