timeline_setter 0.3.1 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. data/Rakefile +1 -1
  2. data/doc/doc.markdown +6 -0
  3. data/doc/static-demo.html +34 -0
  4. data/doc/templates.html +1 -1
  5. data/doc/timeline-setter.html +1 -1
  6. data/doc/timeline-setter.min.html +1 -1
  7. data/documentation/TimelineSetter.html +26 -19
  8. data/documentation/TimelineSetter/CLI.html +65 -34
  9. data/documentation/TimelineSetter/Parser.html +44 -31
  10. data/documentation/TimelineSetter/Timeline.html +65 -36
  11. data/documentation/_index.html +28 -24
  12. data/documentation/class_list.html +11 -5
  13. data/documentation/css/full_list.css +4 -2
  14. data/documentation/css/style.css +50 -44
  15. data/documentation/file.README.html +24 -17
  16. data/documentation/file_list.html +12 -6
  17. data/documentation/frames.html +20 -5
  18. data/documentation/index.html +24 -17
  19. data/documentation/js/app.js +52 -43
  20. data/documentation/js/full_list.js +9 -9
  21. data/documentation/js/jquery.js +4 -16
  22. data/documentation/method_list.html +22 -16
  23. data/documentation/top-level-namespace.html +25 -18
  24. data/index.html +1 -0
  25. data/lib/timeline_setter/version.rb +1 -1
  26. data/public/javascripts/templates.js +1 -1
  27. data/public/javascripts/templates/timeline.jst +8 -5
  28. data/public/javascripts/timeline-setter.js +11 -4
  29. data/public/javascripts/timeline-setter.min.js +1 -1
  30. data/public/javascripts/vendor/jquery-min.js +5 -4
  31. data/public/javascripts/vendor/jquery.js +5042 -4849
  32. data/public/stylesheets/timeline-setter.css +416 -388
  33. data/spec/timeline-debug.html +1 -1
  34. data/timeline_setter.gemspec +4 -3
  35. metadata +6 -5
data/documentation/TimelineSetter/Parser.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: TimelineSetter::Parser
8
8
 
9
- &mdash; Documentation by YARD 0.7.5
9
+ &mdash; Documentation by YARD 0.8.4.1
10
10
 
11
11
  </title>
12
12
 
@@ -15,10 +15,12 @@
15
15
  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
16
 
17
17
  <script type="text/javascript" charset="utf-8">
18
- relpath = '..';
19
- if (relpath != '') relpath += '/';
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!" + escape(window.location.href);
20
21
  </script>
21
22
 
23
+
22
24
  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
25
 
24
26
  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
@@ -26,36 +28,41 @@
26
28
 
27
29
  </head>
28
30
  <body>
29
- <script type="text/javascript" charset="utf-8">
30
- if (window.top.frames.main) document.body.className = 'frames';
31
- </script>
32
-
33
31
  <div id="header">
34
32
  <div id="menu">
35
33
 
36
- <a href="../_index.html">Index (P)</a> &raquo;
34
+ <a href="../_index.html">Index (P)</a> &raquo;
37
35
  <span class='title'><span class='object_link'><a href="../TimelineSetter.html" title="TimelineSetter (module)">TimelineSetter</a></span></span>
38
36
  &raquo;
39
37
  <span class="title">Parser</span>
40
38
 
41
-
39
+
42
40
  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
41
  </div>
44
42
 
45
43
  <div id="search">
46
44
 
47
- <a id="class_list_link" href="#">Class List</a>
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
48
49
 
49
- <a id="method_list_link" href="#">Method List</a>
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
50
54
 
51
- <a id="file_list_link" href="#">File List</a>
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
52
59
 
53
60
  </div>
54
61
  <div class="clear"></div>
55
62
  </div>
56
-
63
+
57
64
  <iframe id="search_frame"></iframe>
58
-
65
+
59
66
  <div id="content"><h1>Class: TimelineSetter::Parser
60
67
 
61
68
 
@@ -109,7 +116,10 @@
109
116
  </span>
110
117
 
111
118
 
112
- <span class="note title readonly">readonly</span>
119
+
120
+
121
+ <span class="note title readonly">readonly</span>
122
+
113
123
 
114
124
 
115
125
 
@@ -147,6 +157,7 @@
147
157
 
148
158
  </span>
149
159
 
160
+
150
161
  <span class="note title constructor">constructor</span>
151
162
 
152
163
 
@@ -171,27 +182,28 @@ row (event) in the sheet to an events array.</p>
171
182
  <h2>Constructor Details</h2>
