scharfie-rails-footnotes 3.4.2 → 3.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (66) hide show
  1. data/VERSION +1 -0
  2. data/pkg/scharfie-rails-footnotes-3.4.2.gem +0 -0
  3. data/rdoc/classes/ActionController.html +107 -0
  4. data/rdoc/classes/ActionController/Base.html +119 -0
  5. data/rdoc/classes/Footnotes.html +186 -0
  6. data/rdoc/classes/Footnotes/Components.html +211 -0
  7. data/rdoc/classes/Footnotes/Extensions.html +128 -0
  8. data/rdoc/classes/Footnotes/Extensions/AbstractAdapter.html +148 -0
  9. data/rdoc/classes/Footnotes/Extensions/Exception.html +205 -0
  10. data/rdoc/classes/Footnotes/Extensions/MockController.html +111 -0
  11. data/rdoc/classes/Footnotes/Extensions/QueryAnalyzer.html +183 -0
  12. data/rdoc/classes/Footnotes/Extensions/Routes.html +148 -0
  13. data/rdoc/classes/Footnotes/Extensions/Sql.html +191 -0
  14. data/rdoc/classes/Footnotes/Filter.html +928 -0
  15. data/rdoc/classes/Footnotes/Notes.html +194 -0
  16. data/rdoc/classes/Footnotes/Notes/AbstractNote.html +698 -0
  17. data/rdoc/classes/Footnotes/Notes/ComponentsNote.html +221 -0
  18. data/rdoc/classes/Footnotes/Notes/ComponentsNote/ClassMethods.html +164 -0
  19. data/rdoc/classes/Footnotes/Notes/ControllerComponentNote.html +120 -0
  20. data/rdoc/classes/Footnotes/Notes/ControllerNote.html +361 -0
  21. data/rdoc/classes/Footnotes/Notes/CookiesNote.html +198 -0
  22. data/rdoc/classes/Footnotes/Notes/EnvNote.html +178 -0
  23. data/rdoc/classes/Footnotes/Notes/FilesNote.html +284 -0
  24. data/rdoc/classes/Footnotes/Notes/FiltersNote.html +291 -0
  25. data/rdoc/classes/Footnotes/Notes/GeneralNote.html +196 -0
  26. data/rdoc/classes/Footnotes/Notes/JavascriptsNote.html +174 -0
  27. data/rdoc/classes/Footnotes/Notes/LayoutNote.html +248 -0
  28. data/rdoc/classes/Footnotes/Notes/LogNote.html +216 -0
  29. data/rdoc/classes/Footnotes/Notes/ParamsComponentNote.html +120 -0
  30. data/rdoc/classes/Footnotes/Notes/ParamsNote.html +198 -0
  31. data/rdoc/classes/Footnotes/Notes/QueriesNote.html +384 -0
  32. data/rdoc/classes/Footnotes/Notes/RoutesNote.html +240 -0
  33. data/rdoc/classes/Footnotes/Notes/SessionNote.html +174 -0
  34. data/rdoc/classes/Footnotes/Notes/StylesheetsNote.html +174 -0
  35. data/rdoc/classes/Footnotes/Notes/ViewComponentNote.html +120 -0
  36. data/rdoc/classes/Footnotes/Notes/ViewNote.html +273 -0
  37. data/rdoc/created.rid +1 -0
  38. data/rdoc/files/README.html +118 -0
  39. data/rdoc/files/lib/rails-footnotes/backtracer_rb.html +101 -0
  40. data/rdoc/files/lib/rails-footnotes/footnotes_rb.html +101 -0
  41. data/rdoc/files/lib/rails-footnotes/notes/abstract_note_rb.html +101 -0
  42. data/rdoc/files/lib/rails-footnotes/notes/components_note_rb.html +101 -0
  43. data/rdoc/files/lib/rails-footnotes/notes/controller_note_rb.html +101 -0
  44. data/rdoc/files/lib/rails-footnotes/notes/cookies_note_rb.html +101 -0
  45. data/rdoc/files/lib/rails-footnotes/notes/env_note_rb.html +101 -0
  46. data/rdoc/files/lib/rails-footnotes/notes/files_note_rb.html +101 -0
  47. data/rdoc/files/lib/rails-footnotes/notes/filters_note_rb.html +101 -0
  48. data/rdoc/files/lib/rails-footnotes/notes/general_note_rb.html +101 -0
  49. data/rdoc/files/lib/rails-footnotes/notes/javascripts_note_rb.html +101 -0
  50. data/rdoc/files/lib/rails-footnotes/notes/layout_note_rb.html +101 -0
  51. data/rdoc/files/lib/rails-footnotes/notes/log_note_rb.html +101 -0
  52. data/rdoc/files/lib/rails-footnotes/notes/params_note_rb.html +101 -0
  53. data/rdoc/files/lib/rails-footnotes/notes/queries_note_rb.html +101 -0
  54. data/rdoc/files/lib/rails-footnotes/notes/routes_note_rb.html +101 -0
  55. data/rdoc/files/lib/rails-footnotes/notes/session_note_rb.html +101 -0
  56. data/rdoc/files/lib/rails-footnotes/notes/stylesheets_note_rb.html +101 -0
  57. data/rdoc/files/lib/rails-footnotes/notes/view_note_rb.html +101 -0
  58. data/rdoc/files/lib/rails-footnotes_rb.html +101 -0
  59. data/rdoc/fr_class_index.html +60 -0
  60. data/rdoc/fr_file_index.html +47 -0
  61. data/rdoc/fr_method_index.html +156 -0
  62. data/rdoc/index.html +24 -0
  63. data/rdoc/rdoc-style.css +208 -0
  64. data/scharfie-rails-footnotes.gemspec +142 -0
  65. metadata +66 -3
  66. data/rails-footnotes.gemspec +0 -46
