← Back to branch summary

~ubuntu-branches/ubuntu/saucy/ruby-erubis/saucy

« back to all changes in this revision

Viewing changes to doc-api/classes/Erubis/Helpers/RailsHelper.html

  • Committer: Package Import Robot
  • Author(s): Laurent Bigonville
  • Date: 2012-01-26 15:15:58 UTC
  • Revision ID: package-import@ubuntu.com-20120126151558-9u7mnf9ooqnw3bwz
Tags: upstream-2.7.0
Import upstream version 2.7.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc-api/classes/Erubis/Helpers/RailsHelper.html
 
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: Erubis::Helpers::RailsHelper</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">Erubis::Helpers::RailsHelper</td>
 
54
        </tr>
 
55
        <tr class="top-aligned-row">
 
56
            <td><strong>In:</strong></td>
 
57
            <td>
 
58
                <a href="../../../files/erubis/helpers/rails_helper_rb.html">
 
59
                erubis/helpers/rails_helper.rb
 
60
                </a>
 
61
        <br />
 
62
            </td>
 
63
        </tr>
 
64
 
 
65
        </table>
 
66
    </div>
 
67
  <!-- banner header -->
 
68
 
 
69
  <div id="bodyContent">
 
70
 
 
71
 
 
72
 
 
73
  <div id="contextContent">
 
74
 
 
75
    <div id="description">
 
76
      <p>
 
77
helper module for Ruby on Rails
 
78
</p>
 
79
<p>
 
80
howto:
 
81
</p>
 
82
<ol>
 
83
<li>add the folliwng code in your &#8216;config/environment.rb&#8216;
 
84
 
 
85
<pre>
 
86
  require 'erubis/helpers/rails_helper'
 
87
  #Erubis::Helpers::RailsHelper.engine_class = Erubis::Eruby # or Erubis::FastEruby
 
88
  #Erubis::Helpers::RailsHelper.init_properties = {}
 
89
  #Erubis::Helpers::RailsHelper.show_src = false       # set true for debugging
 
90
  #Erubis::Helpers::RailsHelper.preprocessing = true   # set true to enable preprocessing
 
91
</pre>
 
92
</li>
 
93
<li>restart web server.
 
94
 
 
95
</li>
 
96
</ol>
 
97
<p>
 
98
if Erubis::Helper::Rails.show_src is true, <a
 
99
href="../../Erubis.html">Erubis</a> prints converted Ruby code into log
 
