timeline_setter 0.3.0 → 0.3.1

data/documentation/js/full_list.js

@@ -2,20 +2,41 @@ var inSearch = null;
 var searchIndex = 0;
 var searchCache = [];
 var searchString = '';
+var regexSearchString = '';
+var caseSensitiveMatch = false;
+var ignoreKeyCodeMin = 8;
+var ignoreKeyCodeMax = 46;
+var commandKey = 91;
+
+RegExp.escape = function(text) {
+    return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
+}
 
 function fullListSearch() {
   // generate cache
   searchCache = [];
   $('#full_list li').each(function() {
     var link = $(this).find('.object_link a');
-    searchCache.push({name:link.text(), node:$(this), link:link});
+    var fullName = link.attr('title').split(' ')[0];
+    searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
   });
   
   $('#search input').keyup(function() {
-    searchString = this.value.toLowerCase();
+    if ((event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) 
+         || event.keyCode == commandKey)
+      return;
+    searchString = this.value;
+    caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
+    regexSearchString = RegExp.escape(searchString);
+    if (caseSensitiveMatch) {
+      regexSearchString += "|" + 
+        $.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
+        join('.+?');
+    }
     if (searchString === "") {
       clearTimeout(inSearch);
       inSearch = null;
+      $('ul .search_uncollapsed').removeClass('search_uncollapsed');
       $('#full_list, #content').removeClass('insearch');
       $('#full_list li').removeClass('found').each(function() {
         
@@ -47,16 +68,18 @@ var lastRowClass = '';
 function searchItem() {
   for (var i = 0; i < searchCache.length / 50; i++) {
     var item = searchCache[searchIndex];
-    if (item.name.toLowerCase().indexOf(searchString) == -1) {
+    var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
+    var matchString = regexSearchString;
+    var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
+    if (searchName.match(matchRegexp) == null) {
       item.node.removeClass('found');
     }
     else {
       item.node.css('padding-left', '10px').addClass('found');
+      item.node.parents().addClass('search_uncollapsed');
       item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
       lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
-      item.link.html(item.name.replace(new RegExp("(" + 
-        searchString.replace(/([\/.*+?|()\[\]{}\\])/g, "\\$1") + ")", "ig"), 
-        '<strong>$1</strong>'));
+      item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
     }
 
     if (searchCache.length === searchIndex + 1) {

data/documentation/method_list.html

@@ -41,7 +41,7 @@
         
 
   <li class="r1 ">
-    <span class='object_link'><a href="TimelineSetter/CLI.html#compile%21-instance_method" title="TimelineSetter::CLI#compile! (method)">#compile!</a></span> 
+    <span class='object_link'><a href="TimelineSetter/CLI.html#compile%21-instance_method" title="TimelineSetter::CLI#compile! (method)">#compile!</a></span>
     
       <small>TimelineSetter::CLI</small>
     
@@ -49,7 +49,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="TimelineSetter/Timeline.html#config_json-instance_method" title="TimelineSetter::Timeline#config_json (method)">#config_json</a></span> 
+    <span class='object_link'><a href="TimelineSetter/Timeline.html#config_json-instance_method" title="TimelineSetter::Timeline#config_json (method)">#config_json</a></span>
     
       <small>TimelineSetter::Timeline</small>
     
@@ -57,7 +57,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="TimelineSetter/CLI.html#events-instance_method" title="TimelineSetter::CLI#events (method)">#events</a></span> 
+    <span class='object_link'><a href="TimelineSetter/CLI.html#events-instance_method" title="TimelineSetter::CLI#events (method)">#events</a></span>
     
       <small>TimelineSetter::CLI</small>
     
@@ -65,7 +65,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="TimelineSetter/Parser.html#events-instance_method" title="TimelineSetter::Parser#events (method)">#events</a></span> 
+    <span class='object_link'><a href="TimelineSetter/Parser.html#events-instance_method" title="TimelineSetter::Parser#events (method)">#events</a></span>
     
       <small>TimelineSetter::Parser</small>
     
@@ -73,7 +73,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="TimelineSetter/CLI.html#html-instance_method" title="TimelineSetter::CLI#html (method)">#html</a></span> 
+    <span class='object_link'><a href="TimelineSetter/CLI.html#html-instance_method" title="TimelineSetter::CLI#html (method)">#html</a></span>
     
       <small>TimelineSetter::CLI</small>
     
@@ -81,7 +81,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="TimelineSetter/Timeline.html#initialize-instance_method" title="TimelineSetter::Timeline#initialize (method)">#initialize</a></span> 
+    <span class='object_link'><a href="TimelineSetter/Timeline.html#initialize-instance_method" title="TimelineSetter::Timeline#initialize (method)">#initialize</a></span>
     
       <small>TimelineSetter::Timeline</small>
     
@@ -89,23 +89,23 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="TimelineSetter/CLI.html#initialize-instance_method" title="TimelineSetter::CLI#initialize (method)">#initialize</a></span> 
+    <span class='object_link'><a href="TimelineSetter/Parser.html#initialize-instance_method" title="TimelineSetter::Parser#initialize (method)">#initialize</a></span>
     
-      <small>TimelineSetter::CLI</small>
+      <small>TimelineSetter::Parser</small>
     
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="TimelineSetter/Parser.html#initialize-instance_method" title="TimelineSetter::Parser#initialize (method)">#initialize</a></span> 
+    <span class='object_link'><a href="TimelineSetter/CLI.html#initialize-instance_method" title="TimelineSetter::CLI#initialize (method)">#initialize</a></span>
     
-      <small>TimelineSetter::Parser</small>
+      <small>TimelineSetter::CLI</small>
     
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="TimelineSetter/CLI.html#outdir-instance_method" title="TimelineSetter::CLI#outdir (method)">#outdir</a></span> 
+    <span class='object_link'><a href="TimelineSetter/CLI.html#outdir-instance_method" title="TimelineSetter::CLI#outdir (method)">#outdir</a></span>
     
       <small>TimelineSetter::CLI</small>
     
@@ -113,7 +113,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="TimelineSetter/CLI.html#parse_options%21-instance_method" title="TimelineSetter::CLI#parse_options! (method)">#parse_options!</a></span> 
+    <span class='object_link'><a href="TimelineSetter/CLI.html#parse_options%21-instance_method" title="TimelineSetter::CLI#parse_options! (method)">#parse_options!</a></span>
     
       <small>TimelineSetter::CLI</small>
     
@@ -121,7 +121,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="TimelineSetter/CLI.html#sheet-instance_method" title="TimelineSetter::CLI#sheet (method)">#sheet</a></span> 
+    <span class='object_link'><a href="TimelineSetter/CLI.html#sheet-instance_method" title="TimelineSetter::CLI#sheet (method)">#sheet</a></span>
     
       <small>TimelineSetter::CLI</small>
     
@@ -129,7 +129,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="TimelineSetter/Timeline.html#timeline-instance_method" title="TimelineSetter::Timeline#timeline (method)">#timeline</a></span> 
+    <span class='object_link'><a href="TimelineSetter/Timeline.html#timeline-instance_method" title="TimelineSetter::Timeline#timeline (method)">#timeline</a></span>
     
       <small>TimelineSetter::Timeline</small>
     
@@ -137,7 +137,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="TimelineSetter/Timeline.html#timeline_markup-instance_method" title="TimelineSetter::Timeline#timeline_markup (method)">#timeline_markup</a></span> 
+    <span class='object_link'><a href="TimelineSetter/Timeline.html#timeline_markup-instance_method" title="TimelineSetter::Timeline#timeline_markup (method)">#timeline_markup</a></span>
     
       <small>TimelineSetter::Timeline</small>
     
@@ -145,7 +145,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="TimelineSetter/Timeline.html#timeline_min-instance_method" title="TimelineSetter::Timeline#timeline_min (method)">#timeline_min</a></span> 
+    <span class='object_link'><a href="TimelineSetter/Timeline.html#timeline_min-instance_method" title="TimelineSetter::Timeline#timeline_min (method)">#timeline_min</a></span>
     
       <small>TimelineSetter::Timeline</small>
     
@@ -153,7 +153,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="TimelineSetter/CLI.html#timeline_page_path-instance_method" title="TimelineSetter::CLI#timeline_page_path (method)">#timeline_page_path</a></span> 
+    <span class='object_link'><a href="TimelineSetter/CLI.html#timeline_page_path-instance_method" title="TimelineSetter::CLI#timeline_page_path (method)">#timeline_page_path</a></span>
     
       <small>TimelineSetter::CLI</small>
     
@@ -161,7 +161,7 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="TimelineSetter/Timeline.html#tmpl-instance_method" title="TimelineSetter::Timeline#tmpl (method)">#tmpl</a></span> 
+    <span class='object_link'><a href="TimelineSetter/Timeline.html#tmpl-instance_method" title="TimelineSetter::Timeline#tmpl (method)">#tmpl</a></span>
     
       <small>TimelineSetter::Timeline</small>
     
@@ -169,7 +169,7 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="TimelineSetter/Timeline.html#to_json-instance_method" title="TimelineSetter::Timeline#to_json (method)">#to_json</a></span> 
+    <span class='object_link'><a href="TimelineSetter/Timeline.html#to_json-instance_method" title="TimelineSetter::Timeline#to_json (method)">#to_json</a></span>
     
       <small>TimelineSetter::Timeline</small>
     

data/documentation/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.7.2
+    &mdash; Documentation by YARD 0.7.5
   
 </title>
 
@@ -91,12 +91,14 @@
 
 
 
+
+
 </div>
     
     <div id="footer">
-  Generated on Wed Nov  2 15:20:08 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>

data/index.html

@@ -82,7 +82,7 @@
   </head>
   <body>
     <a href="http://www.propublica.org" class="propublica">&nbsp;</a>
-    <h1>TimelineSetter 0.3.0</h1>
+    <h1>TimelineSetter 0.3.1</h1>
 
 <p>TimelineSetter creates beautiful timelines.</p>
 
@@ -246,7 +246,7 @@ should see a structure much like this where you&rsquo;ve specified your output:<
   |-----timeline-setter.js
   |-----vendor
   |-------underscore-min.js
-  |-------jquery-min.js      
+  |-------jquery-min.js
   |---stylesheets
   |-----timeline-setter.css
 </code></pre>
@@ -279,8 +279,9 @@ associated <em>event cards</em>.</p>
 <p>The <code>interval</code> option takes an <a href="#interval_notch_options">interval</a> in the form of a JavaScript date getter. The <code>container</code> option allows you to inject the entire timeline into an element with the given selector. (By default this is <code>#timeline</code>). Finally, <code>formatter</code> is a way to format dates on the timeline&rsquo;s interval notches. Write a formatter like so:</p>
 
 <pre><code>formatter : function(d, defaults) {
-  defaults.months = ['enero', 'febrero', 'marzo', 'abril', 'mayo', 'junio', 'julio', 'agosto', 'septiembre', 'octubre', 'noviembre', 'diciembre'];
-  return defaults;     
+  var months = ['enero', 'febrero', 'marzo', 'abril', 'mayo', 'junio', 'julio', 'agosto', 'septiembre', 'octubre', 'noviembre', 'diciembre'];
+  defaults.month = months[d.getMonth()];
+  return defaults;
 }
 </code></pre>
 
@@ -328,12 +329,12 @@ second      =&gt; 11:59:22
 The interval notches date spans themselves can be customized by using the <code>-i</code> flag when generating a timeline. The available parameters are</p>
 
 <pre><code>Decade
-Lustrum 
+Lustrum
 FullYear
 Month
-Week  
-Date   
-Hours 
+Week
+Date
+Hours
 Minutes
 Seconds
 </code></pre>
@@ -345,7 +346,7 @@ Seconds
 <p>As of version 0.3.0, TimelineSetter has a JavaScript API that allows programmatic access to certain events, and the ability to activate cards. To use the API, assign the <code>TimelineSetter.Timeline.boot()</code> function to a variable, and then use methods in the <code>api</code> object like so:</p>
 
 <pre><code>var currentTimeline = TimelineSetter.Timeline.boot(options);
-currentTimeline.api.onLoad(function() { 
+currentTimeline.api.onLoad(function() {
   console.log("I'm ready")
 });
 </code></pre>
@@ -360,11 +361,14 @@ currentTimeline.api.onLoad(function() {
 
 <p>Register a callback for when a card is added to the timeline. This method has access to the event name and the card object.</p>
 
-<pre><code>currentTimeline.api.onCardAdd(function(evtName, obj) {
+<pre><code>currentTimeline.api.onCardAdd(function(evtName, obj, card) {
   console.log(obj);
+  console.log(card);
 });
 </code></pre>
 
+<p>If you want to customize the card&rsquo;s template, set <code>card.template</code> to an undescore template function.</p>
+
 <h3>onCardActivate</h3>
 
 <p>Register a callback for when a card is activated (i.e. shown). This method has access to the event name and the card object.</p>
@@ -397,14 +401,25 @@ Feb. 21, 1952 and Jan. 26, 1957, as shown
 </ul>
 
 
-<p><a id="links"></a></p>
+<p><a id="orgs"></a></p>
 
-<h2>Links</h2>
+<h2>Media Organizations Using TimelineSetter</h2>
 
 <ul>
-<li>In the Wild: <a href="http://www.propublica.org/special/tbi-psycho-platoon-timeline">ProPublica: How One Blast Affected Five Soldiers</a></li>
-<li>In the Wild: <a href="http://www.talkingpointsmemo.com/interactive/2011/04/the-wisconsin-union-struggle-timeline.php">TPM: The Wisconsin Union Struggle Timeline</a></li>
-<li>In the Wild: <a href="http://timelines.latimes.com/bell/">Los Angeles Times: Bell: &lsquo;Corruption on Steroids&rsquo;</a></li>
+<li><a href="http://www.propublica.org/special/tbi-psycho-platoon-timeline">ProPublica</a></li>
+<li><a href="http://timelines.latimes.com/bell/">Los Angeles Times</a></li>
+<li><a href="http://www.chicagotribune.com/news/local/chi-taxi-ts-docs-20111118,0,3641202.htmlstory">Chicago Tribune</a></li>
+<li><a href="http://www.huffingtonpost.com/2011/09/09/ground-zero-world-trade-center-freedom-tower_n_955845.html">Huffington Post</a></li>
+<li><a href="http://www.talkingpointsmemo.com/interactive/2011/04/the-wisconsin-union-struggle-timeline.php">Talking Points Memo</a></li>
+<li><a href="http://www.minnpost.com/bachmanntimeline/">MinnPost</a></li>
+<li><a href="http://www.jsonline.com/news/129159038.html">Milwaukee Journal-Sentinel</a></li>
+<li><a href="http://www.wnyc.org/articles/its-free-country/2011/may/20/timeline-gay-marriage-nystate/">WNYC</a></li>
+<li><a href="http://www.artinfo.com/news/story/37506/getting-to-know-ai-weiwei-a-multimedia-biographical-timeline/">ArtInfo</a></li>
+<li><a href="http://www.globalnews.ca/afghanistan/timeline/index.html?utm_source=facebook-twitter&amp;utm_medium=link&amp;utm_campaign=community">Global TV News (Canada)</a></li>
+<li><a href="http://www.pbs.org/newshour/timeline/uprising/">PBS Newshour</a></li>
+<li><a href="http://www.marketplace.org/topics/economy/raising-debt-ceiling">American Public Media: Marketplace</a></li>
+<li><a href="http://blog.chron.com/rickperry/timeline-the-rise-of-rick-perry/">San Antonio Express-News</a></li>
+<li><a href="http://www.voanews.com/english/news/asia/southeast/Burma-Timeline-134760588.html#1183262400000-">Voice of America</a></li>
 </ul>
 
 
@@ -426,6 +441,18 @@ questions should go to <a href="mailto:opensource@propublica.org">opensource@pro
 
 <h2>Change Log</h2>
 
+<p><a id="release-031"></a></p>
+
+<h3>0.3.1</h3>
+
+<ul>
+<li>Fix position bug that was preventing card flipping in IE &lt;= 8</li>
+<li>Add <code>noscript</code> fallback</li>
+<li>Add Century, HalfCentury, Quincenenary, HalfHour, QuarterHour, Millenium intervals</li>
+<li>Fix CLI in cases where output directory already exists</li>
+</ul>
+
+
 <p><a id="release-030"></a></p>
 
 <h3>0.3.0</h3>

data/lib/timeline_setter/cli.rb

@@ -69,12 +69,13 @@ module TimelineSetter
     def outdir
       @options[:output] ? @options[:output] : "#{`pwd`.strip}/"
     end
-    
+
     def timeline_page_path
       File.join(outdir, 'timeline.html')
     end
 
     def compile!
+      FileUtils.mkdir_p outdir unless File.exists? outdir
       if !@options[:no_assets] || !@options[:min]
         FileUtils.cp_r(Dir.glob("#{TimelineSetter::ROOT}/public/*"), outdir)
         # Concatenate JSTs to timeline-setter.js and remove templates.js

data/lib/timeline_setter/timeline.rb

@@ -38,7 +38,7 @@ module TimelineSetter
     def timeline_min
       @js = ""
       @css = Kompress::CSS.new(File.open("#{TimelineSetter::ROOT}/public/stylesheets/timeline-setter.css").read).css
-      libs = Dir.glob("#{TimelineSetter::ROOT}/public/javascripts/vendor/**")
+      libs = Dir.glob("#{TimelineSetter::ROOT}/public/javascripts/vendor/**").select {|q| q =~ /min/ }
       libs.each { |lib| @js << File.open(lib,'r').read }
       @min_html = Kompress::HTML.new(timeline_markup).html
       @js << File.open("#{TimelineSetter::ROOT}/public/javascripts/timeline-setter.min.js", 'r').read

data/lib/timeline_setter/version.rb

@@ -1,3 +1,3 @@
 module TimelineSetter
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end