documentation/TimelineSetter/Timeline.html in timeline_setter-0.3.0 vs documentation/TimelineSetter/Timeline.html in timeline_setter-0.3.1
- old
+ new
@@ -4,11 +4,11 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: TimelineSetter::Timeline
- — Documentation by YARD 0.7.2
+ — Documentation by YARD 0.7.5
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
@@ -92,10 +92,12 @@
</dl>
<div class="clear"></div>
+
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
@@ -114,11 +116,13 @@
- <span class="summary_desc"><div class='inline'>Create timeline HTML by interpolating events hash into an ERB template.</div></span>
+ <span class="summary_desc"><div class='inline'>
+<p>Create timeline HTML by interpolating events hash into an ERB template.</p>
+</div></span>
</li>
</ul>
@@ -171,12 +175,14 @@
- <span class="summary_desc"><div class='inline'>Instantiate a new timeline from an events
-array created in Parser#initialize.</div></span>
+ <span class="summary_desc"><div class='inline'>
+<p>Instantiate a new timeline from an events array created in
+Parser#initialize.</p>
+</div></span>
</li>
<li class="public ">
@@ -214,12 +220,14 @@
- <span class="summary_desc"><div class='inline'>Create a minified one-page version of a timeline by minifying CSS and JS and embedding all assets
-into our ERB template.</div></span>
+ <span class="summary_desc"><div class='inline'>
+<p>Create a minified one-page version of a timeline by minifying CSS and JS
+and embedding all assets into our ERB template.</p>
+</div></span>
</li>
<li class="public ">
@@ -257,12 +265,14 @@
- <span class="summary_desc"><div class='inline'>Convert human dates to timestamps, sort the hash by timestamp, and
-convert the events hash to JSON to stick into our HTML.</div></span>
+ <span class="summary_desc"><div class='inline'>
+<p>Convert human dates to timestamps, sort the hash by timestamp, and convert
+the events hash to JSON to stick into our HTML.</p>
+</div></span>
</li>
</ul>
@@ -278,17 +288,20 @@
</p><div class="docstring">
<div class="discussion">
- Instantiate a new timeline from an events
-array created in Parser#initialize
+
+<p>Instantiate a new timeline from an events array created in
+Parser#initialize</p>
+
</div>
</div>
<div class="tags">
+
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
@@ -299,14 +312,14 @@
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 6</span>
-<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='opts identifier id'>opts</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
- <span class='@events ivar id'>@events</span> <span class='assign token'>=</span> <span class='opts identifier id'>opts</span><span class='lbrack token'>[</span><span class='symbol val'>:events</span><span class='rbrack token'>]</span>
- <span class='@interval ivar id'>@interval</span> <span class='assign token'>=</span> <span class='opts identifier id'>opts</span><span class='lbrack token'>[</span><span class='symbol val'>:interval</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>''</span>
-<span class='end end kw'>end</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_opts identifier id'>opts</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
+ <span class='rubyid_@events ivar id'>@events</span> <span class='assign token'>=</span> <span class='rubyid_opts identifier id'>opts</span><span class='lbrack token'>[</span><span class='symbol val'>:events</span><span class='rbrack token'>]</span>
+ <span class='rubyid_@interval ivar id'>@interval</span> <span class='assign token'>=</span> <span class='rubyid_opts identifier id'>opts</span><span class='lbrack token'>[</span><span class='symbol val'>:interval</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>''</span>
+<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
@@ -326,18 +339,21 @@
</p><div class="docstring">
<div class="discussion">
- Create timeline HTML by interpolating events hash into an ERB template.
-Re-template timeline by editing ../templates/timeline.erb
-This version preserves external links to CSS and JS.
+
+<p>Create timeline HTML by interpolating events hash into an ERB template.
+Re-template timeline by editing ../templates/timeline.erb This version
+preserves external links to CSS and JS.</p>
+
</div>
</div>
<div class="tags">
+
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
@@ -347,13 +363,13 @@
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 32</span>
-<span class='def def kw'>def</span> <span class='timeline identifier id'>timeline</span>
- <span class='@timeline ivar id'>@timeline</span> <span class='assign token'>=</span> <span class='tmpl identifier id'>tmpl</span><span class='lparen token'>(</span><span class='string val'>"timeline.erb"</span><span class='rparen token'>)</span>
-<span class='end end kw'>end</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_timeline identifier id'>timeline</span>
+ <span class='rubyid_@timeline ivar id'>@timeline</span> <span class='assign token'>=</span> <span class='rubyid_tmpl identifier id'>tmpl</span><span class='lparen token'>(</span><span class='string val'>"timeline.erb"</span><span class='rparen token'>)</span>
+<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
@@ -386,16 +402,16 @@
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 18</span>
-<span class='def def kw'>def</span> <span class='config_json identifier id'>config_json</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_config_json identifier id'>config_json</span>
<span class='lbrace token'>{</span>
<span class='string val'>"interval"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"#{@interval}"</span><span class='comma token'>,</span>
<span class='string val'>"container"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"#timeline"</span>
- <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='to_json identifier id'>to_json</span>
-<span class='end end kw'>end</span>
+ <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='rubyid_to_json identifier id'>to_json</span>
+<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
@@ -418,13 +434,13 @@
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 25</span>
-<span class='def def kw'>def</span> <span class='timeline_markup identifier id'>timeline_markup</span>
- <span class='tmpl identifier id'>tmpl</span><span class='lparen token'>(</span><span class='string val'>"timeline-markup.erb"</span><span class='rparen token'>)</span>
-<span class='end end kw'>end</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_timeline_markup identifier id'>timeline_markup</span>
+ <span class='rubyid_tmpl identifier id'>tmpl</span><span class='lparen token'>(</span><span class='string val'>"timeline-markup.erb"</span><span class='rparen token'>)</span>
+<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
@@ -436,17 +452,20 @@
</p><div class="docstring">
<div class="discussion">
- Create a minified one-page version of a timeline by minifying CSS and JS and embedding all assets
-into our ERB template.
+
+<p>Create a minified one-page version of a timeline by minifying CSS and JS
+and embedding all assets into our ERB template.</p>
+
</div>
</div>
<div class="tags">
+
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
@@ -462,19 +481,19 @@
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 38</span>
-<span class='def def kw'>def</span> <span class='timeline_min identifier id'>timeline_min</span>
- <span class='@js ivar id'>@js</span> <span class='assign token'>=</span> <span class='string val'>""</span>
- <span class='@css ivar id'>@css</span> <span class='assign token'>=</span> <span class='Kompress constant id'>Kompress</span><span class='colon2 op'>::</span><span class='CSS constant id'>CSS</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='dstring node'>"#{TimelineSetter::ROOT}/public/stylesheets/timeline-setter.css"</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='read identifier id'>read</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='css identifier id'>css</span>
- <span class='libs identifier id'>libs</span> <span class='assign token'>=</span> <span class='Dir constant id'>Dir</span><span class='dot token'>.</span><span class='glob identifier id'>glob</span><span class='lparen token'>(</span><span class='dstring node'>"#{TimelineSetter::ROOT}/public/javascripts/vendor/**"</span><span class='rparen token'>)</span>
- <span class='libs identifier id'>libs</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='lib identifier id'>lib</span><span class='bitor op'>|</span> <span class='@js ivar id'>@js</span> <span class='lshft op'><<</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='lib identifier id'>lib</span><span class='comma token'>,</span><span class='string val'>'r'</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='read identifier id'>read</span> <span class='rbrace token'>}</span>
- <span class='@min_html ivar id'>@min_html</span> <span class='assign token'>=</span> <span class='Kompress constant id'>Kompress</span><span class='colon2 op'>::</span><span class='HTML constant id'>HTML</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='timeline_markup identifier id'>timeline_markup</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='html identifier id'>html</span>
- <span class='@js ivar id'>@js</span> <span class='lshft op'><<</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='dstring node'>"#{TimelineSetter::ROOT}/public/javascripts/timeline-setter.min.js"</span><span class='comma token'>,</span> <span class='string val'>'r'</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='read identifier id'>read</span>
- <span class='@timeline ivar id'>@timeline</span> <span class='assign token'>=</span> <span class='tmpl identifier id'>tmpl</span><span class='lparen token'>(</span><span class='string val'>"timeline-min.erb"</span><span class='rparen token'>)</span>
-<span class='end end kw'>end</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_timeline_min identifier id'>timeline_min</span>
+ <span class='rubyid_@js ivar id'>@js</span> <span class='assign token'>=</span> <span class='string val'>""</span>
+ <span class='rubyid_@css ivar id'>@css</span> <span class='assign token'>=</span> <span class='rubyid_Kompress constant id'>Kompress</span><span class='colon2 op'>::</span><span class='rubyid_CSS constant id'>CSS</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_File constant id'>File</span><span class='dot token'>.</span><span class='rubyid_open identifier id'>open</span><span class='lparen token'>(</span><span class='dstring node'>"#{TimelineSetter::ROOT}/public/stylesheets/timeline-setter.css"</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_read identifier id'>read</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_css identifier id'>css</span>
+ <span class='rubyid_libs identifier id'>libs</span> <span class='assign token'>=</span> <span class='rubyid_Dir constant id'>Dir</span><span class='dot token'>.</span><span class='rubyid_glob identifier id'>glob</span><span class='lparen token'>(</span><span class='dstring node'>"#{TimelineSetter::ROOT}/public/javascripts/vendor/**"</span><span class='rparen token'>)</span>
+ <span class='rubyid_libs identifier id'>libs</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_lib identifier id'>lib</span><span class='bitor op'>|</span> <span class='rubyid_@js ivar id'>@js</span> <span class='lshft op'><<</span> <span class='rubyid_File constant id'>File</span><span class='dot token'>.</span><span class='rubyid_open identifier id'>open</span><span class='lparen token'>(</span><span class='rubyid_lib identifier id'>lib</span><span class='comma token'>,</span><span class='string val'>'r'</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_read identifier id'>read</span> <span class='rbrace token'>}</span>
+ <span class='rubyid_@min_html ivar id'>@min_html</span> <span class='assign token'>=</span> <span class='rubyid_Kompress constant id'>Kompress</span><span class='colon2 op'>::</span><span class='rubyid_HTML constant id'>HTML</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_timeline_markup identifier id'>timeline_markup</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_html identifier id'>html</span>
+ <span class='rubyid_@js ivar id'>@js</span> <span class='lshft op'><<</span> <span class='rubyid_File constant id'>File</span><span class='dot token'>.</span><span class='rubyid_open identifier id'>open</span><span class='lparen token'>(</span><span class='dstring node'>"#{TimelineSetter::ROOT}/public/javascripts/timeline-setter.min.js"</span><span class='comma token'>,</span> <span class='string val'>'r'</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_read identifier id'>read</span>
+ <span class='rubyid_@timeline ivar id'>@timeline</span> <span class='assign token'>=</span> <span class='rubyid_tmpl identifier id'>tmpl</span><span class='lparen token'>(</span><span class='string val'>"timeline-min.erb"</span><span class='rparen token'>)</span>
+<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
@@ -497,13 +516,13 @@
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 48</span>
-<span class='def def kw'>def</span> <span class='tmpl identifier id'>tmpl</span><span class='lparen token'>(</span><span class='tmpl_file identifier id'>tmpl_file</span><span class='rparen token'>)</span>
- <span class='ERB constant id'>ERB</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='dstring node'>"#{TimelineSetter::ROOT}/templates/#{tmpl_file}"</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='read identifier id'>read</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='result identifier id'>result</span><span class='lparen token'>(</span><span class='binding identifier id'>binding</span><span class='rparen token'>)</span>
-<span class='end end kw'>end</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_tmpl identifier id'>tmpl</span><span class='lparen token'>(</span><span class='rubyid_tmpl_file identifier id'>tmpl_file</span><span class='rparen token'>)</span>
+ <span class='rubyid_ERB constant id'>ERB</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_File constant id'>File</span><span class='dot token'>.</span><span class='rubyid_open identifier id'>open</span><span class='lparen token'>(</span><span class='dstring node'>"#{TimelineSetter::ROOT}/templates/#{tmpl_file}"</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_read identifier id'>read</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_result identifier id'>result</span><span class='lparen token'>(</span><span class='rubyid_binding identifier id'>binding</span><span class='rparen token'>)</span>
+<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
@@ -515,17 +534,20 @@
</p><div class="docstring">
<div class="discussion">
- Convert human dates to timestamps, sort the hash by timestamp, and
-convert the events hash to JSON to stick into our HTML.
+
+<p>Convert human dates to timestamps, sort the hash by timestamp, and convert
+the events hash to JSON to stick into our HTML.</p>
+
</div>
</div>
<div class="tags">
+
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
@@ -536,14 +558,14 @@
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 13</span>
-<span class='def def kw'>def</span> <span class='to_json identifier id'>to_json</span>
- <span class='@events ivar id'>@events</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='r identifier id'>r</span><span class='bitor op'>|</span> <span class='r identifier id'>r</span><span class='lbrack token'>[</span><span class='symbol val'>:timestamp</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='parse identifier id'>parse</span><span class='lparen token'>(</span><span class='r identifier id'>r</span><span class='lbrack token'>[</span><span class='symbol val'>:date</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_i identifier id'>to_i</span> <span class='mult op'>*</span> <span class='integer val'>1000</span> <span class='rbrace token'>}</span>
- <span class='@events ivar id'>@events</span><span class='dot token'>.</span><span class='to_json identifier id'>to_json</span>
-<span class='end end kw'>end</span>
+<span class='rubyid_def def kw'>def</span> <span class='rubyid_to_json identifier id'>to_json</span>
+ <span class='rubyid_@events ivar id'>@events</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='rubyid_r identifier id'>r</span><span class='bitor op'>|</span> <span class='rubyid_r identifier id'>r</span><span class='lbrack token'>[</span><span class='symbol val'>:timestamp</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_Time constant id'>Time</span><span class='dot token'>.</span><span class='rubyid_parse identifier id'>parse</span><span class='lparen token'>(</span><span class='rubyid_r identifier id'>r</span><span class='lbrack token'>[</span><span class='symbol val'>:date</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span> <span class='mult op'>*</span> <span class='integer val'>1000</span> <span class='rbrace token'>}</span>
+ <span class='rubyid_@events ivar id'>@events</span><span class='dot token'>.</span><span class='rubyid_to_json identifier id'>to_json</span>
+<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
@@ -551,12 +573,12 @@
</div>
</div>
<div id="footer">
- Generated on Wed Nov 2 15:20:07 2011 by
+ Generated on Mon Mar 12 11:02:59 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.7.2 (ruby-1.8.7).
+ 0.7.5 (ruby-1.8.7).
</div>
</body>
</html>
\ No newline at end of file