halation 0.1.0 → 0.2.0

data/doc/_index.html

@@ -81,6 +81,72 @@
     <td valign='top' width="33%">
       
         
+        <ul id="alpha_C" class="alpha">
+          <li class="letter">C</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="Halation/Config/Camera.html" title="Halation::Config::Camera (class)">Camera</a></span>
+                
+                  <small>(Halation::Config)</small>
+                
+              </li>
+            
+              <li>
+                <span class='object_link'><a href="Halation/Coerce.html" title="Halation::Coerce (class)">Coerce</a></span>
+                
+                  <small>(Halation)</small>
+                
+              </li>
+            
+              <li>
+                <span class='object_link'><a href="Halation/Config.html" title="Halation::Config (class)">Config</a></span>
+                
+                  <small>(Halation)</small>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
+        <ul id="alpha_E" class="alpha">
+          <li class="letter">E</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="Halation/Engine.html" title="Halation::Engine (class)">Engine</a></span>
+                
+                  <small>(Halation)</small>
+                
+              </li>
+            
+              <li>
+                <span class='object_link'><a href="Halation/ExifToolImage.html" title="Halation::ExifToolImage (class)">ExifToolImage</a></span>
+                
+                  <small>(Halation)</small>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
+        <ul id="alpha_F" class="alpha">
+          <li class="letter">F</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="Halation/Roll/Frame.html" title="Halation::Roll::Frame (class)">Frame</a></span>
+                
+                  <small>(Halation::Roll)</small>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
         <ul id="alpha_H" class="alpha">
           <li class="letter">H</li>
           <ul>
@@ -93,6 +159,51 @@
           </ul>
         </ul>
       
+        
+        <ul id="alpha_L" class="alpha">
+          <li class="letter">L</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="Halation/Config/Lens.html" title="Halation::Config::Lens (class)">Lens</a></span>
+                
+                  <small>(Halation::Config)</small>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
+        <ul id="alpha_R" class="alpha">
+          <li class="letter">R</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="Halation/Roll.html" title="Halation::Roll (class)">Roll</a></span>
+                
+                  <small>(Halation)</small>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
+        
+        <ul id="alpha_S" class="alpha">
+          <li class="letter">S</li>
+          <ul>
+            
+              <li>
+                <span class='object_link'><a href="Halation/Script.html" title="Halation::Script (class)">Script</a></span>
+                
+                  <small>(Halation)</small>
+                
+              </li>
+            
+          </ul>
+        </ul>
+      
     </td>
   </tr>
 </table>
@@ -102,7 +213,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May  4 22:46:35 2016 by
+  Generated on Sat May 28 22:28:56 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.7).
 </div>

data/doc/class_list.html

@@ -43,7 +43,7 @@
 
       <ul id="full_list" class="class">
         <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
-<li id='object_Halation' class='even'><div class='item' style='padding-left:30px'><span class='object_link'><a href="Halation.html" title="Halation (module)">Halation</a></span><small class='search_info'>Top Level Namespace</small></div></li>
+<li id='object_Halation' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Halation.html" title="Halation (module)">Halation</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Halation::Coerce' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Halation/Coerce.html" title="Halation::Coerce (class)">Coerce</a></span> &lt; Object<small class='search_info'>Halation</small></div></li><li id='object_Halation::Config' class='collapsed even'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Halation/Config.html" title="Halation::Config (class)">Config</a></span> &lt; Object<small class='search_info'>Halation</small></div><ul><li id='object_Halation::Config::Camera' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Halation/Config/Camera.html" title="Halation::Config::Camera (class)">Camera</a></span> &lt; Object<small class='search_info'>Halation::Config</small></div></li><li id='object_Halation::Config::Lens' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Halation/Config/Lens.html" title="Halation::Config::Lens (class)">Lens</a></span> &lt; Object<small class='search_info'>Halation::Config</small></div></li></ul></li><li id='object_Halation::Engine' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Halation/Engine.html" title="Halation::Engine (class)">Engine</a></span> &lt; Object<small class='search_info'>Halation</small></div></li><li id='object_Halation::ExifToolImage' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Halation/ExifToolImage.html" title="Halation::ExifToolImage (class)">ExifToolImage</a></span> &lt; Object<small class='search_info'>Halation</small></div></li><li id='object_Halation::Roll' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Halation/Roll.html" title="Halation::Roll (class)">Roll</a></span> &lt; Object<small class='search_info'>Halation</small></div><ul><li id='object_Halation::Roll::Frame' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Halation/Roll/Frame.html" title="Halation::Roll::Frame (class)">Frame</a></span> &lt; Object<small class='search_info'>Halation::Roll</small></div></li></ul></li><li id='object_Halation::Script' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="Halation/Script.html" title="Halation::Script (class)">Script</a></span> &lt; Object<small class='search_info'>Halation</small></div></li></ul></li>
 
       </ul>
     </div>