172
183
 
173
184
  <div class="method_details first">
174
- <p class="signature first" id="initialize-instance_method">
185
+ <h3 class="signature first" id="initialize-instance_method">
175
186
 
176
187
  - (<tt><span class='object_link'><a href="" title="TimelineSetter::Parser (class)">Parser</a></span></tt>) <strong>initialize</strong>(sheet)
177
188
 
178
189
 
179
190
 
180
- </p><div class="docstring">
191
+
192
+
193
+ </h3><div class="docstring">
181
194
  <div class="discussion">
182
195
 
183
196
  <p>Initialize a new timeline from a CSV file via TableFu, add a hash for each
184
197
  row (event) in the sheet to an events array. Sheet should contain columns
185
198
  for</p>
186
199
 
187
- <pre class="code ruby"><code><span class='mult op'>*</span> <span class='rubyid_date identifier id'>date</span>
188
- <span class='mult op'>*</span> <span class='rubyid_display_date identifier id'>display_date</span>
189
- <span class='mult op'>*</span> <span class='rubyid_description identifier id'>description</span>
190
- <span class='mult op'>*</span> <span class='rubyid_link identifier id'>link</span>
191
- <span class='mult op'>*</span> <span class='rubyid_thumbnail identifier id'>thumbnail</span>
192
- <span class='mult op'>*</span> <span class='rubyid_series identifier id'>series</span>
193
- <span class='mult op'>*</span> <span class='rubyid_html identifier id'>html</span>
194
- </code></pre>
200
+ <pre class="code ruby18"><code class="ruby18">* date
201
+ * display_date
202
+ * description
203
+ * link
204
+ * thumbnail
205
+ * series
206
+ * html</code></pre>
195
207
 
196
208
 
197
209
  </div>
@@ -244,15 +256,16 @@ for</p>
244
256
 
245
257
 
246
258
  <span id=""></span>
247
- <span id="events-instance_method"></span>
248
259
  <div class="method_details first">
249
- <p class="signature first" id="events-instance_method">
260
+ <h3 class="signature first" id="events-instance_method">
250
261
 
251
262
  - (<tt>Object</tt>) <strong>events</strong> <span class="extras">(readonly)</span>
252
263
 
253
264
 
254
265
 
255
- </p><div class="docstring">
266
+
267
+
268
+ </h3><div class="docstring">
256
269
  <div class="discussion">
257
270
 
258
271
  <p>Returns the value of attribute events</p>
@@ -289,11 +302,11 @@ for</p>
289
302
 
290
303
 
291
304
  </div>
292
-
305
+
293
306
  <div id="footer">
294
- Generated on Mon Mar 12 11:02:59 2012 by
307
+ Generated on Thu Feb 21 11:20:31 2013 by
295
308
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
296
- 0.7.5 (ruby-1.8.7).
309
+ 0.8.4.1 (ruby-1.8.7).
297
310
  </div>
298
311
 
299
312
  </body>
data/documentation/TimelineSetter/Timeline.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: TimelineSetter::Timeline
8
8
 
9
- &mdash; Documentation by YARD 0.7.5
9
+ &mdash; Documentation by YARD 0.8.4.1
10
10
 
11
11
  </title>
12
12
 
@@ -15,10 +15,12 @@
15
15
  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
16
 
17
17
  <script type="text/javascript" charset="utf-8">
18
- relpath = '..';
19
- if (relpath != '') relpath += '/';
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!" + escape(window.location.href);
20
21
  </script>
21
22
 
23
+
22
24
  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
25
 
24
26
  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
@@ -26,36 +28,41 @@
26
28
 
27
29
  </head>
28
30
  <body>
29
- <script type="text/javascript" charset="utf-8">
30
- if (window.top.frames.main) document.body.className = 'frames';
31
- </script>
32
-
33
31
  <div id="header">
34
32
  <div id="menu">
35
33
 
36
- <a href="../_index.html">Index (T)</a> &raquo;
34
+ <a href="../_index.html">Index (T)</a> &raquo;
37
35
  <span class='title'><span class='object_link'><a href="../TimelineSetter.html" title="TimelineSetter (module)">TimelineSetter</a></span></span>
38
36
  &raquo;
39
37
  <span class="title">Timeline</span>
40
38
 
41
-
39
+
42
40
  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
41
  </div>
44
42
 
45
43
  <div id="search">
46
44
 
47
- <a id="class_list_link" href="#">Class List</a>
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
48
49
 