data/rdoc/classes/Footnotes/Notes.html ADDED
@@ -0,0 +1,194 @@
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>Module: Footnotes::Notes</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>Module</strong></td>
53
+ <td class="class-name-in-header">Footnotes::Notes</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../files/lib/rails-footnotes/notes/abstract_note_rb.html">
59
+ lib/rails-footnotes/notes/abstract_note.rb
60
+ </a>
61
+ <br />
62
+ <a href="../../files/lib/rails-footnotes/notes/components_note_rb.html">
63
+ lib/rails-footnotes/notes/components_note.rb
64
+ </a>
65
+ <br />
66
+ <a href="../../files/lib/rails-footnotes/notes/controller_note_rb.html">
67
+ lib/rails-footnotes/notes/controller_note.rb
68
+ </a>
69
+ <br />
70
+ <a href="../../files/lib/rails-footnotes/notes/cookies_note_rb.html">
71
+ lib/rails-footnotes/notes/cookies_note.rb
72
+ </a>
73
+ <br />
74
+ <a href="../../files/lib/rails-footnotes/notes/env_note_rb.html">
75
+ lib/rails-footnotes/notes/env_note.rb
76
+ </a>
77
+ <br />
78
+ <a href="../../files/lib/rails-footnotes/notes/files_note_rb.html">
79
+ lib/rails-footnotes/notes/files_note.rb
80
+ </a>
81
+ <br />
82
+ <a href="../../files/lib/rails-footnotes/notes/filters_note_rb.html">
83
+ lib/rails-footnotes/notes/filters_note.rb
84
+ </a>
85
+ <br />
86
+ <a href="../../files/lib/rails-footnotes/notes/general_note_rb.html">
87
+ lib/rails-footnotes/notes/general_note.rb
88
+ </a>
89
+ <br />
90
+ <a href="../../files/lib/rails-footnotes/notes/javascripts_note_rb.html">
91
+ lib/rails-footnotes/notes/javascripts_note.rb
92
+ </a>
93
+ <br />
94
+ <a href="../../files/lib/rails-footnotes/notes/layout_note_rb.html">
95
+ lib/rails-footnotes/notes/layout_note.rb
96
+ </a>
97
+ <br />
98
+ <a href="../../files/lib/rails-footnotes/notes/log_note_rb.html">
99
+ lib/rails-footnotes/notes/log_note.rb
100
+ </a>
101
+ <br />
102
+ <a href="../../files/lib/rails-footnotes/notes/params_note_rb.html">
103
+ lib/rails-footnotes/notes/params_note.rb
104
+ </a>
105
+ <br />
106
+ <a href="../../files/lib/rails-footnotes/notes/queries_note_rb.html">
107
+ lib/rails-footnotes/notes/queries_note.rb
108
+ </a>
109
+ <br />
110
+ <a href="../../files/lib/rails-footnotes/notes/routes_note_rb.html">
111
+ lib/rails-footnotes/notes/routes_note.rb
112
+ </a>
113
+ <br />
114
+ <a href="../../files/lib/rails-footnotes/notes/session_note_rb.html">
115
+ lib/rails-footnotes/notes/session_note.rb
116
+ </a>
117
+ <br />
118
+ <a href="../../files/lib/rails-footnotes/notes/stylesheets_note_rb.html">
119
+ lib/rails-footnotes/notes/stylesheets_note.rb
120
+ </a>
121
+ <br />
122
+ <a href="../../files/lib/rails-footnotes/notes/view_note_rb.html">
123
+ lib/rails-footnotes/notes/view_note.rb
124
+ </a>
125
+ <br />
126
+ </td>
127
+ </tr>
128
+
129
+ </table>
130
+ </div>
131
+ <!-- banner header -->
132
+
133
+ <div id="bodyContent">
134
+
135
+
136
+
137
+ <div id="contextContent">
138
+
139
+
140
+
141
+ </div>
142
+
143
+
144
+ </div>
145
+
146
+
147
+ <!-- if includes -->
148
+
149
+ <div id="section">
150
+
151
+ <div id="class-list">
152
+ <h3 class="section-bar">Classes and Modules</h3>
153
+
154
+ Module <a href="Notes/ComponentsNote.html" class="link">Footnotes::Notes::ComponentsNote</a><br />
155
+ Class <a href="Notes/AbstractNote.html" class="link">Footnotes::Notes::AbstractNote</a><br />
156
+ Class <a href="Notes/ControllerComponentNote.html" class="link">Footnotes::Notes::ControllerComponentNote</a><br />
157
+ Class <a href="Notes/ControllerNote.html" class="link">Footnotes::Notes::ControllerNote</a><br />
158
+ Class <a href="Notes/CookiesNote.html" class="link">Footnotes::Notes::CookiesNote</a><br />
159
+ Class <a href="Notes/EnvNote.html" class="link">Footnotes::Notes::EnvNote</a><br />
160
+ Class <a href="Notes/FilesNote.html" class="link">Footnotes::Notes::FilesNote</a><br />
161
+ Class <a href="Notes/FiltersNote.html" class="link">Footnotes::Notes::FiltersNote</a><br />
162
+ Class <a href="Notes/GeneralNote.html" class="link">Footnotes::Notes::GeneralNote</a><br />
163
+ Class <a href="Notes/JavascriptsNote.html" class="link">Footnotes::Notes::JavascriptsNote</a><br />
164
+ Class <a href="Notes/LayoutNote.html" class="link">Footnotes::Notes::LayoutNote</a><br />
165
+ Class <a href="Notes/LogNote.html" class="link">Footnotes::Notes::LogNote</a><br />
166
+ Class <a href="Notes/ParamsComponentNote.html" class="link">Footnotes::Notes::ParamsComponentNote</a><br />
167
+ Class <a href="Notes/ParamsNote.html" class="link">Footnotes::Notes::ParamsNote</a><br />
168
+ Class <a href="Notes/QueriesNote.html" class="link">Footnotes::Notes::QueriesNote</a><br />
169
+ Class <a href="Notes/RoutesNote.html" class="link">Footnotes::Notes::RoutesNote</a><br />
170
+ Class <a href="Notes/SessionNote.html" class="link">Footnotes::Notes::SessionNote</a><br />
171
+ Class <a href="Notes/StylesheetsNote.html" class="link">Footnotes::Notes::StylesheetsNote</a><br />
172
+ Class <a href="Notes/ViewComponentNote.html" class="link">Footnotes::Notes::ViewComponentNote</a><br />
173
+ Class <a href="Notes/ViewNote.html" class="link">Footnotes::Notes::ViewNote</a><br />
174
+
175
+ </div>
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+ <!-- if method_list -->
184
+
185
+
186
+ </div>
187
+
188
+
189
+ <div id="validator-badges">
190
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
191
+ </div>
192
+
193
+ </body>
194
+ </html>
data/rdoc/classes/Footnotes/Notes/AbstractNote.html ADDED
@@ -0,0 +1,698 @@
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: Footnotes::Notes::AbstractNote</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">Footnotes::Notes::AbstractNote</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../../../files/lib/rails-footnotes/notes/abstract_note_rb.html">
59
+ lib/rails-footnotes/notes/abstract_note.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
+ <div id="description">
82
+ <p>
83
+ This is the abstract class for notes. You can overwrite all instance public
84
+ methods to create your notes.
85
+ </p>
86
+
87
+ </div>
88
+
89
+
90
+ </div>
91
+
92
+ <div id="method-list">
93
+ <h3 class="section-bar">Methods</h3>
94
+
95
+ <div class="name-list">
96
+ <a href="#M000071">close!</a>&nbsp;&nbsp;
97
+ <a href="#M000084">escape</a>&nbsp;&nbsp;
98
+ <a href="#M000082">has_fieldset?</a>&nbsp;&nbsp;
99
+ <a href="#M000086">hash_to_xml_attributes</a>&nbsp;&nbsp;
100
+ <a href="#M000069">included?</a>&nbsp;&nbsp;
101
+ <a href="#M000080">javascript</a>&nbsp;&nbsp;
102
+ <a href="#M000076">legend</a>&nbsp;&nbsp;
103
+ <a href="#M000077">link</a>&nbsp;&nbsp;
104
+ <a href="#M000085">mount_table</a>&nbsp;&nbsp;
105
+ <a href="#M000072">new</a>&nbsp;&nbsp;
106
+ <a href="#M000078">onclick</a>&nbsp;&nbsp;
107
+ <a href="#M000083">prefix?</a>&nbsp;&nbsp;
108
+ <a href="#M000074">row</a>&nbsp;&nbsp;
109
+ <a href="#M000070">start!</a>&nbsp;&nbsp;
110
+ <a href="#M000079">stylesheet</a>&nbsp;&nbsp;
111
+ <a href="#M000075">title</a>&nbsp;&nbsp;
112
+ <a href="#M000068">title</a>&nbsp;&nbsp;
113
+ <a href="#M000073">to_sym</a>&nbsp;&nbsp;
114
+ <a href="#M000067">to_sym</a>&nbsp;&nbsp;
115
+ <a href="#M000081">valid?</a>&nbsp;&nbsp;
116
+ </div>
117
+ </div>
118
+
119
+ </div>
120
+
121
+
122
+ <!-- if includes -->
123
+
124
+ <div id="section">
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+ <!-- if method_list -->
134
+ <div id="methods">
135
+ <h3 class="section-bar">Public Class methods</h3>
136
+
137
+ <div id="method-M000071" class="method-detail">
138
+ <a name="M000071"></a>
139
+
140
+ <div class="method-heading">
141
+ <a href="#M000071" class="method-signature">
142
+ <span class="method-name">close!</span><span class="method-args">(controller = nil)</span>
143
+ </a>
144
+ </div>
145
+
146
+ <div class="method-description">
147
+ <p>
148
+ Action to be called after the Note was used. This is applied as an
149
+ after_filter.
150
+ </p>
151
+ <p><a class="source-toggle" href="#"
152
+ onclick="toggleCode('M000071-source');return false;">[Source]</a></p>
153
+ <div class="method-source-code" id="M000071-source">
154
+ <pre>
155
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 44</span>
156
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close!</span>(<span class="ruby-identifier">controller</span> = <span class="ruby-keyword kw">nil</span>)
157
+ <span class="ruby-keyword kw">end</span>
158
+ </pre>
159
+ </div>
160
+ </div>
161
+ </div>
162
+
163
+ <div id="method-M000069" class="method-detail">
164
+ <a name="M000069"></a>
165
+
166
+ <div class="method-heading">
167
+ <a href="#M000069" class="method-signature">
168
+ <span class="method-name">included?</span><span class="method-args">()</span>
169
+ </a>
170
+ </div>
171
+
172
+ <div class="method-description">
173
+ <p>
174
+ Return true if Note is included in notes array.
175
+ </p>
176
+ <p><a class="source-toggle" href="#"
177
+ onclick="toggleCode('M000069-source');return false;">[Source]</a></p>
178
+ <div class="method-source-code" id="M000069-source">
179
+ <pre>
180
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 31</span>
181
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">included?</span>
182
+ <span class="ruby-constant">Footnotes</span><span class="ruby-operator">::</span><span class="ruby-constant">Filter</span>.<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_sym</span>)
183
+ <span class="ruby-keyword kw">end</span>
184
+ </pre>
185
+ </div>
186
+ </div>
187
+ </div>
188
+
189
+ <div id="method-M000072" class="method-detail">
190
+ <a name="M000072"></a>
191
+
192
+ <div class="method-heading">
193
+ <a href="#M000072" class="method-signature">
194
+ <span class="method-name">new</span><span class="method-args">(controller = nil)</span>
195
+ </a>
196
+ </div>
197
+
198
+ <div class="method-description">
199
+ <p>
200
+ Initialize notes. Always receives a controller.
201
+ </p>
202
+ <p><a class="source-toggle" href="#"
203
+ onclick="toggleCode('M000072-source');return false;">[Source]</a></p>
204
+ <div class="method-source-code" id="M000072-source">
205
+ <pre>
206
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 51</span>
207
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">controller</span> = <span class="ruby-keyword kw">nil</span>)
208
+ <span class="ruby-keyword kw">end</span>
209
+ </pre>
210
+ </div>
211
+ </div>
212
+ </div>
213
+
214
+ <div id="method-M000070" class="method-detail">
215
+ <a name="M000070"></a>
216
+
217
+ <div class="method-heading">
218
+ <a href="#M000070" class="method-signature">
219
+ <span class="method-name">start!</span><span class="method-args">(controller = nil)</span>
220
+ </a>
221
+ </div>
222
+
223
+ <div class="method-description">
224
+ <p>
225
+ Action to be called to start the Note. This is applied as a before_filter.
226
+ </p>
227
+ <p><a class="source-toggle" href="#"
228
+ onclick="toggleCode('M000070-source');return false;">[Source]</a></p>
229
+ <div class="method-source-code" id="M000070-source">
230
+ <pre>
231
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 38</span>
232
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start!</span>(<span class="ruby-identifier">controller</span> = <span class="ruby-keyword kw">nil</span>)
233
+ <span class="ruby-keyword kw">end</span>
234
+ </pre>
235
+ </div>
236
+ </div>
237
+ </div>
238
+
239
+ <div id="method-M000068" class="method-detail">
240
+ <a name="M000068"></a>
241
+
242
+ <div class="method-heading">
243
+ <a href="#M000068" class="method-signature">
244
+ <span class="method-name">title</span><span class="method-args">()</span>
245
+ </a>
246
+ </div>
247
+
248
+ <div class="method-description">
249
+ <p>
250
+ Returns the <a href="AbstractNote.html#M000068">title</a> that represents
251
+ this note. It&#8216;s the name of the class without Note.
252
+ </p>
253
+ <p>
254
+ For example, for <a href="ControllerNote.html">ControllerNote</a> it will
255
+ return Controller.
256
+ </p>
257
+ <p><a class="source-toggle" href="#"
258
+ onclick="toggleCode('M000068-source');return false;">[Source]</a></p>
259
+ <div class="method-source-code" id="M000068-source">
260
+ <pre>
261
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 25</span>
262
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">title</span>
263
+ <span class="ruby-ivar">@note_title</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp re">/^Footnotes::Notes::(\w+)Note$/</span>)[<span class="ruby-value">1</span>]
264
+ <span class="ruby-keyword kw">end</span>
265
+ </pre>
266
+ </div>
267
+ </div>
268
+ </div>
269
+
270
+ <div id="method-M000067" class="method-detail">
271
+ <a name="M000067"></a>
272
+
273
+ <div class="method-heading">
274
+ <a href="#M000067" class="method-signature">
275
+ <span class="method-name">to_sym</span><span class="method-args">()</span>
276
+ </a>
277
+ </div>
278
+
279
+ <div class="method-description">
280
+ <p>
281
+ Returns the symbol that represents this note. It&#8216;s the name of the
282
+ class, underscored and without _note.
283
+ </p>
284
+ <p>
285
+ For example, for <a href="ControllerNote.html">ControllerNote</a> it will
286
+ return :controller.
287
+ </p>
288
+ <p><a class="source-toggle" href="#"
289
+ onclick="toggleCode('M000067-source');return false;">[Source]</a></p>
290
+ <div class="method-source-code" id="M000067-source">
291
+ <pre>
292
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 16</span>
293
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_sym</span>
294
+ <span class="ruby-ivar">@note_sym</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">title</span>.<span class="ruby-identifier">underscore</span>.<span class="ruby-identifier">to_sym</span>
295
+ <span class="ruby-keyword kw">end</span>
296
+ </pre>
297
+ </div>
298
+ </div>
299
+ </div>
300
+
301
+ <h3 class="section-bar">Public Instance methods</h3>
302
+
303
+ <div id="method-M000082" class="method-detail">
304
+ <a name="M000082"></a>
305
+
306
+ <div class="method-heading">
307
+ <a href="#M000082" class="method-signature">
308
+ <span class="method-name">has_fieldset?</span><span class="method-args">()</span>
309
+ </a>
310
+ </div>
311
+
312
+ <div class="method-description">
313
+ <p>
314
+ Specifies when should create a fieldset for it, considering it&#8216;s
315
+ valid.
316
+ </p>
317
+ <p><a class="source-toggle" href="#"
318
+ onclick="toggleCode('M000082-source');return false;">[Source]</a></p>
319
+ <div class="method-source-code" id="M000082-source">
320
+ <pre>
321
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 120</span>
322
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_fieldset?</span>
323
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:content</span>)
324
+ <span class="ruby-keyword kw">end</span>
325
+ </pre>
326
+ </div>
327
+ </div>
328
+ </div>
329
+
330
+ <div id="method-M000080" class="method-detail">
331
+ <a name="M000080"></a>
332
+
333
+ <div class="method-heading">
334
+ <a href="#M000080" class="method-signature">
335
+ <span class="method-name">javascript</span><span class="method-args">()</span>
336
+ </a>
337
+ </div>
338
+
339
+ <div class="method-description">
340
+ <p>
341
+ Insert here any additional <a
342
+ href="AbstractNote.html#M000080">javascript</a>. This is directly inserted
343
+ into a &lt;script&gt; tag.
344
+ </p>
345
+ <p><a class="source-toggle" href="#"
346
+ onclick="toggleCode('M000080-source');return false;">[Source]</a></p>
347
+ <div class="method-source-code" id="M000080-source">
348
+ <pre>
349
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 108</span>
350
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">javascript</span>
351
+ <span class="ruby-keyword kw">end</span>
352
+ </pre>
353
+ </div>
354
+ </div>
355
+ </div>
356
+
357
+ <div id="method-M000076" class="method-detail">
358
+ <a name="M000076"></a>
359
+
360
+ <div class="method-heading">
361
+ <a href="#M000076" class="method-signature">
362
+ <span class="method-name">legend</span><span class="method-args">()</span>
363
+ </a>
364
+ </div>
365
+
366
+ <div class="method-description">
367
+ <p>
368
+ If <a href="AbstractNote.html#M000082">has_fieldset?</a> is true, create a
369
+ fieldset with the value returned as <a
370
+ href="AbstractNote.html#M000076">legend</a>. By default, returns the <a
371
+ href="AbstractNote.html#M000068">title</a> of the class (defined above).
372
+ </p>
373
+ <p><a class="source-toggle" href="#"
374
+ onclick="toggleCode('M000076-source');return false;">[Source]</a></p>
375
+ <div class="method-source-code" id="M000076-source">
376
+ <pre>
377
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 77</span>
378
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">legend</span>
379
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">title</span>
380
+ <span class="ruby-keyword kw">end</span>
381
+ </pre>
382
+ </div>
383
+ </div>
384
+ </div>
385
+
386
+ <div id="method-M000077" class="method-detail">
387
+ <a name="M000077"></a>
388
+
389
+ <div class="method-heading">
390
+ <a href="#M000077" class="method-signature">
391
+ <span class="method-name">link</span><span class="method-args">()</span>
392
+ </a>
393
+ </div>
394
+
395
+ <div class="method-description">
396
+ <p>
397
+ Set href field for <a href="../../Footnotes.html">Footnotes</a> links. If
398
+ it&#8216;s nil, <a href="../../Footnotes.html">Footnotes</a> will use
399
+ &#8217;#&#8217;.
400
+ </p>
401
+ <p><a class="source-toggle" href="#"
402
+ onclick="toggleCode('M000077-source');return false;">[Source]</a></p>
403
+ <div class="method-source-code" id="M000077-source">
404
+ <pre>
405
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 90</span>
406
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">link</span>
407
+ <span class="ruby-keyword kw">end</span>
408
+ </pre>
409
+ </div>
410
+ </div>
411
+ </div>
412
+
413
+ <div id="method-M000078" class="method-detail">
414
+ <a name="M000078"></a>
415
+
416
+ <div class="method-heading">
417
+ <a href="#M000078" class="method-signature">
418
+ <span class="method-name">onclick</span><span class="method-args">()</span>
419
+ </a>
420
+ </div>
421
+
422
+ <div class="method-description">
423
+ <p>
424
+ Set <a href="AbstractNote.html#M000078">onclick</a> field for <a
425
+ href="../../Footnotes.html">Footnotes</a> links. If it&#8216;s nil, <a
426
+ href="../../Footnotes.html">Footnotes</a> will make it open the fieldset.
427
+ </p>
428
+ <p><a class="source-toggle" href="#"
429
+ onclick="toggleCode('M000078-source');return false;">[Source]</a></p>
430
+ <div class="method-source-code" id="M000078-source">
431
+ <pre>
432
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 96</span>
433
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">onclick</span>
434
+ <span class="ruby-keyword kw">end</span>
435
+ </pre>
436
+ </div>
437
+ </div>
438
+ </div>
439
+
440
+ <div id="method-M000074" class="method-detail">
441
+ <a name="M000074"></a>
442
+
443
+ <div class="method-heading">
444
+ <a href="#M000074" class="method-signature">
445
+ <span class="method-name">row</span><span class="method-args">()</span>
446
+ </a>
447
+ </div>
448
+
449
+ <div class="method-description">
450
+ <p>
451
+ Specifies in which <a href="AbstractNote.html#M000074">row</a> should
452
+ appear the <a href="AbstractNote.html#M000068">title</a>. The default is
453
+ :show.
454
+ </p>
455
+ <p><a class="source-toggle" href="#"
456
+ onclick="toggleCode('M000074-source');return false;">[Source]</a></p>
457
+ <div class="method-source-code" id="M000074-source">
458
+ <pre>
459
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 63</span>
460
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">row</span>
461
+ <span class="ruby-identifier">:show</span>
462
+ <span class="ruby-keyword kw">end</span>
463
+ </pre>
464
+ </div>
465
+ </div>
466
+ </div>
467
+
468
+ <div id="method-M000079" class="method-detail">
469
+ <a name="M000079"></a>
470
+
471
+ <div class="method-heading">
472
+ <a href="#M000079" class="method-signature">
473
+ <span class="method-name">stylesheet</span><span class="method-args">()</span>
474
+ </a>
475
+ </div>
476
+
477
+ <div class="method-description">
478
+ <p>
479
+ Insert here any additional <a
480
+ href="AbstractNote.html#M000079">stylesheet</a>. This is directly inserted
481
+ into a &lt;style&gt; tag.
482
+ </p>
483
+ <p><a class="source-toggle" href="#"
484
+ onclick="toggleCode('M000079-source');return false;">[Source]</a></p>
485
+ <div class="method-source-code" id="M000079-source">
486
+ <pre>
487
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 102</span>
488
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stylesheet</span>
489
+ <span class="ruby-keyword kw">end</span>
490
+ </pre>
491
+ </div>
492
+ </div>
493
+ </div>
494
+
495
+ <div id="method-M000075" class="method-detail">
496
+ <a name="M000075"></a>
497
+
498
+ <div class="method-heading">
499
+ <a href="#M000075" class="method-signature">
500
+ <span class="method-name">title</span><span class="method-args">()</span>
501
+ </a>
502
+ </div>
503
+
504
+ <div class="method-description">
505
+ <p>
506
+ Returns the <a href="AbstractNote.html#M000068">title</a> to be used as <a
507
+ href="AbstractNote.html#M000077">link</a>. The default is the note <a
508
+ href="AbstractNote.html#M000068">title</a>.
509
+ </p>
510
+ <p><a class="source-toggle" href="#"
511
+ onclick="toggleCode('M000075-source');return false;">[Source]</a></p>
512
+ <div class="method-source-code" id="M000075-source">
513
+ <pre>
514
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 70</span>
515
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">title</span>
516
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">title</span>
517
+ <span class="ruby-keyword kw">end</span>
518
+ </pre>
519
+ </div>
520
+ </div>
521
+ </div>
522
+
523
+ <div id="method-M000073" class="method-detail">
524
+ <a name="M000073"></a>
525
+
526
+ <div class="method-heading">
527
+ <a href="#M000073" class="method-signature">
528
+ <span class="method-name">to_sym</span><span class="method-args">()</span>
529
+ </a>
530
+ </div>
531
+
532
+ <div class="method-description">
533
+ <p>
534
+ Returns the symbol that represents this note.
535
+ </p>
536
+ <p><a class="source-toggle" href="#"
537
+ onclick="toggleCode('M000073-source');return false;">[Source]</a></p>
538
+ <div class="method-source-code" id="M000073-source">
539
+ <pre>
540
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 56</span>
541
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_sym</span>
542
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_sym</span>
543
+ <span class="ruby-keyword kw">end</span>
544
+ </pre>
545
+ </div>
546
+ </div>
547
+ </div>
548
+
549
+ <div id="method-M000081" class="method-detail">
550
+ <a name="M000081"></a>
551
+
552
+ <div class="method-heading">
553
+ <a href="#M000081" class="method-signature">
554
+ <span class="method-name">valid?</span><span class="method-args">()</span>
555
+ </a>
556
+ </div>
557
+
558
+ <div class="method-description">
559
+ <p>
560
+ Specifies when should create a note for it. By default, it&#8216;s valid.
561
+ </p>
562
+ <p><a class="source-toggle" href="#"
563
+ onclick="toggleCode('M000081-source');return false;">[Source]</a></p>
564
+ <div class="method-source-code" id="M000081-source">
565
+ <pre>
566
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 114</span>
567
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid?</span>
568
+ <span class="ruby-keyword kw">true</span>
569
+ <span class="ruby-keyword kw">end</span>
570
+ </pre>
571
+ </div>
572
+ </div>
573
+ </div>
574
+
575
+ <h3 class="section-bar">Protected Instance methods</h3>
576
+
577
+ <div id="method-M000084" class="method-detail">
578
+ <a name="M000084"></a>
579
+
580
+ <div class="method-heading">
581
+ <a href="#M000084" class="method-signature">
582
+ <span class="method-name">escape</span><span class="method-args">(text)</span>
583
+ </a>
584
+ </div>
585
+
586
+ <div class="method-description">
587
+ <p>
588
+ Escape HTML special characters.
589
+ </p>
590
+ <p><a class="source-toggle" href="#"
591
+ onclick="toggleCode('M000084-source');return false;">[Source]</a></p>
592
+ <div class="method-source-code" id="M000084-source">
593
+ <pre>
594
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 136</span>
595
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">escape</span>(<span class="ruby-identifier">text</span>)
596
+ <span class="ruby-identifier">text</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">'&amp;'</span>, <span class="ruby-value str">'&amp;amp;'</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">'&lt;'</span>, <span class="ruby-value str">'&amp;lt;'</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-value str">'&gt;'</span>, <span class="ruby-value str">'&amp;gt;'</span>)
597
+ <span class="ruby-keyword kw">end</span>
598
+ </pre>
599
+ </div>
600
+ </div>
601
+ </div>
602
+
603
+ <div id="method-M000086" class="method-detail">
604
+ <a name="M000086"></a>
605
+
606
+ <div class="method-heading">
607
+ <a href="#M000086" class="method-signature">
608
+ <span class="method-name">hash_to_xml_attributes</span><span class="method-args">(hash)</span>
609
+ </a>
610
+ </div>
611
+
612
+ <div class="method-description">
613
+ <p><a class="source-toggle" href="#"
614
+ onclick="toggleCode('M000086-source');return false;">[Source]</a></p>
615
+ <div class="method-source-code" id="M000086-source">
616
+ <pre>
617
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 159</span>
618
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hash_to_xml_attributes</span>(<span class="ruby-identifier">hash</span>)
619
+ <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">collect</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span> <span class="ruby-node">&quot;#{key.to_s}=\&quot;#{value.gsub('&quot;','\&quot;')}\&quot;&quot;</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-value str">' '</span>)
620
+ <span class="ruby-keyword kw">end</span>
621
+ </pre>
622
+ </div>
623
+ </div>
624
+ </div>
625
+
626
+ <div id="method-M000085" class="method-detail">
627
+ <a name="M000085"></a>
628
+
629
+ <div class="method-heading">
630
+ <a href="#M000085" class="method-signature">
631
+ <span class="method-name">mount_table</span><span class="method-args">(array, options = {})</span>
632
+ </a>
633
+ </div>
634
+
635
+ <div class="method-description">
636
+ <p>
637
+ Gets a bidimensional array and create a table. The first array is used as
638
+ label.
639
+ </p>
640
+ <p><a class="source-toggle" href="#"
641
+ onclick="toggleCode('M000085-source');return false;">[Source]</a></p>
642
+ <div class="method-source-code" id="M000085-source">
643
+ <pre>
644
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 143</span>
645
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">mount_table</span>(<span class="ruby-identifier">array</span>, <span class="ruby-identifier">options</span> = {})
646
+ <span class="ruby-identifier">header</span> = <span class="ruby-identifier">array</span>.<span class="ruby-identifier">shift</span>
647
+ <span class="ruby-keyword kw">return</span> <span class="ruby-value str">''</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">array</span>.<span class="ruby-identifier">empty?</span>
648
+
649
+ <span class="ruby-identifier">header</span> = <span class="ruby-identifier">header</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">escape</span>(<span class="ruby-identifier">i</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">humanize</span>) }
650
+ <span class="ruby-identifier">rows</span> = <span class="ruby-identifier">array</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-node">&quot;&lt;tr&gt;&lt;td&gt;#{i.join('&lt;/td&gt;&lt;td&gt;')}&lt;/td&gt;&lt;/tr&gt;&quot;</span> }
651
+
652
+ <span class="ruby-value str">&quot;&lt;table \#{hash_to_xml_attributes(options)}&gt;\n&lt;thead&gt;&lt;tr&gt;&lt;th&gt;\#{header.join('&lt;/th&gt;&lt;th&gt;')}&lt;/th&gt;&lt;/tr&gt;&lt;/thead&gt;\n&lt;tbody&gt;\#{rows.join}&lt;/tbody&gt;\n&lt;/table&gt;\n&quot;</span>
653
+ <span class="ruby-keyword kw">end</span>
654
+ </pre>
655
+ </div>
656
+ </div>
657
+ </div>
658
+
659
+ <div id="method-M000083" class="method-detail">
660
+ <a name="M000083"></a>
661
+
662
+ <div class="method-heading">
663
+ <a href="#M000083" class="method-signature">
664
+ <span class="method-name">prefix?</span><span class="method-args">()</span>
665
+ </a>
666
+ </div>
667
+
668
+ <div class="method-description">
669
+ <p>
670
+ Return if <a href="../Filter.html#M000109">Footnotes::Filter.prefix</a>
671
+ exists or not. Some notes only work with prefix set.
672
+ </p>
673
+ <p><a class="source-toggle" href="#"
674
+ onclick="toggleCode('M000083-source');return false;">[Source]</a></p>
675
+ <div class="method-source-code" id="M000083-source">
676
+ <pre>
677
+ <span class="ruby-comment cmt"># File lib/rails-footnotes/notes/abstract_note.rb, line 130</span>
678
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prefix?</span>
679
+ <span class="ruby-operator">!</span><span class="ruby-constant">Footnotes</span><span class="ruby-operator">::</span><span class="ruby-constant">Filter</span>.<span class="ruby-identifier">prefix</span>.<span class="ruby-identifier">blank?</span>
680
+ <span class="ruby-keyword kw">end</span>
681
+ </pre>
682
+ </div>
683
+ </div>
684
+ </div>
685
+
686
+
687
+ </div>
688
+
689
+
690
+ </div>
691
+
692
+
693
+ <div id="validator-badges">
694
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
695
+ </div>
696
+
697
+ </body>
698
+ </html>