documentation/TimelineSetter/Timeline.html in timeline_setter-0.3.1 vs documentation/TimelineSetter/Timeline.html in timeline_setter-0.3.2
- old
+ new
@@ -4,60 +4,67 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: TimelineSetter::Timeline
- — Documentation by YARD 0.7.5
+ — Documentation by YARD 0.8.4.1
</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 += '/';
+ hasFrames = window.top.frames.main ? true : false;
+ relpath = '../';
+ framesUrl = "../frames.html#!" + escape(window.location.href);
</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>
-
<div id="header">
<div id="menu">
- <a href="../_index.html">Index (T)</a> »
+ <a href="../_index.html">Index (T)</a> »
<span class='title'><span class='object_link'><a href="../TimelineSetter.html" title="TimelineSetter (module)">TimelineSetter</a></span></span>
»
<span class="title">Timeline</span>
-
+
<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 class="full_list_link" id="class_list_link"
+ href="../class_list.html">
+ Class List
+ </a>
- <a id="method_list_link" href="#">Method List</a>
+ <a class="full_list_link" id="method_list_link"
+ href="../method_list.html">
+ Method List
+ </a>
- <a id="file_list_link" href="#">File List</a>
+ <a class="full_list_link" id="file_list_link"
+ href="../file_list.html">
+ File List
+ </a>
</div>
<div class="clear"></div>
</div>
-
+
<iframe id="search_frame"></iframe>
-
+
<div id="content"><h1>Class: TimelineSetter::Timeline
</h1>
@@ -107,12 +114,15 @@
</span>
- <span class="note title readonly">readonly</span>
+
+ <span class="note title readonly">readonly</span>
+
+
@@ -150,10 +160,11 @@
+
<span class="summary_desc"><div class='inline'></div></span>
</li>
@@ -166,10 +177,11 @@
</span>
+
<span class="note title constructor">constructor</span>
@@ -197,10 +209,11 @@
+
<span class="summary_desc"><div class='inline'></div></span>
</li>
@@ -218,10 +231,11 @@
+
<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>
@@ -242,10 +256,11 @@
+
<span class="summary_desc"><div class='inline'></div></span>
</li>
@@ -263,10 +278,11 @@
+
<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>
@@ -280,17 +296,19 @@
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
- <p class="signature first" id="initialize-instance_method">
+ <h3 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>(opts = {})
-</p><div class="docstring">
+
+
+</h3><div class="docstring">
<div class="discussion">
<p>Instantiate a new timeline from an events array created in
Parser#initialize</p>
@@ -329,19 +347,20 @@
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
- <span id="timeline-instance_method"></span>
<div class="method_details first">
- <p class="signature first" id="timeline-instance_method">
+ <h3 class="signature first" id="timeline-instance_method">
- (<tt>Object</tt>) <strong>timeline</strong> <span class="extras">(readonly)</span>
-</p><div class="docstring">
+
+
+</h3><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>
@@ -364,11 +383,11 @@
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 32</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_@timeline ivar id'>@timeline</span>
<span class='rubyid_end end kw'>end</span>
</pre>
</td>
</tr>
</table>
@@ -377,20 +396,22 @@
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
+
-
<div class="method_details first">
- <p class="signature first" id="config_json-instance_method">
+ <h3 class="signature first" id="config_json-instance_method">
- (<tt>Object</tt>) <strong>config_json</strong>
-</p><table class="source_code">
+
+
+</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
@@ -415,17 +436,19 @@
</tr>
</table>
</div>
<div class="method_details ">
- <p class="signature " id="timeline_markup-instance_method">
+ <h3 class="signature " id="timeline_markup-instance_method">
- (<tt>Object</tt>) <strong>timeline_markup</strong>
-</p><table class="source_code">
+
+
+</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
@@ -444,17 +467,19 @@
</tr>
</table>
</div>
<div class="method_details ">
- <p class="signature " id="timeline_min-instance_method">
+ <h3 class="signature " id="timeline_min-instance_method">
- (<tt>Object</tt>) <strong>timeline_min</strong>
-</p><div class="docstring">
+
+
+</h3><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>
@@ -484,11 +509,11 @@
<pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 38</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='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='dot token'>.</span><span class='rubyid_select identifier id'>select</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='rubyid_q identifier id'>q</span><span class='bitor op'>|</span> <span class='rubyid_q identifier id'>q</span> <span class='match op'>=~</span> <span class='regexp val'>/min/</span> <span class='rbrace 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>
@@ -497,17 +522,19 @@
</tr>
</table>
</div>
<div class="method_details ">
- <p class="signature " id="tmpl-instance_method">
+ <h3 class="signature " id="tmpl-instance_method">
- (<tt>Object</tt>) <strong>tmpl</strong>(tmpl_file)
-</p><table class="source_code">
+
+
+</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
@@ -526,17 +553,19 @@
</tr>
</table>
</div>
<div class="method_details ">
- <p class="signature " id="to_json-instance_method">
+ <h3 class="signature " id="to_json-instance_method">
- (<tt>Object</tt>) <strong>to_json</strong>
-</p><div class="docstring">
+
+
+</h3><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>
@@ -571,14 +600,14 @@
</div>
</div>
</div>
-
+
<div id="footer">
- Generated on Mon Mar 12 11:02:59 2012 by
+ Generated on Thu Feb 21 11:20:31 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.7.5 (ruby-1.8.7).
+ 0.8.4.1 (ruby-1.8.7).
</div>
</body>
</html>
\ No newline at end of file