data/doc/file.LICENSE.html

@@ -84,7 +84,7 @@ DEALINGS IN THE SOFTWARE.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Wed May  4 22:46:35 2016 by
+  Generated on Sat May 28 22:28:56 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.7).
 </div>

data/doc/file.README.html

@@ -61,11 +61,221 @@
 
       <div id="content"><div id='filecontents'><h1>Halation</h1>
 
+<p><a href="https://badge.fury.io/rb/halation"><img src="https://badge.fury.io/rb/halation.svg" alt="Gem Version"></a>
+<a href="https://coveralls.io/github/amclain/halation?branch=master"><img src="https://coveralls.io/repos/github/amclain/halation/badge.svg?branch=master" alt="Coverage Status"></a>
+<a href="http://www.rubydoc.info/gems/halation"><img src="https://img.shields.io/badge/docs-api-blue.svg" alt="API Documentation"></a>
+<a href="https://github.com/amclain/halation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-yellowgreen.svg" alt="MIT License"></a></p>
+
 <p>Add Exif metadata to film photographs.</p>
+
+<h2>Issues, Bugs, Feature Requests</h2>
+
+<p>Any bugs and feature requests should be reported on the GitHub issue tracker:</p>
+
+<p><a href="https://github.com/amclain/halation/issues">https://github.com/amclain/halation/issues</a></p>
+
+<p><strong>Pull requests are preferred via GitHub.</strong></p>
+
+<p>Mercurial users can use <a href="http://hg-git.github.io/">Hg-Git</a> to interact with
+GitHub repositories.</p>
+
+<h2>Installation</h2>
+
+<p>Halation is available as a Ruby gem.</p>
+
+<ol>
+<li><p>Install <a href="https://www.ruby-lang.org">Ruby</a> 2.1 or higher.</p>
+
+<ul>
+<li>Windows: Use <a href="http://rubyinstaller.org/downloads/">RubyInstaller</a>.</li>
+<li>Mac: Use <a href="https://www.ruby-lang.org/en/documentation/installation/#homebrew">homebrew</a>.</li>
+<li>Linux: Use <a href="https://github.com/sstephenson/rbenv#basic-github-checkout">rbenv</a>.</li>
+<li><a href="https://www.ruby-lang.org/en/documentation/installation">Additional installation instructions</a></li>
+</ul></li>
+<li><p>Install <a href="http://www.sno.phy.queensu.ca/%7Ephil/exiftool/">ExifTool</a>.</p></li>
+<li><p>Open the <a href="http://www.addictivetips.com/windows-tips/windows-7-elevated-command-prompt-in-context-menu/">command line</a>
+and type:</p></li>
+</ol>
+
+<pre class="code text"><code class="text">    gem install halation
+</code></pre>
+
+<h2>Configuration</h2>
+
+<p>Halation stores its global configuration data in <code>.halation</code> in the system&#39;s
+user directory. This is typically <code>~/.halation</code> on Mac and *nix-based systems,
+or <code>C:\Users\.halation</code> on Windows.</p>
+
+<blockquote>
+<p>Halation uses the <a href="http://www.yaml.org/spec/1.2/spec.html#Preview">YAML syntax</a>
+for its configuration files.</p>
+</blockquote>
+
+<p>By default Halation uses a global configuration file, <code>~/.halation/config.yml</code>.
+This is where your generic settings are stored, like your name, copyright info,
+and information about your cameras.</p>
+
+<pre class="code yaml"><code class="yaml"># Example config.yml
+---
+artist: &quot;Example User&quot;
+copyright: &quot;2016 Example User&quot;
+cameras:
+  - tag: &quot;rz67&quot;
+    make: &quot;Mamiya&quot;
+    model: &quot;Mamiya RZ67 Pro II&quot;
+    lenses:
+      - tag: 65
+        model: &quot;M65mm f/4L-A&quot;
+        focal_length: 65
+      - tag: 110
+        model: &quot;Z110mm f/2.8W&quot;
+        focal_length: 110
+      - tag: 180
+        model: &quot;Z180mm f/4.5W-N&quot;
+        focal_length: 180
+      - tag: 250
+        model: &quot;M65mm f/4L-A&quot;
+        focal_length: 250
+</code></pre>
+
+<h2>Tags</h2>
+
+<p>Tags are user-defined values that serve as a quick and simple way to reference
+complex information.</p>
+
+<p>Why is this important? Let&#39;s say you shot a roll of ten images with several
+different lenses. It would be cumbersome to have to specify a model number
+like <code>Z110mm f/2.8W</code> (and all the other lens information) on each of the frames.
+Even more importantly, if you&#39;re processing batches of images over a long period
+of time (months, years), you&#39;re bound to make mistakes in the spelling of the
+model number. This is important because any software that catalogs images based
+on Exif data (Lightroom, Flickr) doesn&#39;t know how to deal with these
+inconsistencies. This means <code>Z110mm f/2.8W</code> and <code>Z110mm f/2.8 W</code> will be
+considered two different lenses by the software (did you see the difference?),
+even though we as humans understand they&#39;re the same thing. If you try to filter
+by lens in Lightroom, some of the images will be under one spelling and some
+will be under the other, even though they were both shot with the same
+110mm lens.</p>
+
+<p>Tags solve this problem by letting us define all of the complex,
+infrequently-changing data in one place. We can then reference that complex
+data by its <code>tag</code>. For example, if we have a 65mm lens and a 110mm lens we can
+define their information once and tag them as <code>65</code> and <code>110</code> respectively (we
+choose the tag names).</p>
+
+<pre class="code yaml"><code class="yaml">lenses:
+  - tag: 65
+    model: &quot;M65mm f/4L-A&quot;
+    focal_length: 65
+  - tag: 110
+    model: &quot;Z110mm f/2.8W&quot;
+    focal_length: 110
+</code></pre>
+
+<p>Now when we want to reference which lens was used when capturing a particular
+frame, all we have to do is specify the tag and Halation will fill in the
+correct Exif data for that lens when the image file is processed.</p>
+
+<pre class="code yaml"><code class="yaml">frames:
+  - number: 1
+    lens: 110
+  - number: 2
+    lens: 65
+  - number: 3
+    lens: 110
+</code></pre>
+
+<h2>Processing A Roll</h2>
+
+<p>Halation requires all of the image files for a roll of film to be in the same
+directory. The images should be named in ascending alphabetical order, with the
+first frame of the roll at the start of the list and the last frame at the end.
+This is typically the default when scanners save files. Halation will scan for
+tiff files (<code>.tif</code>, <code>.tiff</code>), which is the ideal format, as well as jpeg files
+(<code>.jpg</code>, <code>.jpeg</code>).</p>
+
+<p>This directory should also contain a <code>roll.yml</code> file, which specifies the data
+for each frame (image file) on the roll of film. A new <code>roll.yml</code> file can be
+generated in the current directory with the following command:</p>
+
+<pre class="code text"><code class="text">    halation --new-roll
+</code></pre>
+
+<p>The data for the roll can then be entered into the file:</p>
+
+<pre class="code yaml"><code class="yaml"># Example roll.yml
+---
+date: &quot;2016-01-01&quot;
+camera: &quot;rz67&quot;
+lens: 110
+iso: 100
+frames:
+  - number: 1
+    shutter: &quot;1/125&quot;
+    aperture: 8
+  - number: 2
+    shutter: &quot;2&quot;
+    lens: 65
+    aperture: 16
+  - number: 3
+    lens: 65
+    shutter: &quot;0.5&quot;
+    aperture: 16
+  - number: 4
+    lens: 65
+    shutter: &quot;0.5&quot;
+    aperture: 16
+  - number: 5
+    shutter: &quot;1/250&quot;
+    aperture: 4
+  - number: 6
+    shutter: &quot;1/125&quot;
+    aperture: 8
+  - number: 7
+    shutter: &quot;1/125&quot;
+    aperture: 8
+  - number: 8
+    shutter: &quot;1/60&quot;
+    aperture: 22
+  - number: 9
+    date: &quot;2016-01-02&quot;
+    shutter: &quot;1/400&quot;
+    aperture: 8
+    flash: yes
+  - number: 10
+    date: &quot;2016-01-02&quot;
+    shutter: &quot;1/400&quot;
+    aperture: 8
+    flash: yes
+</code></pre>
+
+<p>Default values can be set at the beginning of the file so that these settings
+don&#39;t have to be specified for each frame. For example, the roll of film has
+one ISO speed for all of the frames, so this can be specified at the top instead
+of for each individual frame.</p>
+
+<p>Values like the date are a little different, because maybe the whole roll was
+shot during the same day, or maybe it was shot over the course of several days.
+This is where the <code>roll.yml</code> file provides flexibility. Specifying <code>date</code> at the
+beginning of the file will make it the default date for all of the frames on the
+roll. If not all of the frames were shot on the same day, <code>date</code> can then be
+specified for each of the frames that have a different date (<code>9</code> and <code>10</code> in
+the example above). This concept works for most of the values.</p>
+
+<blockquote>
+<p>A complete list of keywords are available in the <a href="http://www.rubydoc.info/gems/halation">Halation API documentation</a>,
+as well as in the <a href="https://github.com/amclain/halation/tree/master/spec/samples">sample files</a>.</p>
+</blockquote>
+
+<p>After all of the necessary values are entered into <code>roll.yml</code>, the images can
+be processed by running the following command:</p>
+
+<pre class="code text"><code class="text">    halation
+</code></pre>
 </div></div>
 
       <div id="footer">