100
file (&#8216;log/development.log&#8217; or so). if false, it doesn&#8216;t.
 
101
if nil, <a href="../../Erubis.html">Erubis</a> prints converted Ruby code
 
102
if ENV[&#8216;RAILS_ENV&#8217;] == &#8216;development&#8217;.
 
103
</p>
 
104
 
 
105
    </div>
 
106
 
 
107
 
 
108
   </div>
 
109
 
 
110
    <div id="method-list">
 
111
      <h3 class="section-bar">Methods</h3>
 
112
 
 
113
      <div class="name-list">
 
114
      <a href="#M000069">engine_class</a>&nbsp;&nbsp;
 
115
      <a href="#M000070">engine_class=</a>&nbsp;&nbsp;
 
116
      <a href="#M000071">init_properties</a>&nbsp;&nbsp;
 
117
      <a href="#M000072">init_properties=</a>&nbsp;&nbsp;
 
118
      <a href="#M000075">preprocessing</a>&nbsp;&nbsp;
 
119
      <a href="#M000076">preprocessing=</a>&nbsp;&nbsp;
 
120
      <a href="#M000073">show_src</a>&nbsp;&nbsp;
 
121
      <a href="#M000074">show_src=</a>&nbsp;&nbsp;
 
122
      </div>
 
123
    </div>
 
124
 
 
125
  </div>
 
126
 
 
127
 
 
128
    <!-- if includes -->
 
129
 
 
130
    <div id="section">
 
131
 
 
132
    <div id="class-list">
 
133
      <h3 class="section-bar">Classes and Modules</h3>
 
134
 
 
135
      Module <a href="RailsHelper/TemplateConverter.html" class="link">Erubis::Helpers::RailsHelper::TemplateConverter</a><br />
 
136
 
 
137
    </div>
 
138
 
 
139
 
 
140
 
 
141
 
 
142
      
 
143
 
 
144
 
 
145
    <!-- if method_list -->
 
146
    <div id="methods">
 
147
      <h3 class="section-bar">Public Class methods</h3>
 
148
 
 
149
      <div id="method-M000069" class="method-detail">
 
150
        <a name="M000069"></a>
 
151
 
 
152
        <div class="method-heading">
 
153
          <a href="#M000069" class="method-signature">
 
154
          <span class="method-name">engine_class</span><span class="method-args">()</span>
 
155
          </a>
 
156
        </div>
 
157
      
 
158
        <div class="method-description">
 
159
          <p>
 
160
@@<a href="RailsHelper.html#M000069">engine_class</a> = ::<a
 
161
href="../FastEruby.html">Erubis::FastEruby</a>
 
162
</p>
 
163
          <p><a class="source-toggle" href="#"
 
164
            onclick="toggleCode('M000069-source');return false;">[Source]</a></p>
 
165
          <div class="method-source-code" id="M000069-source">
 
166
<pre>
 
167
<span class="ruby-comment cmt"># File erubis/helpers/rails_helper.rb, line 47</span>
 
168
      <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">engine_class</span>
 
169
        <span class="ruby-ivar">@@engine_class</span>
 
170
      <span class="ruby-keyword kw">end</span>
 
171
</pre>
 
172
          </div>
 
173
        </div>
 
174
      </div>
 
175
 
 
176
      <div id="method-M000070" class="method-detail">
 
177
        <a name="M000070"></a>
 
178
 
 
179
        <div class="method-heading">
 
180
          <a href="#M000070" class="method-signature">
 
181
          <span class="method-name">engine_class=</span><span class="method-args">(klass)</span>
 
182
          </a>
 
183
        </div>
 
184
      
 
185
        <div class="method-description">
 
186
          <p><a class="source-toggle" href="#"
 
187
            onclick="toggleCode('M000070-source');return false;">[Source]</a></p>
 
188
          <div class="method-source-code" id="M000070-source">
 
189
<pre>
 
190
<span class="ruby-comment cmt"># File erubis/helpers/rails_helper.rb, line 50</span>
 
191
      <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">engine_class=</span>(<span class="ruby-identifier">klass</span>)
 
192
        <span class="ruby-ivar">@@engine_class</span> = <span class="ruby-identifier">klass</span>
 
193
      <span class="ruby-keyword kw">end</span>
 
194
</pre>
 
195
          </div>
 
196
        </div>
 
197
      </div>
 
198
 
 
199
      <div id="method-M000071" class="method-detail">
 
200
        <a name="M000071"></a>
 
201
 
 
202
        <div class="method-heading">
 
203
          <a href="#M000071" class="method-signature">
 
204
          <span class="method-name">init_properties</span><span class="method-args">()</span>
 
205
          </a>
 
206
        </div>
 
207
      
 
208
        <div class="method-description">
 
209
          <p><a class="source-toggle" href="#"
 
210
            onclick="toggleCode('M000071-source');return false;">[Source]</a></p>
 
211
          <div class="method-source-code" id="M000071-source">
 
212
<pre>
 
213
<span class="ruby-comment cmt"># File erubis/helpers/rails_helper.rb, line 56</span>
 
214
      <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">init_properties</span>
 
215
        <span class="ruby-ivar">@@init_properties</span>
 
216
      <span class="ruby-keyword kw">end</span>
 
217
</pre>
 
218
          </div>
 
219
        </div>
 
220
      </div>
 
221
 
 
222
      <div id="method-M000072" class="method-detail">
 
223
        <a name="M000072"></a>
 
224
 
 
225
        <div class="method-heading">
 
226
          <a href="#M000072" class="method-signature">
 
227
          <span class="method-name">init_properties=</span><span class="method-args">(hash)</span>
 
228
          </a>
 
229
        </div>
 
230
      
 
231
        <div class="method-description">
 
232
          <p><a class="source-toggle" href="#"
 
233
            onclick="toggleCode('M000072-source');return false;">[Source]</a></p>
 
234
          <div class="method-source-code" id="M000072-source">
 
235
<pre>
 
236
<span class="ruby-comment cmt"># File erubis/helpers/rails_helper.rb, line 59</span>
 
237
      <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">init_properties=</span>(<span class="ruby-identifier">hash</span>)
 
238
        <span class="ruby-ivar">@@init_properties</span> = <span class="ruby-identifier">hash</span>
 
239
      <span class="ruby-keyword kw">end</span>
 
240
</pre>
 
241
          </div>
 
242
        </div>
 
243
      </div>
 
244
 
 
245
      <div id="method-M000075" class="method-detail">
 
246
        <a name="M000075"></a>
 
247
 
 
248
        <div class="method-heading">
 
249
          <a href="#M000075" class="method-signature">
 
250
          <span class="method-name">preprocessing</span><span class="method-args">()</span>
 
251
          </a>
 
252
        </div>
 
253
      
 
254
        <div class="method-description">
 
255
          <p><a class="source-toggle" href="#"
 
256
            onclick="toggleCode('M000075-source');return false;">[Source]</a></p>
 
257
          <div class="method-source-code" id="M000075-source">
 
258
<pre>
 
259
<span class="ruby-comment cmt"># File erubis/helpers/rails_helper.rb, line 74</span>
 
260
      <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">preprocessing</span>
 
261
        <span class="ruby-ivar">@@preprocessing</span>
 
262
      <span class="ruby-keyword kw">end</span>
 
263
</pre>
 
264
          </div>
 
265
        </div>
 
266
      </div>
 
267
 
 
268
      <div id="method-M000076" class="method-detail">
 
269
        <a name="M000076"></a>
 
270
 
 
271
        <div class="method-heading">
 
272
          <a href="#M000076" class="method-signature">
 
273
          <span class="method-name">preprocessing=</span><span class="method-args">(flag)</span>
 
274
          </a>
 
275
        </div>
 
276
      
 
277
        <div class="method-description">
 
278
          <p><a class="source-toggle" href="#"
 
279
            onclick="toggleCode('M000076-source');return false;">[Source]</a></p>
 
280
          <div class="method-source-code" id="M000076-source">
 
281
<pre>
 
282
<span class="ruby-comment cmt"># File erubis/helpers/rails_helper.rb, line 77</span>
 
283
      <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">preprocessing=</span>(<span class="ruby-identifier">flag</span>)
 
284
        <span class="ruby-ivar">@@preprocessing</span> = <span class="ruby-identifier">flag</span>
 
285
      <span class="ruby-keyword kw">end</span>
 
286
</pre>
 
287
          </div>
 
288
        </div>
 
289
      </div>
 
290
 
 
291
      <div id="method-M000073" class="method-detail">
 
292
        <a name="M000073"></a>
 
293
 
 
294
        <div class="method-heading">
 
295
          <a href="#M000073" class="method-signature">
 
296
          <span class="method-name">show_src</span><span class="method-args">()</span>
 
297
          </a>
 
298
        </div>
 
299
      
 
300
        <div class="method-description">
 
301
          <p><a class="source-toggle" href="#"
 
302
            onclick="toggleCode('M000073-source');return false;">[Source]</a></p>
 
303
          <div class="method-source-code" id="M000073-source">
 
304
<pre>
 
305
<span class="ruby-comment cmt"># File erubis/helpers/rails_helper.rb, line 65</span>
 
306
      <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">show_src</span>
 
307
        <span class="ruby-ivar">@@show_src</span>
 
308
      <span class="ruby-keyword kw">end</span>
 
309
</pre>
 
310
          </div>
 
311
        </div>
 
312
      </div>
 
313
 
 
314
      <div id="method-M000074" class="method-detail">
 
315
        <a name="M000074"></a>
 
316
 
 
317
        <div class="method-heading">
 
318
          <a href="#M000074" class="method-signature">
 
319
          <span class="method-name">show_src=</span><span class="method-args">(flag)</span>
 
320
          </a>
 
321
        </div>
 
322
      
 
323
        <div class="method-description">
 
324
          <p><a class="source-toggle" href="#"
 
325
            onclick="toggleCode('M000074-source');return false;">[Source]</a></p>
 
326
          <div class="method-source-code" id="M000074-source">
 
327
<pre>
 
328
<span class="ruby-comment cmt"># File erubis/helpers/rails_helper.rb, line 68</span>
 
329
      <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">show_src=</span>(<span class="ruby-identifier">flag</span>)
 
330
        <span class="ruby-ivar">@@show_src</span> = <span class="ruby-identifier">flag</span>
 
331
      <span class="ruby-keyword kw">end</span>
 
332
</pre>
 
333
          </div>
 
334
        </div>
 
335
      </div>
 
336
 
 
337
 
 
338
    </div>
 
339
 
 
340
 
 
341
  </div>
 
342
 
 
343
 
 
344
<div id="validator-badges">
 
345
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 
346
</div>
 
347
 
 
348
</body>
 
349
</html>
 
 
b'\\ No newline at end of file'