49
- <a id="method_list_link" href="#">Method List</a>
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
50
54
 
51
- <a id="file_list_link" href="#">File List</a>
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
52
59
 
53
60
  </div>
54
61
  <div class="clear"></div>
55
62
  </div>
56
-
63
+
57
64
  <iframe id="search_frame"></iframe>
58
-
65
+
59
66
  <div id="content"><h1>Class: TimelineSetter::Timeline
60
67
 
61
68
 
@@ -109,7 +116,10 @@
109
116
  </span>
110
117
 
111
118
 
112
- <span class="note title readonly">readonly</span>
119
+
120
+
121
+ <span class="note title readonly">readonly</span>
122
+
113
123
 
114
124
 
115
125
 
@@ -152,6 +162,7 @@
152
162
 
153
163
 
154
164
 
165
+
155
166
 
156
167
 
157
168
  <span class="summary_desc"><div class='inline'></div></span>
@@ -168,6 +179,7 @@
168
179
 
169
180
  </span>
170
181
 
182
+
171
183
  <span class="note title constructor">constructor</span>
172
184
 
173
185
 
@@ -199,6 +211,7 @@ Parser#initialize.</p>
199
211
 
200
212
 
201
213
 
214
+
202
215
 
203
216
 
204
217
  <span class="summary_desc"><div class='inline'></div></span>
@@ -220,6 +233,7 @@ Parser#initialize.</p>
220
233
 
221
234
 
222
235
 
236
+
223
237
 
224
238
 
225
239
  <span class="summary_desc"><div class='inline'>
@@ -244,6 +258,7 @@ and embedding all assets into our ERB template.</p>
244
258
 
245
259
 
246
260
 
261
+
247
262
 
248
263
 
249
264
  <span class="summary_desc"><div class='inline'></div></span>
@@ -265,6 +280,7 @@ and embedding all assets into our ERB template.</p>
265
280
 
266
281
 
267
282
 
283
+
268
284
 
269
285
 
270
286
  <span class="summary_desc"><div class='inline'>
@@ -282,13 +298,15 @@ the events hash to JSON to stick into our HTML.</p>
282
298
  <h2>Constructor Details</h2>
283
299
 
284
300
  <div class="method_details first">
285
- <p class="signature first" id="initialize-instance_method">
301
+ <h3 class="signature first" id="initialize-instance_method">
286
302
 
287
303
  - (<tt><span class='object_link'><a href="" title="TimelineSetter::Timeline (class)">Timeline</a></span></tt>) <strong>initialize</strong>(opts = {})
288
304
 
289
305
 
290
306
 
291
- </p><div class="docstring">
307
+
308
+
309
+ </h3><div class="docstring">
292
310
  <div class="discussion">
293
311
 
294
312
  <p>Instantiate a new timeline from an events array created in
@@ -331,15 +349,16 @@ Parser#initialize</p>
331
349
 
332
350
 
333
351
  <span id=""></span>
334
- <span id="timeline-instance_method"></span>
335
352
  <div class="method_details first">
336
- <p class="signature first" id="timeline-instance_method">
353
+ <h3 class="signature first" id="timeline-instance_method">
337
354
 
338
355
  - (<tt>Object</tt>) <strong>timeline</strong> <span class="extras">(readonly)</span>
339
356
 
340
357
 
341
358
 
342
- </p><div class="docstring">
359
+
360
+
361
+ </h3><div class="docstring">
343
362
  <div class="discussion">
344
363
 
345
364
  <p>Create timeline HTML by interpolating events hash into an ERB template.
@@ -366,7 +385,7 @@ preserves external links to CSS and JS.</p>
366
385
  <pre class="code"><span class="info file"># File 'lib/timeline_setter/timeline.rb', line 32</span>
367
386
 
368
387
  <span class='rubyid_def def kw'>def</span> <span class='rubyid_timeline identifier id'>timeline</span>
369
- <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'>&quot;timeline.erb&quot;</span><span class='rparen token'>)</span>
388
+ <span class='rubyid_@timeline ivar id'>@timeline</span>
370
389
  <span class='rubyid_end end kw'>end</span>
371
390
  </pre>
372
391
  </td>
@@ -379,16 +398,18 @@ preserves external links to CSS and JS.</p>
379
398
 
380
399
  <div id="instance_method_details" class="method_details_list">
381
400
  <h2>Instance Method Details</h2>
382
-
401
+
383
402
 
384
403
  <div class="method_details first">
385
- <p class="signature first" id="config_json-instance_method">
404
+ <h3 class="signature first" id="config_json-instance_method">
386
405
 
