doc/doc.markdown in timeline_setter-0.1.2 vs doc/doc.markdown in timeline_setter-0.2.0

- old
+ new

@@ -70,13 +70,14 @@ Full list of options: * `-c CSV` Path to your CSV file. * `-o OUTPUT_PATH` Path to output timeline and assets. If absent, timeline will be created in current directory. -* `-a` Add the default supporting assets to the output directory, along with the timeline itself. +* `-a` Do not output supporting assets such as CSS and JavaScript. This is useful if you're customizing those and don't want your versions clobbered. * `-m` Create a minified one-page version of your timeline with all supporting assets inline. * `-O` Open a browser to your new timeline after it is generated (currently Mac OS only). +* `-i` Add a custom interval for background "interval notches." These take the format of JavaScript date [getter methods](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date#Methods). For example, year would be `FullYear.` All the options are available [below](#interval_notch_options). If absent, TimelineSetter will attempt to automatically create interval notches based on the first and last dates in your timeline. * `-h` Print help to standard output. <a id="csv"></a> ## Setting Up Your CSV File @@ -197,10 +198,23 @@ month => June, 2004 day => May 1, 2005 hour/minute => 11:59 second => 11:59:22 +<a id="interval_notch_options"></a> +The interval notches date spans themselves can be customized by using the `-i` flag when generating a timeline. The available parameters are + + Decade + Lustrum + FullYear + Month + Week + Date + Hours + Minutes + Seconds + Event notches are templated through `#TS-card-tmpl` and contain individual classes corresponding to spreadsheet columns. `.TS-item-label` corresponds to `description`, `.TS-item_html` corresponds to `html`, `.TS-read_btn` is linked to `link` and `.TS-item_year` corresponds to `display_date` falling through to `date`. Finally, `TS-permalink` @@ -225,10 +239,11 @@ <a id="links"></a> ## Links * In the Wild: [ProPublica: How One Blast Affected Five Soldiers](http://www.propublica.org/special/tbi-psycho-platoon-timeline) * In the Wild: [TPM: The Wisconsin Union Struggle Timeline](http://www.talkingpointsmemo.com/interactive/2011/04/the-wisconsin-union-struggle-timeline.php) +* In the Wild: [Los Angeles Times: Bell: 'Corruption on Steroids'](http://timelines.latimes.com/bell/) <a id="credits"></a> ## Credits [Al Shaw](http://github.com/ashaw), [Jeff Larson](http://github.com/thejefflarson), ProPublica, [Ben Welsh](http://github.com/palewire), Los Angeles Times @@ -240,9 +255,15 @@ [Issue Tracker](https://github.com/propublica/timeline-setter/issues). General questions should go to <a href="mailto:opensource@propublica.org">opensource@propublica.org</a>. <a id="changelog"></a> ## Change Log + +<a id="release-020"></a> +### 0.2.0 + +* New feature adds support for custom interval notch ranges. +* Change command line to output supporting assets by default unless `-a` is specified <a id="release-012"></a> ### 0.1.2 * Support for decade and lustrum (five year period) interval notches. _Thanks, [Ben Welsh](http://github.com/palewire)_ \ No newline at end of file