documentation/TimelineSetter/Timeline.html in timeline_setter-0.2.0 vs documentation/TimelineSetter/Timeline.html in timeline_setter-0.3.0
- old
+ new
@@ -1,21 +1,31 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>Class: TimelineSetter::Timeline</title>
-<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+<title>
+ Class: TimelineSetter::Timeline
+
+ — Documentation by YARD 0.7.2
+
+</title>
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+
<script type="text/javascript" charset="utf-8">
relpath = '..';
if (relpath != '') relpath += '/';
</script>
-<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
@@ -31,15 +41,18 @@
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
- <a id="class_list_link" href="#">Class List</a>
- <a id="method_list_link" href="#">Method List</a>
- <a id ="file_list_link" href="#">File List</a>
+
+ <a id="class_list_link" href="#">Class List</a>
+
+ <a id="method_list_link" href="#">Method List</a>
+
+ <a id="file_list_link" href="#">File List</a>
+
</div>
-
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
@@ -101,21 +114,20 @@
- <span class="summary_desc"><div class='inline'><p>
-Create timeline HTML by interpolating events hash into an ERB template.
-</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'>Create timeline HTML by interpolating events hash into an ERB template.</div></span>
</li>
</ul>
+
+
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
@@ -123,30 +135,48 @@
<ul class="summary">
<li class="public ">
<span class="summary_signature">
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (Timeline) <strong>initialize</strong>(events) </a>
+ <a href="#config_json-instance_method" title="#config_json (instance method)">- (Object) <strong>config_json</strong> </a>
</span>
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Timeline) <strong>initialize</strong>(opts = {}) </a>
+
+
+
+ </span>
+
<span class="note title constructor">constructor</span>
- <span class="summary_desc"><div class='inline'><p>
-Instantiate a new timeline from an events array created in
-Parser#initialize.
-</p>
-</div></span>
+ <span class="summary_desc"><div class='inline'>Instantiate a new timeline from an events
+array created in Parser#initialize.</div></span>
</li>
<li class="public ">
@@ -184,15 +214,12 @@
- <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>
+ <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>
</li>
<li class="public ">
@@ -230,15 +257,12 @@
- <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>
+ <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>
</li>
</ul>
@@ -248,22 +272,19 @@
<h2>Constructor Details</h2>
<div class="method_details first">
<p class="signature first" id="initialize-instance_method">
- - (<tt><span class='object_link'><a href="" title="TimelineSetter::Timeline (class)">Timeline</a></span></tt>) <strong>initialize</strong>(events)
+ - (<tt><span class='object_link'><a href="" title="TimelineSetter::Timeline (class)">Timeline</a></span></tt>) <strong>initialize</strong>(opts = {})
</p><div class="docstring">
<div class="discussion">
- <p>
-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
-
</div>
</div>
<div class="tags">
</div><table class="source_code">
@@ -272,17 +293,19 @@
<pre class="lines">
6
7
-8</pre>
+8
+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='events identifier id'>events</span><span class='rparen token'>)</span>
- <span class='@events ivar id'>@events</span> <span class='assign token'>=</span> <span class='events identifier id'>events</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>
</pre>
</td>
</tr>
</table>
@@ -303,33 +326,30 @@
</p><div class="docstring">
<div class="discussion">
- <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>
+ 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.
-
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-24
-25
-26</pre>
+32
+33
+34</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 24</span>
+ <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>
</pre>
@@ -344,29 +364,64 @@
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
- <p class="signature first" id="timeline_markup-instance_method">
+ <p class="signature first" id="config_json-instance_method">
- - (<tt>Object</tt>) <strong>timeline_markup</strong>
+ - (<tt>Object</tt>) <strong>config_json</strong>
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
-17
18
-19</pre>
+19
+20
+21
+22
+23</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 17</span>
+ <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='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>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="timeline_markup-instance_method">
+
+ - (<tt>Object</tt>) <strong>timeline_markup</strong>
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+25
+26
+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>
</pre>
</td>
@@ -381,46 +436,43 @@
</p><div class="docstring">
<div class="discussion">
- <p>
-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.
-
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-30
-31
-32
-33
-34
-35
-36
-37
-38</pre>
+38
+39
+40
+41
+42
+43
+44
+45
+46</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 30</span>
+ <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='Closure constant id'>Closure</span><span class='colon2 op'>::</span><span class='Compiler constant id'>Compiler</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='dot token'>.</span><span class='compile identifier id'>compile</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/javascripts/timeline-setter.js"</span><span class='comma token'>,</span> <span class='string val'>'r'</span><span class='rparen token'>)</span><span class='rparen token'>)</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>
</pre>
</td>
</tr>
@@ -438,16 +490,16 @@
<tr>
<td>
<pre class="lines">
-40
-41
-42</pre>
+48
+49
+50</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 40</span>
+ <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>
</pre>
@@ -463,33 +515,30 @@
</p><div class="docstring">
<div class="discussion">
- <p>
-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.
-
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-12
13
14
-15</pre>
+15
+16</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 12</span>
+ <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>
@@ -502,12 +551,12 @@
</div>
</div>
<div id="footer">
- Generated on Thu Apr 21 10:33:42 2011 by
+ Generated on Wed Nov 2 15:20:07 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.6.5 (ruby-1.8.7).
+ 0.7.2 (ruby-1.8.7).
</div>
</body>
</html>
\ No newline at end of file