-  Generated on Wed May  4 22:46:35 2016 by
+  Generated on Sat May 28 22:28:56 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.7).
 </div>

data/doc/index.html

@@ -61,11 +61,221 @@
 
       <div id="content"><div id='filecontents'><h1>Halation</h1>
 
+<p><a href="https://badge.fury.io/rb/halation"><img src="https://badge.fury.io/rb/halation.svg" alt="Gem Version"></a>
+<a href="https://coveralls.io/github/amclain/halation?branch=master"><img src="https://coveralls.io/repos/github/amclain/halation/badge.svg?branch=master" alt="Coverage Status"></a>
+<a href="http://www.rubydoc.info/gems/halation"><img src="https://img.shields.io/badge/docs-api-blue.svg" alt="API Documentation"></a>
+<a href="https://github.com/amclain/halation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-yellowgreen.svg" alt="MIT License"></a></p>
+
 <p>Add Exif metadata to film photographs.</p>
+
+<h2>Issues, Bugs, Feature Requests</h2>
+
+<p>Any bugs and feature requests should be reported on the GitHub issue tracker:</p>
+
+<p><a href="https://github.com/amclain/halation/issues">https://github.com/amclain/halation/issues</a></p>
+
+<p><strong>Pull requests are preferred via GitHub.</strong></p>
+
+<p>Mercurial users can use <a href="http://hg-git.github.io/">Hg-Git</a> to interact with
+GitHub repositories.</p>
+
+<h2>Installation</h2>
+
+<p>Halation is available as a Ruby gem.</p>
+
+<ol>
+<li><p>Install <a href="https://www.ruby-lang.org">Ruby</a> 2.1 or higher.</p>
+
+<ul>
+<li>Windows: Use <a href="http://rubyinstaller.org/downloads/">RubyInstaller</a>.</li>
+<li>Mac: Use <a href="https://www.ruby-lang.org/en/documentation/installation/#homebrew">homebrew</a>.</li>
+<li>Linux: Use <a href="https://github.com/sstephenson/rbenv#basic-github-checkout">rbenv</a>.</li>
+<li><a href="https://www.ruby-lang.org/en/documentation/installation">Additional installation instructions</a></li>
+</ul></li>
+<li><p>Install <a href="http://www.sno.phy.queensu.ca/%7Ephil/exiftool/">ExifTool</a>.</p></li>
+<li><p>Open the <a href="http://www.addictivetips.com/windows-tips/windows-7-elevated-command-prompt-in-context-menu/">command line</a>
+and type:</p></li>
+</ol>
+
+<pre class="code text"><code class="text">    gem install halation
+</code></pre>
+
+<h2>Configuration</h2>
+
+<p>Halation stores its global configuration data in <code>.halation</code> in the system&#39;s
+user directory. This is typically <code>~/.halation</code> on Mac and *nix-based systems,
+or <code>C:\Users\.halation</code> on Windows.</p>
+
+<blockquote>
+<p>Halation uses the <a href="http://www.yaml.org/spec/1.2/spec.html#Preview">YAML syntax</a>
+for its configuration files.</p>
+</blockquote>
+
+<p>By default Halation uses a global configuration file, <code>~/.halation/config.yml</code>.
+This is where your generic settings are stored, like your name, copyright info,
+and information about your cameras.</p>
+
+<pre class="code yaml"><code class="yaml"># Example config.yml
+---
+artist: &quot;Example User&quot;
+copyright: &quot;2016 Example User&quot;
+cameras:
+  - tag: &quot;rz67&quot;
+    make: &quot;Mamiya&quot;
+    model: &quot;Mamiya RZ67 Pro II&quot;
+    lenses:
+      - tag: 65
+        model: &quot;M65mm f/4L-A&quot;
+        focal_length: 65
+      - tag: 110
+        model: &quot;Z110mm f/2.8W&quot;
+        focal_length: 110
+      - tag: 180
+        model: &quot;Z180mm f/4.5W-N&quot;
+        focal_length: 180
+      - tag: 250
+        model: &quot;M65mm f/4L-A&quot;
+        focal_length: 250
+</code></pre>
+
+<h2>Tags</h2>
+
+<p>Tags are user-defined values that serve as a quick and simple way to reference
+complex information.</p>
+
+<p>Why is this important? Let&#39;s say you shot a roll of ten images with several
+different lenses. It would be cumbersome to have to specify a model number
+like <code>Z110mm f/2.8W</code> (and all the other lens information) on each of the frames.
+Even more importantly, if you&#39;re processing batches of images over a long period
+of time (months, years), you&#39;re bound to make mistakes in the spelling of the
+model number. This is important because any software that catalogs images based
+on Exif data (Lightroom, Flickr) doesn&#39;t know how to deal with these
+inconsistencies. This means <code>Z110mm f/2.8W</code> and <code>Z110mm f/2.8 W</code> will be
+considered two different lenses by the software (did you see the difference?),
+even though we as humans understand they&#39;re the same thing. If you try to filter
+by lens in Lightroom, some of the images will be under one spelling and some
+will be under the other, even though they were both shot with the same
+110mm lens.</p>
+
+<p>Tags solve this problem by letting us define all of the complex,
+infrequently-changing data in one place. We can then reference that complex
+data by its <code>tag</code>. For example, if we have a 65mm lens and a 110mm lens we can
+define their information once and tag them as <code>65</code> and <code>110</code> respectively (we
+choose the tag names).</p>
+
+<pre class="code yaml"><code class="yaml">lenses:
+  - tag: 65
+    model: &quot;M65mm f/4L-A&quot;
+    focal_length: 65
+  - tag: 110
+    model: &quot;Z110mm f/2.8W&quot;
+    focal_length: 110
+</code></pre>
+
+<p>Now when we want to reference which lens was used when capturing a particular
+frame, all we have to do is specify the tag and Halation will fill in the
+correct Exif data for that lens when the image file is processed.</p>
+
+<pre class="code yaml"><code class="yaml">frames:
+  - number: 1
+    lens: 110
+  - number: 2
+    lens: 65
+  - number: 3
+    lens: 110
+</code></pre>
+
+<h2>Processing A Roll</h2>
+
+<p>Halation requires all of the image files for a roll of film to be in the same
+directory. The images should be named in ascending alphabetical order, with the
+first frame of the roll at the start of the list and the last frame at the end.
+This is typically the default when scanners save files. Halation will scan for
+tiff files (<code>.tif</code>, <code>.tiff</code>), which is the ideal format, as well as jpeg files
+(<code>.jpg</code>, <code>.jpeg</code>).</p>
+
+<p>This directory should also contain a <code>roll.yml</code> file, which specifies the data
+for each frame (image file) on the roll of film. A new <code>roll.yml</code> file can be
+generated in the current directory with the following command:</p>
+
+<pre class="code text"><code class="text">    halation --new-roll
+</code></pre>
+
+<p>The data for the roll can then be entered into the file:</p>
+
+<pre class="code yaml"><code class="yaml"># Example roll.yml
+---
+date: &quot;2016-01-01&quot;
+camera: &quot;rz67&quot;
+lens: 110
+iso: 100
+frames:
+  - number: 1
+    shutter: &quot;1/125&quot;
+    aperture: 8
+  - number: 2
+    shutter: &quot;2&quot;
+    lens: 65
+    aperture: 16
+  - number: 3
+    lens: 65
+    shutter: &quot;0.5&quot;
+    aperture: 16
+  - number: 4
+    lens: 65
+    shutter: &quot;0.5&quot;
+    aperture: 16
+  - number: 5
+    shutter: &quot;1/250&quot;
+    aperture: 4
+  - number: 6
+    shutter: &quot;1/125&quot;
+    aperture: 8
+  - number: 7
+    shutter: &quot;1/125&quot;
+    aperture: 8
+  - number: 8
+    shutter: &quot;1/60&quot;
+    aperture: 22
+  - number: 9
+    date: &quot;2016-01-02&quot;
+    shutter: &quot;1/400&quot;
+    aperture: 8
+    flash: yes
+  - number: 10
+    date: &quot;2016-01-02&quot;
+    shutter: &quot;1/400&quot;
+    aperture: 8
+    flash: yes
+</code></pre>
+
+<p>Default values can be set at the beginning of the file so that these settings
+don&#39;t have to be specified for each frame. For example, the roll of film has
+one ISO speed for all of the frames, so this can be specified at the top instead
+of for each individual frame.</p>
+
+<p>Values like the date are a little different, because maybe the whole roll was
+shot during the same day, or maybe it was shot over the course of several days.
+This is where the <code>roll.yml</code> file provides flexibility. Specifying <code>date</code> at the
+beginning of the file will make it the default date for all of the frames on the
+roll. If not all of the frames were shot on the same day, <code>date</code> can then be
+specified for each of the frames that have a different date (<code>9</code> and <code>10</code> in
+the example above). This concept works for most of the values.</p>
+
+<blockquote>
+<p>A complete list of keywords are available in the <a href="http://www.rubydoc.info/gems/halation">Halation API documentation</a>,
+as well as in the <a href="https://github.com/amclain/halation/tree/master/spec/samples">sample files</a>.</p>
+</blockquote>
+
+<p>After all of the necessary values are entered into <code>roll.yml</code>, the images can
+be processed by running the following command:</p>
+
+<pre class="code text"><code class="text">    halation
+</code></pre>
 </div></div>
 
       <div id="footer">
-  Generated on Wed May  4 22:46:35 2016 by
+  Generated on Sat May 28 22:28:56 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.1.7).
 </div>