387
406
  - (<tt>Object</tt>) <strong>config_json</strong>
388
407
 
389
408
 
390
409
 
391
- </p><table class="source_code">
410
+
411
+
412
+ </h3><table class="source_code">
392
413
  <tr>
393
414
  <td>
394
415
  <pre class="lines">
@@ -417,13 +438,15 @@ preserves external links to CSS and JS.</p>
417
438
  </div>
418
439
 
419
440
  <div class="method_details ">
420
- <p class="signature " id="timeline_markup-instance_method">
441
+ <h3 class="signature " id="timeline_markup-instance_method">
421
442
 
422
443
  - (<tt>Object</tt>) <strong>timeline_markup</strong>
423
444
 
424
445
 
425
446
 
426
- </p><table class="source_code">
447
+
448
+
449
+ </h3><table class="source_code">
427
450
  <tr>
428
451
  <td>
429
452
  <pre class="lines">
@@ -446,13 +469,15 @@ preserves external links to CSS and JS.</p>
446
469
  </div>
447
470
 
448
471
  <div class="method_details ">
449
- <p class="signature " id="timeline_min-instance_method">
472
+ <h3 class="signature " id="timeline_min-instance_method">
450
473
 
451
474
  - (<tt>Object</tt>) <strong>timeline_min</strong>
452
475
 
453
476
 
454
477
 
455
- </p><div class="docstring">
478
+
479
+
480
+ </h3><div class="docstring">
456
481
  <div class="discussion">
457
482
 
458
483
  <p>Create a minified one-page version of a timeline by minifying CSS and JS
@@ -486,7 +511,7 @@ and embedding all assets into our ERB template.</p>
486
511
  <span class='rubyid_def def kw'>def</span> <span class='rubyid_timeline_min identifier id'>timeline_min</span>
487
512
  <span class='rubyid_@js ivar id'>@js</span> <span class='assign token'>=</span> <span class='string val'>&quot;&quot;</span>
488
513
  <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'>&quot;#{TimelineSetter::ROOT}/public/stylesheets/timeline-setter.css&quot;</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>
489
- <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'>&quot;#{TimelineSetter::ROOT}/public/javascripts/vendor/**&quot;</span><span class='rparen token'>)</span>
514
+ <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'>&quot;#{TimelineSetter::ROOT}/public/javascripts/vendor/**&quot;</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>
490
515
  <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'>&lt;&lt;</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>
491
516
  <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>
492
517
  <span class='rubyid_@js ivar id'>@js</span> <span class='lshft op'>&lt;&lt;</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'>&quot;#{TimelineSetter::ROOT}/public/javascripts/timeline-setter.min.js&quot;</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>
@@ -499,13 +524,15 @@ and embedding all assets into our ERB template.</p>
499
524
  </div>
500
525
 
501
526
  <div class="method_details ">
502
- <p class="signature " id="tmpl-instance_method">
527
+ <h3 class="signature " id="tmpl-instance_method">
503
528
 
504
529
  - (<tt>Object</tt>) <strong>tmpl</strong>(tmpl_file)
505
530
 
506
531
 
507
532
 
508
- </p><table class="source_code">
533
+
534
+
535
+ </h3><table class="source_code">
509
536
  <tr>
510
537
  <td>
511
538
  <pre class="lines">
@@ -528,13 +555,15 @@ and embedding all assets into our ERB template.</p>
528
555
  </div>
529
556
 
530
557
  <div class="method_details ">
531
- <p class="signature " id="to_json-instance_method">
558
+ <h3 class="signature " id="to_json-instance_method">
532
559
 
533
560
  - (<tt>Object</tt>) <strong>to_json</strong>
534
561
 
535
562
 
536
563
 
537
- </p><div class="docstring">
564
+
565
+
566
+ </h3><div class="docstring">
538
567
  <div class="discussion">
539
568
 
540
569
  <p>Convert human dates to timestamps, sort the hash by timestamp, and convert
@@ -573,11 +602,11 @@ the events hash to JSON to stick into our HTML.</p>
573
602
  </div>
574
603
 
575
604
  </div>
576
-
605
+
577
606
  <div id="footer">
578
- Generated on Mon Mar 12 11:02:59 2012 by
607
+ Generated on Thu Feb 21 11:20:31 2013 by
579
608
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
580
- 0.7.5 (ruby-1.8.7).
609
+ 0.8.4.1 (ruby-1.8.7).
581
610
  </div>
582
611
 
583
612
  </body>