repertoire-faceting 0.5.2 → 0.5.3

data/FAQ

@@ -1,42 +1,54 @@
-= Repertoire Faceting FAQ =
+= Repertoire Faceting FAQ
 
-= Related questions
+== General questions
 
-Q. Rails 3 refuses to update schema.rb because with my fulltext index columns.
+*Q* Can I use Rails 3 migrations with Repertoire Faceting?
 
-A. Put the following line in environment.rb:
+*A* In general, yes. However, Rails' developers recommend you use the database's native dump format rather than schema.rb. Put the following line in environment.rb:
 
-  config.active_record.schema_format = :sql
+      config.active_record.schema_format = :sql
 
 
-= About facet indexing and the signature SQL type = 
+== About facet indexing and the signature SQL type
 
-Q. What's the scalability of this thing?
+*Q* What's the scalability of this thing?
 
-A. Up to about 500,000 items, supposing 6-8 simultaneous facets with domains anywhere from 2-100 values.  In other words, beyond
-   the size of most commonly available datasets.  See the citizens example in the specs directory & example faceting app.
-   
-   It has been tested with up to 1,000,000 items, but this requires unix configuration to give Postgresql lots of shared memory.
+*A* Up to about 500,000 items, supposing 6-8 simultaneous facets with domains anywhere from 2-100 values.  In other words, beyond the size of most commonly available datasets.  See the citizens example in the specs directory & example faceting app. It has been tested with up to 1,000,000 items, but this requires unix configuration to give Postgresql lots of shared memory.
+
+
+*Q* My facets are empty.
+
+*A* Make sure the facet indices aren't empty.  Running '<model>.update_indexed_facets([])' from the console will drop them all.
+
+
+*Q* Can I facet over multiple models?
+
+*A* Not currently.  However, this may be possible using an ActiveRecord polymorphic relation on the main model.
 
 
-Q. My nested facet widget is empty!
+*Q* Why a new native PostgreSQL type?
 
-A. Did you remember to call expand_nesting(<facet index table>, <facet name>) after creating your index?
+*A* As of PostgreSQL 8.4, there is no support for population counts in either blobs or bitstrings. Neither of these built-in types provides both the bitset and I/O functions required for faceting.
 
 
+== About the ajax faceting widgets
 
-= About the ajax faceting widgets =
 
-Q. A web page from the default Rails app refuses to load the faceting widgets.
+*Q* Rails 3 is sending JSON data in a format that my javascript widgets don't understand.
 
-A. Repertoire Faceting widgets are based on JQuery, which is incompatible with Prototype.  You should remove
-   prototype.js and rails.js from the javascripts directory, and delete the <%= javascript_include_tag :defaults %>
-	 line from application.html.erb.
+*A* Put the following line in config/application.rb:
 
-Q. How do I send page-specific data (for example, a search field) to the webservice with the facet widgets' data?
+   config.active_record.include_root_in_json = false
 
