Adding some documentation.
[lyrix.git] / doc / app / classes / SongsHelper.html
blob2aac19b38dca11874037776c7e257150824efa14
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">
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8 <title>Module: SongsHelper</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[
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
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;
27 elemStyle = elem.style;
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
31 } else {
32 elemStyle.display = "none"
35 return true;
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
41 // ]]>
42 </script>
44 </head>
45 <body>
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">SongsHelper</td>
54 </tr>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
57 <td>
58 <a href="../files/app/helpers/songs_helper_rb.html">
59 app/helpers/songs_helper.rb
60 </a>
61 <br />
62 </td>
63 </tr>
65 </table>
66 </div>
67 <!-- banner header -->
69 <div id="bodyContent">
73 <div id="contextContent">
77 </div>
79 <div id="method-list">
80 <h3 class="section-bar">Methods</h3>
82 <div class="name-list">
83 <a href="#M000039">slides_for_song</a>&nbsp;&nbsp;
84 </div>
85 </div>
87 </div>
90 <!-- if includes -->
92 <div id="section">
101 <!-- if method_list -->
102 <div id="methods">
103 <h3 class="section-bar">Public Instance methods</h3>
105 <div id="method-M000039" class="method-detail">
106 <a name="M000039"></a>
108 <div class="method-heading">
109 <a href="#M000039" class="method-signature">
110 <span class="method-name">slides_for_song</span><span class="method-args">(song)</span>
111 </a>
112 </div>
114 <div class="method-description">
115 <p><a class="source-toggle" href="#"
116 onclick="toggleCode('M000039-source');return false;">[Source]</a></p>
117 <div class="method-source-code" id="M000039-source">
118 <pre>
119 <span class="ruby-comment cmt"># File app/helpers/songs_helper.rb, line 2</span>
120 2: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">slides_for_song</span>(<span class="ruby-identifier">song</span>)
121 3: <span class="ruby-constant">RedCloth</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">song</span>.<span class="ruby-identifier">slides</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;&lt;hr /&gt;&quot;</span>), [<span class="ruby-identifier">:hard_breaks</span>]).<span class="ruby-identifier">to_html</span>
122 4: <span class="ruby-keyword kw">end</span>
123 </pre>
124 </div>
125 </div>
126 </div>
129 </div>
132 </div>
135 <div id="validator-badges">
136 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
137 </div>
139 </body>
140 </html>