-A. If you provide a function to the facet_context plugin, it will merge the params you return before dispatching to
-   the webservice, e.g.
+
+*Q* A web page from the default Rails app refuses to load the faceting widgets.
+
+*A* Repertoire Faceting widgets are based on JQuery, which is incompatible with Prototype.  You should remove prototype.js and rails.js from the javascripts directory, and delete the <%= javascript_include_tag :defaults %> line from application.html.erb.
+
+
+*Q* How do I send page-specific data (for example, a search field) to the webservice with the facet widgets' data?
+
+*A* If you provide a function to the facet_context plugin, it will merge the params you return before dispatching to the webservice, e.g.
 
    $('#invoices').facet_context(function() {
      return { 
@@ -45,16 +57,13 @@ A. If you provide a function to the facet_context plugin, it will merge the para
    });
 
 
-Q. I want to change the default options for all widgets of a given class.
+*Q* I want to change the default options for all widgets of a given class.
 
-A. See the syntax for defining jquery plugins - you can alter the defaults for all widgets by reassigning them in your
-   view code.
+*A* See the syntax for defining jquery plugins - you can alter the defaults for all widgets by reassigning them in your view code.
 
-Q. How do I make one-time, minor changes to the behaviour of a widget?  For example, I want to add a control.
+*Q* How do I make one-time, minor changes to the behaviour of a widget?  For example, I want to add a control.
 
-A. Use the inject option, which is part of the base functionality.  Your injector function receives a reference to the
-   widget's jquery element and to the widget javascript object.  Use jquery to add your control's markup, then
-   register an event handler to add its behaviour.  For example, this injector adds a clear-all button in the title:
+*A* Use the inject option, which is part of the base functionality.  Your injector function receives a reference to the widget's jquery element and to the widget javascript object.  Use jquery to add your control's markup, then register an event handler to add its behaviour.  For example, this injector adds a clear-all button in the title:
    
    $('#genre').facet({
       injectors: {
@@ -69,20 +78,17 @@ A. Use the inject option, which is part of the base functionality.  Your injecto
       }
     });
 
-   The injector adds markup for the control at the specific jquery selector, and the handler receives events on that markup.  Both
-   receive a single argument 'self' for the widget object, and 'this' for the matched DOM element.
-   
-   Note the syntax used to identify a handler's event and dom element: '<event.namespace>!<target>'.  Both event and namespace
-   are optional - leave them out to register a click handler with a unique namespace.
-   
-   In injectors and handlers, you have access to the complete faceting widget API (state, refinements, toggle, is_selected, etc.).
-   You can basically build a new widget, if you need to. See the documentation for the faceting_widget class for details.
+The injector adds markup for the control at the specific jquery selector, and the handler receives events on that markup.  Both receive a single argument 'self' for the widget object, and 'this' for the matched DOM element.
 
+Note the syntax used to identify a handler's event and dom element: '<event.namespace>!<target>'.  Both event and namespace are optional - leave them out to register a click handler with a unique namespace.
 
-Q. My additonal control needs to send data back to the webservice too.
+In injectors and handlers, you have access to the complete faceting widget API (state, refinements, toggle, is_selected, etc.). You can basically build a new widget, if you need to. See the documentation for the faceting_widget class for details.
+
+
+*Q* My additonal control needs to send data back to the webservice too.
+
+*A* You can pre-process the entire context's state before it's sent to the webservice by update():
 
-A. You can pre-process the entire context's state before it's sent to the webservice by update():
-   
    var min = 5;
    $('#genre').facet({
      injectors:  { ... },
@@ -91,46 +97,42 @@ A. You can pre-process the entire context's state before it's sent to the webser
    }
 
 
-Q. How do I subclass an existing widget, so I can reuse my changes repeatedly?
+*Q* How do I subclass an existing widget, so I can reuse my changes repeatedly?
 
-A. Basically you define a new widget class and move your injectors and handlers (above) into the appropriate places.  See the 
-   results widget for the simplest possible example, and nested_facet for a real-world example that extends the default facet
-   widget.  At a bare minimum, you will over-ride the render() method, and possibly the update() method too.  Here's a 'hello
-   world' that extends the default facet count widget:
+*A* Basically you define a new widget class and move your injectors and handlers (above) into the appropriate places.  See the results widget for the simplest possible example, and nested_facet for a real-world example that extends the default facet widget.  At a bare minimum, you will over-ride the render() method, and possibly the update() method too.  Here is a 'hello world' that extends the default facet count widget:
 
-var hello_world = function($elem, options) {
-  /* declare superclass */
-	var self = repertoire.facet($elem, options);
+    var hello_world = function($elem, options) {
+      /* declare superclass */
+    	var self = repertoire.facet($elem, options);
 	
-  /* handlers */
-  handler('.hello', function() { 
-    alert('hello, world!'); 
-  });
-
-  /* injectors */
-  var $template_fn = self.render;
-  self.render = function(data) {
-    var $markup = $template_fn(data);
-    $markup.find('.title .controls').append('<div class='hello'>click me!</div');
-    return $markup;
-  }
+      /* handlers */
+      handler('.hello', function() { 
+        alert('hello, world!'); 
+      });
+
+      /* injectors */
+      var $template_fn = self.render;
+      self.render = function(data) {
+        var $markup = $template_fn(data);
+        $markup.find('.title .controls').append('<div class='hello'>click me!</div');
+        return $markup;
+      }
 
-  return self;
-}
+      return self;
+    }
 
 
-Q. That's great, but how do I turn it into a jquery plugin I can actually use?
+*Q* That's great, but how do I turn it into a jquery plugin I can actually use?
 
-A. Call the plugin method and assign it to a variable in the jquery prototype.  If provided, the line following sets universal
-   options defaults for the widget.
+*A* Call the plugin method and assign it to a variable in the jquery prototype.  If provided, the line following sets universal options defaults for the widget.
 
    $.fn.hello_world = repertoire.plugin(hello_world);
    $.fn.hello_world.defaults = { ... };       // put default options here
 
 
-Q. How do these widgets relate to each other?
+*Q* How do these widgets relate to each other?
 
-A. Here is the class hierarchy:
+*A* Here is the class hierarchy:
 
    facet_widget (abstract)
       +--- facet
@@ -138,39 +140,34 @@ A. Here is the class hierarchy:
       +--- results
 
 
-Q. In my widget or handler, how do I override an event handler from the superclass?
+*Q* In my widget or handler, how do I override an event handler from the superclass?
 
-A. Register another handler to the exact same event and namespace.  E.g. toggling selection for facet value counts
-   in the default facet widget is registered under the jquery event/namespace 'click.toggle_value'.  To over-ride:
+*A* Register another handler to the exact same event and namespace.  E.g. toggling selection for facet value counts in the default facet widget is registered under the jquery event/namespace 'click.toggle_value'.  To over-ride:
 
-... [ in widget's constructor function ]
+    ... [ in widget's constructor function ]
 
-self.handler('click.toggle_value!.facet .value', function() {
-   ... redefined event handler
-}
-...
+    self.handler('click.toggle_value!.facet .value', function() {
+       ... redefined event handler
+    }
+    ...
 
 
-Q. My widget needs to send additional data to the webservice, pre-process the state, compute my own query string, or 
-   use a different webservice.
+*Q* My widget needs to send additional data to the webservice, pre-process the state, compute my own query string, or use a different webservice.
 
-A. You can over-ride self.update() to alter the webservice ajax call or replace it with your own.  (1) if sending additional 
-   data that affects only the current widget, store it in a private variable and add it in update().  (2) if the additional 
-   data affects all otherfacets, store it in the structure returned by self.state() and make sure the other widgets/webservices 
-   can process it correctly.
-   
-   
-Q. What Javascript OOP convention is this?
+*A* You can over-ride self.update() to alter the webservice ajax call or replace it with your own. (a) if sending additional data that affects only the current widget, store it in a private variable and add it in update().  (b) if the additional data affects all other facets, store it in the structure returned by self.state() and make sure the other widgets/webservices can process it correctly.
 
-A. It's based on section 5.4, "Functional Inheritance" of Douglas Crockford, "Javascript: The Good Parts."  
 
+*Q* What Javascript OOP convention is this?
 
-Q. Explain the naming conventions.
+*A* It's based on section 5.4, "Functional Inheritance" of Douglas Crockford, "Javascript: The Good Parts."  
 
-A. $foo is a jquery object, e.g. var $foo = $('.foo')
-   self is the object you're currently defining (as opposed to the one it inherits from, javascript's 'this', or its dom view)
-   
-   
-Q. Why not support the metadata jquery plugin?  Why not automatically turn all elements with a 'facet' class into facet widgets?
 
-A. Possibly.  It needs some thought.
+*Q* Explain the naming conventions.
+
+*A* $foo is a jquery object, e.g. var $foo = $('.foo') 
+self is the object you're currently defining (as opposed to the one it inherits from, javascript's 'this', or its dom view)
+
+
+*Q* Why not support the metadata jquery plugin?  Why not automatically turn all elements with a 'facet' class into facet widgets?
+
+*A* Possibly.  It needs some thought.

data/INSTALL

@@ -1,49 +1,53 @@
 === Installing Repertoire Faceting
 
-== Short version. (Assuming you have a working Rails 3 app, with a model, controller, and a partial to show to model)
+N.B.  Repertoire Faceting requires Rails 3.0+, Ruby 1.9.2+, and JQuery 1.3.2+.
+
+== Short version. 
+
+(You need a working Rails 3 app, with a model, controller, and a partial to show the model)
 
   { in Gemfile }
-    gem 'repertoire-faceting'                                        // 1
+    gem 'repertoire-faceting'                              // 1
 
   { install native bitset extensions }
   $ bundle install
-  $ rake db:faceting:build                                   { provide sudo your password }
+  $ rake db:faceting:build        { provide sudo your password }
   $ rake db:faceting:load
 
   { in ./app/models/some_model.rb }
-  	class SomeModel
-	    include Repertoire::Faceting::Model                          // 2
-	    facet :some_column                                           // 3
-	  end
+    class SomeModel
+        include Repertoire::Faceting::Model                // 2
+        facet :some_column                                 // 3
+      end
 
   { in ./app/controllers/some_controller]
-		class SomeController
-		  include Repertoire::Faceting::Controller                   // 4
-		  def base; return SomeModel; end                            // 5
-		end
-		
+        class SomeController
+          include Repertoire::Faceting::Controller         // 4
+          def base; return SomeModel; end                  // 5
+        end
+        
   { in ./config/routes.rb }
     SomeApp::Application.routes.draw do
-	    faceting_for :some_model                                     // 6
-	  end
-	
-	{ in ./public/javascripts/application.js }
-	  //= require <rep.faceting>                                     // 7
+        faceting_for :some_model                           // 6
+      end
+    
+    { in ./public/javascripts/application.js }
+      //= require <rep.faceting>                           // 7
 
   { in ./app/views/some_controller/index.html.erb }
     <script language="javascript">
       $().ready(function() {
-        $('#paintings').facet_context();                             // 8
-        $('.facet').facet();                                         // 9
-        $('#results').results();                                     // 10
+        $('#paintings').facet_context();                   // 8
+        $('.facet').facet();                               // 9
+        $('#results').results();                           // 10
       });
     </script>
-    <div id='paintings'>                                             // 11
-      <div id='genre' class='facet'></div>                           // 12
-      <div id='results'></div>                                       // 13
+    <div id='paintings'>                                   // 11
+      <div id='genre' class='facet'></div>                 // 12
+      <div id='results'></div>                             // 13
     </div>
 
-	... that's a complete faceted browser in only 13 new lines of code in your app!
+    ... that's a complete faceted browser in only 13 new lines of code in your app!
 
   In production, you will want to compress the javascript facet widgets:
 
@@ -62,168 +66,176 @@
 
 Start with a working Rails 3 application with a PostgreSQL database.
 
-* Require repertoire-faceting in Gemfile.
-
-  gem 'repertoire-faceting'
-
-* Make sure you use Rails version 3.0.2+, which adopted Arel 2.0.1.  If necessary
-  you can pull rails, arel, and rack from git.
-
-  gem 'rails', :git => 'git://github.com/rails/rails.git'
-  gem 'arel',  :git => 'git://github.com/rails/arel.git'
-  gem "rack", :git => "git://github.com/rack/rack.git"
-
-* At the command line, bundle everything into your application:
-
-  $ bundle install
-
-* From your application root, build and install the repertoire-faceting native 
-  extensions to PostgreSQL.  These provide a bitwise signature type used to 
-  index and count facets.
-
-  $ rake db:faceting:build     { sudo will prompt you for your password }
-
-* Load the extension into your local application database.  This ensures the
-  plpgsql language is installed, and loads (or re-loads) the new bitset signature
-  type.
-
-  $ rake db:faceting:load
-
-  You can confirm the module is installed as follows.
-
-  $ psql -c "SELECT count('101010101'::signature);" -U<username> <database>
+    * Require repertoire-faceting in Gemfile.
 
-* Install the faceting mixin in your Rails model and declare a facet on an 
-  existing database column.  (See the README for complete configuration options 
-  for facets.)  
+      gem 'repertoire-faceting'
 
-  { ./app/models/painting.rb }
-    class Painting
-      include Repertoire::Faceting::Model
-      facet :genre
-    end
+    * Make sure you use Rails version 3.0.2+, which adopted Arel 2.0.1.  If necessary
+      you can pull rails, arel, and rack from git.
 
-* Test doing facet count and result queries:
+      gem 'rails', :git => 'git://github.com/rails/rails.git'
+      gem 'arel',  :git => 'git://github.com/rails/arel.git'
+      gem "rack", :git => "git://github.com/rack/rack.git"
 
-  $ rails c
-  > Painting.count(:genre)
-  => {"Impressionist"=>2, "Medieval"=>2} 
-  > Painting.refine(:genre => 'Impressionist')
-  => [#<Painting id: 1, title: "Moonlight Shimmers", painter: "Monet", genre: "Impressionist">, 
-      #<Painting id: 2, title: "Nude Lunch in Garden", painter: "Manet", genre: "Impressionist">] 
+    * At the command line, bundle everything into your application:
 
-  Or, with a base query as well:
+      $ bundle install
 
-  > Painting.where(["title like ?", 'Moon%']).count(:genre)
-  => {"Impressionist"=>1} 
+    * From your application root, build and install the repertoire-faceting native 
+      extensions to PostgreSQL.  These provide a bitwise signature type used to 
+      index and count facets.
 
-* Add faceting webservices to your controller and define base() to indicate which model to base queries on 
+      $ rake db:faceting:build     { sudo will prompt you for your password }
 
-  { ./app/controllers/paintings_controller }
-    class PaintingsController
-      include Repertoire::Faceting::Controller
+    * Load the extension into your local application database.  This ensures the
+      plpgsql language is installed, and loads (or re-loads) the new bitset signature
+      type.
 
-      def base
-        search = "%#{params[:search]}%"
-        Painting.where(["title like ?", search])
-      end
-    end
-
-* Add faceting routes to your application.  
-
-  { ./config/routes.rb }
-
-    PaintingsApp::Application.routes.draw do
-      faceting_for :paintings         # NB must be BEFORE any resources!
-      ...
-    end
-
-  Confirm they load:
-
-  $ rake routes
-    ...
-                             /paintings/counts/:facet(.:format) {:controller=>"paintings", :action=>"counts"}
-    paintings_results        /paintings/results(.:format)       {:controller=>"paintings", :action=>"results"}
-    ...
-
-* Load the javascript facet widgets in your main javascript file. The 
-  repertoire-assets subsystem will locate the widgets in your application's
-  rubygems, and load them as appropriate.
-
-  { ./public/javascripts/application.js }
-    ...
-    //= require <rep.faceting>
-    ...
-
-  N.B. Repertoire Faceting widgets are based on JQuery, which is incompatible 
-       with Prototype.  If you have not already done so, you should remove 
-       prototype.js and rails.js from the javascripts directory, and delete the 
-       "<%= javascript_include_tag :defaults %>" line from application.html.erb.
-
-* Add facet count and result widgets to your HTML page. The facet context div 
-  collects widgets that affect the same query together. (For complete options, 
-  see the README ) 
-
-  { ./app/views/paintings/index.html.erb }
-
-      <script language="javascript">
-        $().ready(function() {
-          $('#paintings').facet_context();
-          $('.facet').facet();
-          $('#results').results();
-		});
-		</script>
-	  <div id='paintings'>
-        <div id='genre' class='facet'></div>
-        <div id='results'></div> 
-      </div>
-	
-* If you don't already have one, create a partial for displaying your model in 
-  results lists.
-
-  { ./app/views/paintings/_painting.html.erb }
-	
-	<div class='painting' style='width:235px; margin-bottom:5px; padding:2px; border:dotted 1px;'>
-	  <div>Title: <%= painting.title %></div>
-		<div>Painter: <%= painting.painter %></div>
-		<div>Genre: <%= painting.genre %></div>
-	</div>
-
-* [ Optional ] Configure the repertoire-assets module that loads the javascript 
-  faceting widgets to compress the widget code in production. 
-
-  { ./config/environments/production.rb }
-
-    PaintingsApp::Application.configure do
-      ...
-      config.repertoire_assets.compress = true
-      ...
-    end
-
-* [ Optional ] Add bitset indexes to some facets on your model.  The module will 
-  automatically use facet indexes when they are available.  Facet indexes scale 
-  out of the box to over a million model items, and require no additional 
-  configuration.
-
-  $ rails generate migration AddFacetIndex
+      $ createlang plpgsql -U<username> <database>
+      $ rake db:faceting:load
   
-  { ./db/migrate/<your date>add_facet_index.rb   }
-		class AddFacetIndex < ActiveRecord::Migration
-		  def self.up
-		    Painting.update_indexed_facets([:genre])
-		  end
+      Or, if you prefer to use migrations create one with the following contents:
+        
+            ....   
+            def self.up
+              load_faceting        # unload_faceting is the reverse
+            end
+
+      Before proceeding, you can confirm the module is installed as follows.
+
+      $ psql -c "SELECT count('101010101'::signature);" -U<username> <database>
+
+    * Install the faceting mixin in your Rails model and declare a facet on an 
+      existing database column.  (See the README for complete configuration options 
+      for facets.)  
+
+      { ./app/models/painting.rb }
+        class Painting
+          include Repertoire::Faceting::Model
+          facet :genre
+        end
+
+    * Test doing facet count and result queries:
+
+      $ rails c
+      > Painting.count(:genre)
+      => {"Impressionist"=>2, "Medieval"=>2} 
+      > Painting.refine(:genre => 'Impressionist')
+      => [#<Painting id: 1, title: "Moonlight Shimmers", painter: "Monet", genre: "Impressionist">, 
+          #<Painting id: 2, title: "Nude Lunch in Garden", painter: "Manet", genre: "Impressionist">] 
+
+      Or, with a base query as well:
+
+      > Painting.where(["title like ?", 'Moon%']).count(:genre)
+      => {"Impressionist"=>1} 
+
+    * Add faceting webservices to your controller and define base() to indicate which model to base queries on 
+
+      { ./app/controllers/paintings_controller }
+        class PaintingsController
+          include Repertoire::Faceting::Controller
+
+          def base
+            search = "%#{params[:search]}%"
+            Painting.where(["title like ?", search])
+          end
+        end
+
+    * Add faceting routes to your application.  
+
+      { ./config/routes.rb }
+
+        PaintingsApp::Application.routes.draw do
+          faceting_for :paintings         # NB must be BEFORE any resources!
+          ...
+        end
+
+      Confirm they load:
+
+      $ rake routes
+        ...
+                                 /paintings/counts/:facet(.:format) {:controller=>"paintings", :action=>"counts"}
+        paintings_results        /paintings/results(.:format)       {:controller=>"paintings", :action=>"results"}
+        ...
+
+    * Load the javascript facet widgets in your main javascript file. The 
+      repertoire-assets subsystem will locate the widgets in your application's
+      rubygems, and load them as appropriate.
+
+      { ./public/javascripts/application.js }
+        ...
+        //= require <rep.faceting>
+        ...
+
+      N.B. Repertoire Faceting widgets are based on JQuery, which is incompatible 
+           with Prototype.  If you have not already done so, you should remove 
+           prototype.js and rails.js from the javascripts directory, and delete the 
+           "<%= javascript_include_tag :defaults %>" line from application.html.erb.
+
+    * Add facet count and result widgets to your HTML page. The facet context div 
+      collects widgets that affect the same query together. (For complete options, 
+      see the README ) 
+
+      { ./app/views/paintings/index.html.erb }
+
+          <script language="javascript">
+            $().ready(function() {
+              $('#paintings').facet_context();
+              $('.facet').facet();
+              $('#results').results();
+            });
+            </script>
+          <div id='paintings'>
+            <div id='genre' class='facet'></div>
+            <div id='results'></div> 
+          </div>
+    
+    * If you don't already have one, create a partial for displaying your model in 
+      results lists.
+
+      { ./app/views/paintings/_painting.html.erb }
+    
+        <div class='painting' style='width:235px; margin-bottom:5px; padding:2px; border:dotted 1px;'>
+          <div>Title: <%= painting.title %></div>
+            <div>Painter: <%= painting.painter %></div>
+            <div>Genre: <%= painting.genre %></div>
+        </div>
+
+    * [ Optional ] Configure the repertoire-assets module that loads the javascript 
+      faceting widgets to compress the widget code in production. 
+
+      { ./config/environments/production.rb }
+
+        PaintingsApp::Application.configure do
+          ...
+          config.repertoire_assets.compress = true
+          ...
+        end
+
+    * [ Optional ] Add bitset indexes to some facets on your model.  The module will 
+      automatically use facet indexes when they are available.  Facet indexes scale 
+      out of the box to over a million model items, and require no additional 
+      configuration.
+
+      $ rails generate migration AddFacetIndex
+  
+      { ./db/migrate/<your date>add_facet_index.rb   }
+            class AddFacetIndex < ActiveRecord::Migration
+              def self.up
+                Painting.update_indexed_facets([:genre])
+              end
 
-		  def self.down
-		    Painting.update_indexed_facets
-		  end
-		end
+              def self.down
+                Painting.update_indexed_facets
+              end
+            end
 
-* [ Optional ] Periodically update indexes via a crontab task. 
+    * [ Optional ] Periodically update indexes via a crontab task. 
 
-  { ./lib/tasks/update_facets.rake }
+      { ./lib/tasks/update_facets.rake }
 
-  task :reindex_facets => :environment do
-	  Painting.update_indexed_facets
-  end
+      task :reindex => :environment do
+          Painting.update_indexed_facets
+      end
 
-  ... And then configure crontab to execute 'rake reindex_facets' at appropriate intervals.
+      ... And then configure crontab to execute 'rake reindex' at appropriate intervals.