blacklight 5.9.3 → 5.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ea3fda913edc204db8dbc3b5a06ced2862324ad
-  data.tar.gz: 0b1b41f89ccdfcd3dcd1b88857ccb0919a29afd9
+  metadata.gz: 8126f3ed502a69a91c6d18d78257a088da61315f
+  data.tar.gz: 09ba87bc46a31e4fc41a425378a28fe5aeee9bd4
 SHA512:
-  metadata.gz: 57fbc7119ffaa221ff7e562ba6e1e27d0e4a8c10a44e1bde8ee95164cebd6f5ad40b5054466035aae35faf2f49da9f88f53c6dbc60e0d486f3abea5910b63479
-  data.tar.gz: 29737da492197e076a19f36c103ae9277ea2bd063d036041b10ee1a6aae10589136a0243113c92a7716d929da51d59d5eb7f1e7438833336f1b45ee54161e1e0
+  metadata.gz: f7f98846b1ff0ce90bdf7c9b9e4012acfcad300ee7e59a8aa2b0fecba45c937440ec5bddc5c7ce56f463cc07b4385b6ffbaff72295c725611389a23d7eda038a
+  data.tar.gz: 885d1bcd43fea076f50fe2b7f4bc746799aaa7d6394a39b31594ea9d9c7fc28969e7708fefc4415236050c71484a83456bdd0fd16cafa049dc9f126e646fc92b

data/Gemfile

@@ -8,10 +8,8 @@ gemspec path: File.expand_path('..', __FILE__)
 gem 'simplecov', '~> 0.7.1', require: false
 gem 'coveralls', require: false
 
-gem 'engine_cart', '~> 0.4'
-
 group :test do
-  gem "blacklight-marc", "~> 5.0", github: "projectblacklight/blacklight_marc"
+  gem "blacklight-marc", "5.5.0"
   gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 end
 

data/Rakefile

@@ -11,5 +11,4 @@ Bundler::GemHelper.install_tasks
 
 load "tasks/blacklight.rake"
 
-task :default => [:ci]
-task :clean => ['blacklight:clean']
+task :default => [:ci]

data/VERSION

@@ -1 +1 @@
-5.9.3
+5.9.4

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -337,8 +337,10 @@ module Blacklight::BlacklightHelperBehavior
   # @param [Hash] the query parameters to check
   # @return [Symbol]
   def document_index_view_type query_params=params
-    if query_params[:view] and blacklight_config.view.keys.include? query_params[:view].to_sym
-      query_params[:view].to_sym
+    view_param = query_params[:view]
+    view_param ||= session[:preferred_view]
+    if view_param and document_index_views.keys.include? view_param.to_sym
+      view_param.to_sym
     else
       default_document_index_view_type
     end

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -85,13 +85,11 @@ module Blacklight::ConfigurationHelperBehavior
   # Look up the label for the facet field
   def facet_field_label field
     field_config = blacklight_config.facet_fields[field]
+    defaults = [:"blacklight.search.fields.facet.#{field}", :"blacklight.search.fields.#{field}"]
+    defaults << field_config.label if field_config
+    defaults << field.to_s.humanize
 
-    solr_field_label(
-      :"blacklight.search.fields.facet.#{field}",
-      :"blacklight.search.fields.#{field}",
-      (field_config.label if field_config),
-      field.to_s.humanize
-    )
+    solr_field_label *defaults
   end
 
   ##
@@ -107,7 +105,7 @@ module Blacklight::ConfigurationHelperBehavior
   #   @param [Symbol] any number of additional keys
   #   @param [Symbol] ...
   def solr_field_label *i18n_keys
-    first, *rest = i18n_keys
+    first, *rest = i18n_keys.compact
 
     t(first, default: rest)
   end

data/app/models/bookmark.rb

@@ -5,7 +5,10 @@ class Bookmark < ActiveRecord::Base
   belongs_to :document, polymorphic: true
 
   validates_presence_of :user_id, :scope=>:document_id
-  attr_accessible :id, :document_id, :document_type, :title if Rails::VERSION::MAJOR < 4
+
+  if Blacklight::Utils.needs_attr_accessible?
+    attr_accessible :id, :document_id, :document_type, :title
+  end
 
   def document
     document_type.new document_type.unique_key => document_id

data/app/models/search.rb

@@ -5,10 +5,13 @@ class Search < ActiveRecord::Base
 
   serialize :query_params
 
-  if Rails::VERSION::MAJOR < 4
+  if Blacklight::Utils.needs_attr_accessible?
     attr_accessible :query_params 
-  
-    scope :none, where(:id => nil).where("id IS NOT ?", nil)
+  end
+
+  unless respond_to?(:none)
+    # polyfill
+    scope :none, where(id: nil).where("id IS NOT ?", nil)
   end
 
   # A Search instance is considered a saved search if it has a user_id.

data/app/views/catalog/_home_text.html.erb

@@ -1,9 +1,49 @@
-<h4><%= t('blacklight.welcome') %></h4>
-<p>&nbsp;</p>
-<p>To modify this text to your specifications, copy this file located in the blacklight plugin directory:<br/>
-&nbsp;&nbsp;&nbsp;<%= Blacklight.root %>/app/views/catalog/_home_text.html.erb</p>
-<p>to your top level rails app:<br/>
-&nbsp;&nbsp;&nbsp;<%= Rails.root %>/app/views/catalog/_home_text.html.erb</p>
-<p>Note that you will need to create the 'catalog' directory under views.</p>
-<% #Creates a bit space in the page -%>
+<div class="page-header row">
+  <h1 class="col-md-8"><%= t('blacklight.welcome') %></h1>
+  
+  <ul class="nav nav-pills col-md-4">
+    <li><a href="https://github.com/projectblacklight/blacklight/">Github</a></li>
+    <li><a href="https://github.com/projectblacklight/blacklight/wiki">Wiki</a></li>
+    <li><a href="https://github.com/projectblacklight/blacklight/releases/tag/v<%= Blacklight::VERSION %>">Release Notes</a></li>
+  </ul>
 
+
+</div>
+
+<div id="getting-started">
+  <h2>Here&rsquo;s how to get started:</h2>
+  
+  <ol>
+    <li>To modify this text, you need to <a href="http://guides.rubyonrails.org/engines.html#improving-engine-functionality">override the Blacklight-provided view</a>.
+You can copy this file, located in the blacklight gem: <br />
+<%= Blacklight.root %>/app/views/catalog/_home_text.html.erb <br />
+to your own application: <br />
+ <%= Rails.root %>/app/views/catalog/_home_text.html.erb 
+    </li>
+    <li><a href="https://github.com/projectblacklight/blacklight/wiki/Indexing-your-data-into-solr">Index your own data</a> into Solr</li>
+    <li><a href="https://github.com/projectblacklight/blacklight/wiki#blacklight-configuration">Configure Blacklight</a> to match your data and user-experience needs</li>
+    <li><a href="https://github.com/projectblacklight/blacklight/wiki#support">Get in touch</a> with your comments, questions, and ideas</li>
+  </ol>
+</div>
+
+<%# This is the same panel shown in the Rails welcome template %>
+<div id="about">
+  <h3><a href="/rails/info/properties">About your application&rsquo;s environment</a></h3>
+  <div id="about-content" class="well" style="display: none"></div>
+</div>
+
+<script>
+  $(function() {
+    $('#about a').on('click', function(e) {
+      e.preventDefault();
+
+      if ($('#about-content').html() == "") {
+        $('#about-content').load($(this).attr("href"), function() {
+          $('#about-content').show();
+        });
+      } else {
+        $('#about-content').toggle();
+      }
+    });
+  });
+</script>

data/app/views/catalog/_sms_form.html.erb

@@ -19,7 +19,7 @@
 
     </div>
     <% @documents.each do |doc| %>
-       <%=hidden_field_tag "id[]", doc.get(:id)%>
+       <%=hidden_field_tag "id[]", doc.id %>
     <% end %>
 </div>
 <div class="modal-footer">

data/blacklight.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency "capybara"
   s.add_development_dependency "poltergeist"
-  s.add_development_dependency 'engine_cart', ">= 0.1.0"
+  s.add_development_dependency 'engine_cart', ">= 0.6.0"
   s.add_development_dependency "equivalent-xml"
 end

data/config/jetty.yml

@@ -1,10 +1,13 @@
 development:
   startup_wait: 15
   jetty_port: 8983 
+  java_version: ">= 1.7"
 test:
   startup_wait: 60
   jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8888 %> 
   <%= ENV['TEST_JETTY_PATH'] ? "jetty_home: " + ENV['TEST_JETTY_PATH'] : '' %>
+  java_version: ">= 1.7"
 production:
   startup_wait: 15
   jetty_port: 8983
+  java_version: ">= 1.7"

data/doc/Adding-new-document-actions.md

@@ -0,0 +1,94 @@
+In your `CatalogController`, you can register document actions that display in various places within the default Blacklight UI:
+
+- `add_show_tools_partial`: displays on the `catalog#show` page, using the `render_show_doc_actions` helper
+- `add_results_document_tool`: displays on every search result, using the `render_index_doc_actions` helper
+- `add_results_collection_tool`: displays at the top of a search result page, using the `render_results_collection_tools` helper
+- `add_nav_action`: displays in the top application navbar, using the `render_nav_actions` helper
+
+All types of actions take the same parameters, e.g.:
+
+```ruby
+      ##
+      # Add a partial to the tools for rendering a document
+      # @param partial [String] the name of the document partial
+      # @param opts [Hash]
+      # @option opts [String] :partial render this action using the provided partial
+      # @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true.
+      #                             The proc will receive the action configuration and the document or documents for the action.
+      # @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true
+      #                             The proc will receive the action configuration and the document or documents for the action.
+      def add_show_tools_partial name, opts = {}
+```
+
+Examples:
+
+```
+class CatalogController
+  ...
+
+  # only show patron information if a user is logged in. Note that `current_user?` has to be defined as a helper method
+  add_nav_action :patron_information, if: :current_user?
+
+  # In Rails 4+, this can also be defined using an inline proc:
+  add_nav_action :patron_information, if: Proc.new { |context, config, options| context.current_user? }
+
+  # Actions can also trigger based on properties of the document:
+  add_show_tools_partial :download_image_widget, if: Proc.new { |context, config, options| options[:document].image? }
+ 
+  ...
+end
+```
+
+
+## Show Tools
+You can register an action that displays on the document show page using the `add_show_tools_partial` controller method. In addition to the functionality offered by the other types of tools and actions, show tools also offer conventional defaults.
+
+Here is a trivial example of registering a new type of action:
+
+```ruby
+# app/controllers/catalog_controller.rb
+class CatalogController
+   add_show_tools_partial :my_custom_action
+
+  ## OPTIONAL
+  # def my_custom_action
+  #   # render some content..
+  #   # by default, Blacklight will try to render the partial of the same name (i.e. `app/views/catalog/my_custom_action.html.erb`)
+  # end
+end
+
+# config/routes
+Rails.application.routes.draw do
+   ...
+  get '/catalog/:id/my_custom_action' => 'catalog#my_custom_action', as: 'my_custom_action_catalog'
+end
+```
+
+
+If the action will receive form data from a `POST` request, you can also register a callback for handling that request. Optionally, the `POST` params can be validated using a helper method.
+
+```ruby
+class CatalogController
+  include Blacklight::Catalog
+  ...
+
+  # Register a new action called "email".
+  # On a POST request, validate the params using the `#validate_email_params` method
+  # and process the request using `#email_action`.
+  add_show_tools_partial :email, callback: :email_action, validator: :validate_email_params
+
+  def validate_email_params
+    # validate that the posted params are suitable for the action
+  end
+
+  def email_action documents
+    # send an email with the attached documents
+  end
+ 
+  ...
+end
+```
+
+By convention, the action name is used to determine the route name for the action. For this email action, Blacklight will link to `email_catalog_path`.
+
+The action will render the template [`catalog/email.html.erb`](https://github.com/projectblacklight/blacklight/blob/master/app/views/catalog/email.html.erb) template when the action is selected. This template provides a form, which, when submitted, will trigger the `email_action` method and will render the [`catalog/email_success.html.erb`](https://github.com/projectblacklight/blacklight/blob/master/app/views/catalog/email_success.html.erb) template. 

data/doc/Atom-Responses.md

@@ -0,0 +1,90 @@
+Blacklight will provide atom responses for all catalog/index results. Just add ".atom" on to the end of your path component, `/catalog.atom`, or `/catalog/index.atom`. 
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" xmlns="http://www.w3.org/2005/Atom">
+  <title>Blacklight Search Results</title>
+  <author>
+    <name>Blacklight</name>
+  </author>
+  <link href="http://demo.projectblacklight.org/?commit=search&amp;amp;format=atom&amp;amp;q=urdu&amp;amp;search_field=all_fields" rel="self"/>
+  <link href="http://demo.projectblacklight.org/?commit=search&amp;amp;format=html&amp;amp;q=urdu&amp;amp;search_field=all_fields" rel="alternate" type="text/html"/>
+  <id>http://demo.projectblacklight.org/?commit=search&amp;amp;format=html&amp;amp;q=urdu&amp;amp;search_field=all_fields&amp;amp;type=text%2Fhtml</id>
+  <link href="http://demo.projectblacklight.org/?commit=search&amp;amp;format=atom&amp;amp;page=2&amp;amp;q=urdu&amp;amp;search_field=all_fields" rel="next"/>
+  <link href="http://demo.projectblacklight.org/?commit=search&amp;amp;format=atom&amp;amp;page=1&amp;amp;q=urdu&amp;amp;search_field=all_fields" rel="first"/>
+  <link href="http://demo.projectblacklight.org/?commit=search&amp;amp;format=atom&amp;amp;page=15&amp;amp;q=urdu&amp;amp;search_field=all_fields" rel="last"/>
+  <link href="http://demo.projectblacklight.org/catalog/opensearch.xml" rel="search" type="application/opensearchdescription+xml"/>
+  <opensearch:totalResults>147</opensearch:totalResults>
+  <opensearch:startIndex>0</opensearch:startIndex>
+  <opensearch:itemsPerPage>10</opensearch:itemsPerPage>
+  <opensearch:Query searchTerms="urdu" startPage="1" role="request"/>
+  <updated>2011-05-11T17:46:58Z</updated>
+  <entry>
+    <title>Urdu&#772; d&#803;ra&#772;ma&#772;</title>
+    <updated>2011-05-11T17:46:58Z</updated>
+    <link href="http://demo.projectblacklight.org/catalog/2008306442" rel="alternate" type="text/html"/>
+<link href="http://demo.projectblacklight.org/catalog/2008306442.dc_xml" rel="alternate" title="dc_xml" type="text/xml" />
+<link href="http://demo.projectblacklight.org/catalog/2008306442.xml" rel="alternate" title="xml" type="application/xml" />
+    <id>http://demo.projectblacklight.org/catalog/2008306442</id>
+    <author>
+      <name>Farg&#818;h&#818;a&#772;nah, 1979-</name>
+    </author>
+    <summary type="html">
+&lt;dl class="defList"&gt;
+  
+      
+        &lt;dt class="blacklight-title_display"&gt;Title:&lt;/dt&gt;
+        &lt;dd class="blacklight-title_display"&gt;Urdu&#772; d&#803;ra&#772;ma&#772;&lt;/dd&gt;
+                
+        &lt;dt class="blacklight-author_display"&gt;Author:&lt;/dt&gt;
+        &lt;dd class="blacklight-author_display"&gt;Farg&#818;h&#818;a&#772;nah, 1979-&lt;/dd&gt;
+                
+        
+<!-- [...] -->
+&lt;/dl&gt;
+    </summary>
+  </entry>
+<!-- [...] -->
+</feed>
+```
+
+
+The same HTML summary included in your HTML results pages are included as an `atom:summary` element -- the atom template uses the `[[#render_document_partial|https://github.com/projectblacklight/blacklight/blob/master/app/helpers/blacklight/blacklight_helper_behavior.rb#L203]]` helper method to generate this HTML summary, so if you've over-ridden that for your app, it will be used as the  `atom:summary` content instead.
+
+## API Usage
+The Atom response is intended to be pretty full of data, so it can fill many traditional API requests.  It makes use of every relevant atom or [[OpenSearch|http://www.opensearch.org/Home]] element that could be conveniently included. 
+
+The Atom response also supports arbitrary format representations in the `atom:content` element.  You can include `&content_format=some_format` in your request URL (e.g. `[[/catalog.atom?content_format=oai_dc_xml|http://demo.projectblacklight.org/catalog.atom?q=urdu&content_format=oai_dc_xml]]`). Any format a given document can be exported as using the [[Blacklight document framework|Extending-blacklight-with-the-document-extension-framework]]  is available. Not every document can export in every format -- if a format is requested one or more of the items in your atom result can not export as, it will not have an `atom:content` element.  Non-XML-based formats are supported, as the content is Base64-encoded (as per Atom spec, unless the format is `text/plain`). 
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" xmlns="http://www.w3.org/2005/Atom">
+  <title>Blacklight Search Results</title>
+  <author>
+    <name>Blacklight</name>
+  </author>
+  <link href="http://demo.projectblacklight.org/?content_format=oai_dc_xml&amp;amp;format=atom&amp;amp;per_page=1" rel="self"/>
+<!-- [...] -->
+  <entry>
+    <title>The book of the dance in the 20th century selections from the Jane Bourne Parton collection of books on the dance</title>
+    <updated>2011-05-11T17:59:32Z</updated>
+    <link href="http://demo.projectblacklight.org/catalog/u1" rel="alternate" type="text/html"/>
+<link href="http://demo.projectblacklight.org/catalog/u1.dc_xml" rel="alternate" title="dc_xml" type="text/xml" />
+<link href="http://demo.projectblacklight.org/catalog/u1.xml" rel="alternate" title="xml" type="application/xml" />
+    <id>http://demo.projectblacklight.org/catalog/u1</id>
+    <author>
+      <name>Roatcap, Adela Spindler</name>
+    </author>
+    <summary type="html">
+<!-- [...] -->
+    </summary>
+<!-- [ Here is the export format as OAI Dublin Core XML ] -->
+    <content type="text/xml">
+<oai_dc:dc xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><dc:language>English</dc:language><dc:title>The book of the dance in the 20th century selections from the Jane Bourne Parton collection of books on the dance</dc:title><dc:format>Book</dc:format></oai_dc:dc>    </content>
+  </entry>
+</feed>
+```
+
+This means that if you add on a document extension that provides more export formats for some or all of your documents, that will automatically be available in the atom response. 
+
+If you choose to use the [[Blacklight CQL add-on|https://github.com/projectblacklight/blacklight_cql]], the combination of [[CQL|http://www.loc.gov/standards/sru/specs/cql.html]]  requests and Atom responses provides a pretty good more-or-less standards-based API to search results through Blacklight. 
+
+The Atom response generating template is at `app/views/catalog/index.builder.atom`.

data/doc/Blacklight-Add-ons.md

@@ -0,0 +1,23 @@
+## Stable Add-ons
+
+A few add-ons are are more or less 'officially supported', and all Blacklight developers have commit rights on them. (although some may not have received attention in a while if developers have been busy. Feel free to ask on the list for current status):
+
+* [Advanced search](https://github.com/projectblacklight/blacklight_advanced_search)
+* [CQL search](https://github.com/projectblacklight/blacklight_cql)
+* [Date range limit](https://github.com/projectblacklight/blacklight_range_limit).  
+
+## In development
+* [Blacklight Gallery](https://github.com/projectblacklight/blacklight-gallery)
+* [Blacklight Maps](https://github.com/sul-dlss/blacklight-maps)
+* [Spotlight](https://github.com/sul-dlss/spotlight) Curated digital collections
+* [blacklight-oembed](https://github.com/sul-dlss/blacklight-oembed) Embedding oEmbed resources in search results
+* [GeoBlacklight](https://github.com/geoblacklight/geoblacklight) Discovery and access for geospatial data
+
+## Unstable/Experimental
+
+* [[Blacklight Sitemap Generator|https://github.com/jronallo/blacklight-sitemap]]: Rake task for generating sitemaps.
+* [[Blacklight OAI provider|https://github.com/cbeer/blacklight_oai_provider]]: Adds an [[OAI-PMH|http://www.openarchives.org/pmh/]] provider using the [[oai|http://rubygems.org/gems/oai]] gem for harvesting records within Blacklight.
+* [[Blacklight unAPI|https://github.com/cbeer/blacklight_unapi]]: Adds an [[unAPI|http://unapi.info]] endpoint for records within Blacklight.
+* [[Blacklight User Generated Content|https://github.com/cbeer/blacklight_user_generated_content]]: Adds user generated content to SolrDocument objects using acts_as_commentable, acts_as_taggable and acts_as_rateable directly against a SolrDocument object. 
+* [[Blacklight oEmbed|https://github.com/cbeer/blacklight_oembed]]: [[oEmbed|http://oembed.com]] endpoint that provides framework for allowing third-party sites (Wordpress, Facebook, etc) to embed content given a URL. 
+* [[Blacklight Google Analytics|https://github.com/jronallo/blacklight_google_analytics]]: Quick start for setting up Google Analytics for a Blacklight site, including Event Tracking of Blacklight-specific page elements like facets.

data/doc/Blacklight-configuration.md

@@ -0,0 +1,411 @@
+# Configuring Blacklight to work with your Solr index
+
+In order to fully understand this section, you should be familiar with Solr, ways to index data into Solr, how to configure request handlers, and how to change a Solr schema.  Those topics are covered in the official [Apache Solr Tutorial](http://lucene.apache.org/solr/tutorial.html).
+
+The Blacklight example configuration is a (simplified) way to work with library data (in the MARC format), it is (hopefully) easy to reconfigure to work with your Solr index. In this section, we will describe most of the Blacklight configuration settings that determine how the Blacklight interface works with your data. Later sections demonstrate how to modify the Blacklight user experience and templates, etc.
+
+> Note: In most of this section, we will show how to configure Blacklight to request data from Solr. While this works, and makes it easy to rapidly develop an application, we recommend eventually configuring your Apache Solr request handlers to do this instead.
+
+
+## Connecting to Solr: config/solr.yml
+
+Your Blacklight-based application will interact with your Solr index. Although Blacklight does distribute a sample jetty-based Solr instance, you will likely want to connect Blacklight to your own Solr index. The Solr index to use is specified in a configuration file, ```config/solr.yml```. If you open this file in a recently generated Blacklight application, you’ll see a default solr configured to use a single-core Solr running under jetty:
+
+```yaml
+development:
+  url: http://127.0.0.1:8983/solr
+
+test:
+  url: http://127.0.0.1:8888/solr
+```
+
+When you run your Rails application in the ```development``` environment, it will try to connect to Solr at ```http://127.0.0.1:8983/solr```, and, likewise, in ```test```, it will try to connect to Solr at ```http://127.0.0.1:8888/solr```. 
+
+This URL should point to the base path of your Solr application, and includes e.g. Solr core names (see below), but not request handler paths, etc.
+
+Blacklight uses the RSolr gem to talk to Solr. The parameters are passed to [RSolr.connect](http://rubydoc.info/gems/rsolr/1.0.6/RSolr.connect).
+
+### Using Blacklight with a Multicore Solr
+
+Here's an example of using a Multi-core Solr install with Blacklight:
+
+```yaml
+development:
+  url: http://127.0.0.1:8983/solr/development-core
+test:
+  url: http://127.0.0.1:8983/solr/test-core
+```
+
+### Running and Monitoring Solr with Foreman
+
+You can use [foreman](http://blog.daviddollar.org/2011/05/06/introducing-foreman.html) to start up and monitor the blacklight rails app and the solr server. Here is an example Procfile:
+
+    web: bundle exec rails s -p $PORT
+    solr: bash -c "cd ./jetty; java -jar -Djetty.port=$PORT start.jar"
+
+## Blacklight Configuration
+
+Now that you've connected to Solr, you probably want to configure Blacklight to display your Solr fields in the search results and facets, and also use your fields for search fields, sort options. This configuration goes in your CatalogController.  By convention, this is in your Rails application, and is located at [```app/controllers/catalog_controller.rb```](https://github.com/projectblacklight/blacklight/blob/master/lib/generators/blacklight/templates/catalog_controller.rb).
+
+The CatalogController includes functionality and templates for searching and displaying documents. The CatalogController needs to be configured so it knows about your Solr fields.
+
+> NOTE: While most applications use only a single controller for search, it is possible to have multiple controllers with different configurations. This documentation will only discuss the simple case.
+
+### default_solr_params
+
+The default_solr_params are parameters that will be sent to the Solr API on all search-like requests:
+
+```ruby
+    config.default_solr_params = { 
+      :qt => 'search',
+      :rows => 10 
+    }
+```
+
+This configuration would send the following for any request to solr:
+
+```
+http://localhost:8983/solr/select?qt=search&rows=10
+```
+
+While the default_solr_params are useful for rapid development, they are often moved into the Solr request handler for production deployments.
+
+A counter-part to default_solr_params is default_document_solr_params, which is sent when requesting only a single document from solr. In the Blacklight example solrconfig.xml, there is a `document` requestHandler to retrieve a single document at a time. We encourage you to adopt pattern as well, but with an existing Solr installation adding a single document requestHandler may not be an option. Instead, you can modify the `default_document_solr_params` to configure the appropriate defaults:
+
+```ruby
+    # See SolrHelper#solr_doc_params
+    config.default_document_solr_params = {
+      :qt => 'document',
+      ## These are hard-coded in the blacklight 'document' requestHandler
+      # :fl => '*',
+      # :rows => 1
+      # :q => '{!raw f=id v=$id}' 
+    }
+```
+
+Blacklight will add a query parameter called `id` containing the unique key for your document. It can be referenced as a Solr local parameter (as above) in your queries.
+
+
+### Results views (index and show)
+
+
+You can configure the fields and labels that are display for search results on the search and document views.
+
+> Note: these must be STORED fields in the Solr index, and must be returned in the solr response or they will not be displayed.
+
+There's a set of configuration parameters for the title and Blacklight template handling (discussed elsewhere):
+
+```ruby
+    # solr field configuration for search results/index views
+    config.index.show_link = 'title_display'
+    config.index.record_display_type = 'format'
+
+    # solr field configuration for document/show views
+    config.show.html_title = 'title_display'
+    config.show.heading = 'title_display'
+    config.show.display_type = 'format'
+```
+
+This configuration will use the ```title_display``` Solr field as the link text for each document.
+
+There's a separate section for the additional fields to display:
+
+```ruby
+    # [from app/controllers/catalog_controller.rb]
+    # solr fields to be displayed in the index (search results) view
+    #   The ordering of the field names is the order of the display 
+    config.add_index_field 'title_display', :label => 'Title:' 
+    config.add_index_field 'title_vern_display', :label => 'Title:' 
+    config.add_index_field 'author_display', :label => 'Author:' 
+    config.add_index_field 'author_vern_display', :label => 'Author:'    
+
+    # ...
+    # And likewise for the show (single-document) view:
+
+    config.add_show_field 'title_display', :label => 'Title:' 
+    config.add_show_field 'title_vern_display', :label => 'Title:' 
+    config.add_show_field 'subtitle_display', :label => 'Subtitle:'
+```
+
+[[https://github.com/projectblacklight/projectblacklight.github.com/raw/master/images/index_fields.png|frame|alt=Index Fields]]
+
+#### Linking a value to a facet search
+
+When rendering the format value in the search results, link the value to a facet search for that value:
+
+```ruby
+config.add_index_field 'format', :label => 'Format:', :link_to_search => true
+```
+
+Or specify the field to facet against, explicitly:
+```ruby
+config.add_index_field 'author_display', :label => 'Author:', :link_to_search => :author_facet
+```
+
+More advanced configuration should use a custom helper method (see below) to render an appropriate value.
+
+#### Using a helper method to render the value
+
+You can use view helpers to render the Solr values, e.g.:
+
+```ruby
+    config.add_index_field 'title_vern_display', :label => 'Title:', :helper_method => :my_helper_method
+```
+
+When Blacklight goes to display the 'title_vern_display' field, it will call ```my_helper_method``` to get the value to display. You can implement any logic you want to manipulate the solr document to return the value to display.
+
+```ruby
+module ApplicationHelper
+  def my_helper_method args
+    args[:document][args[:field]].upcase
+  end
+end
+```
+
+Your helper method receives hash with (at least) two parameters:
+
+ - :document => the SolrDocument object
+ - :field => the solr field to display
+
+
+#### Solr hit highlighting 
+
+You can trigger automatic Solr hit highlighting of results:
+
+```ruby
+    config.add_index_field 'title_vern_display', :label => 'Title:', :highlight => true
+```
+
+This will cause Blacklight to look at the Solr highlight component response for the value of this field. This assumes you've configured the highlighting component elsewhere. The [Solr Highlighting Parameters](http://wiki.apache.org/solr/HighlightingParameters) documentation discusses the Solr parameters available to you. You could add these to your default_solr_params, request handler configuration, or elsewhere.
+
+You can have Blacklight send the most basic highlighting parameters for you, if you set:
+
+```ruby
+  config.add_field_configuration_to_solr_request!
+```
+
+This will enable the highlighting component and send 'hl.fl' parameters for the fields you wanted highlighted, but you will likely want to tweak this behavior further.
+
+### Facet fields
+
+Faceted search allows users to constrain searches by controlled vocabulary items
+[[https://github.com/projectblacklight/projectblacklight.github.com/raw/master/images/search_facets.png|frame|alt=Search facets in action]]
+Note that these must be INDEXED fields in the Solr index, and are generally a single token (e.g. a string).
+
+```ruby
+    # [from app/controllers/catalog_controller.rb]
+    # solr fields that will be treated as facets by the blacklight application
+    #   The ordering of the field names is the order of the display
+    config.add_facet_field 'format', :label => 'Format' 
+    config.add_facet_field 'pub_date', :label => 'Publication Year' 
+    config.add_facet_field 'subject_topic_facet', :label => 'Topic', :limit => 20 
+    config.add_facet_field 'language_facet', :label => 'Language', :limit => true 
+```
+
+### Facet View Helpers [v.4.2.0+]
+
+You can supply a :helper_method argument to configure what you would like displayed for the facet's text, e.g:
+
+```ruby
+    config.add_facet_field 'format', :label => 'Format', :helper_method => :my_helper_method
+```
+
+With the above code Blacklight will pass the facet's value into the given helper method, with which you can do anything you'd like.
+
+```ruby
+module ApplicationHelper
+  def my_helper_method value
+    value.upcase
+  end
+end
+```
+### Facet Queries
+Blacklight also supports Solr facet queries:
+
+[[https://github.com/projectblacklight/projectblacklight.github.com/raw/master/images/query_facets.png|frame|alt=Query facets in action]]
+
+```ruby
+    config.add_facet_field 'pub_date_query', :label => 'Publication Year', :query => {
+      :last_5_years => { :label => 'Last 5 Years', :fq => "[#{Time.now.year-5} TO *]"}
+    } 
+```
+
+The first argument (which maps to the facet field for plain facets) is used in the Blacklight URL when the facet is selected.
+
+The :query hash maps a key to use in Blacklight URLs to a facet :label (used in the facet display) and an :fq to send to Solr as the `facet.query` and (if selected) the Solr `fq` parameter.
+
+You can also tell Solr how to sort facets (either by [count or index](http://wiki.apache.org/solr/SimpleFacetParameters#facet.sort)):
+If your data is strings, you can use this to perform an alphabetical sort of the facets.
+```ruby
+   config.add_facet_field :my_count_sorted_field, :sort => 'count'
+   config.add_facet_field :my_index_sorted_field, :sort => 'index'
+```
+
+
+If you want Solr to add the configured facets and facet queries to the Solr query it sends, you should also add:
+
+```ruby
+    config.add_facet_fields_to_solr_request!  # deprecated: use add_facet_field :include_in_request instead
+```
+
+### Date-based facets
+
+If you have date facets in Solr, you should add a hint to the Blacklight configuration:
+
+```ruby
+   config.add_facet_field :my_date_field, :date => true
+```
+
+This will trigger special date querying logic, and also use a localized date format when displaying the facet value. If you want to use a particular localization format, you can provide that as well:
+
+```ruby
+   config.add_facet_field :my_date_field, :date => { :format => :short }
+```
+
+### Tagging/Exclusion facets
+
+From the solr docs:
+
+> One can tag specific filters and exclude those filters when faceting. This is generally needed when doing multi-select faceting. [...]To implement a multi-select facet for doctype, a GUI may want to still display the other doctype values and their associated counts, as if the doctype:pdf constraint had not yet been applied. 
+>
+> Example:
+>
+> === Document Type ===
+>
+>  [ ] Word (42)
+>
+>  [x] PDF  (96)
+>
+>  [ ] Excel(11)
+>
+>  [ ] HTML (63)
+
+To configure this behavior in Blacklight, 
+
+```ruby
+   config.add_facet_field :document_type_facet, :tag => 'some-tag', :ex => 'some-tag'
+```
+
+### search fields
+
+Search queries can be targeted at configurable fields (or sets of fields) to return precise search results. Advanced search capabilities are provided through the [[Advanced Search Add-On|https://github.com/projectblacklight/blacklight_advanced_search]] 
+[[https://github.com/projectblacklight/projectblacklight.github.com/raw/master/images/search_fields.png|frame|alt=Search fields in action]]
+
+```ruby
+    # [from app/controllers/catalog_controller.rb]
+    # Now we see how to over-ride Solr request handler defaults, in this
+    # case for a BL "search field", which is really a dismax aggregate
+    # of Solr search fields. 
+    
+    config.add_search_field('title') do |field|
+      # solr_parameters hash are sent to Solr as ordinary url query params. 
+      field.solr_parameters = { :'spellcheck.dictionary' => 'title' }
+
+      # :solr_local_parameters will be sent using Solr LocalParams
+      # syntax, as eg {! qf=$title_qf }. This is neccesary to use
+      # Solr parameter de-referencing like $title_qf.
+      # See: http://wiki.apache.org/solr/LocalParams
+      field.solr_local_parameters = { 
+        :qf => '$title_qf',
+        :pf => '$title_pf'
+      }
+    end
+```
+
+### sort fields
+
+```ruby
+    config.add_sort_field 'score desc, pub_date_sort desc, title_sort asc', :label => 'relevance'
+    config.add_sort_field 'pub_date_sort desc, title_sort asc', :label => 'year'
+    config.add_sort_field 'author_sort asc, title_sort asc', :label => 'author'
+    config.add_sort_field 'title_sort asc, pub_date_sort desc', :label => 'title'
+```
+
+[[https://github.com/projectblacklight/projectblacklight.github.com/raw/master/images/sort_fields.png|frame|alt=Sort fields in action]]
+
+> TODO
+
+## Solr Document
+
+
+By default, Blacklight assumes the unique key field in your solr index is called `id`. You can change this by editing `app/models/solr_document.rb`:
+
+```ruby
+class SolrDocument
+  include Blacklight::Solr::Document
+
+  # self.unique_key = 'id'
+  ...
+end
+```
+
+If, for instance, your unique key field was 'uuid_s', this would read:
+
+```ruby
+class SolrDocument
+  include Blacklight::Solr::Document
+
+  self.unique_key = 'uuid_s'
+  ...
+end
+```
+
+This will instruct Blacklight to use your ```uuid_s``` field any time it needs an identifier for the document, e.g. when constructing document URLs. 
+
+Also in SolrDocument is a set of "field semantics", which may be used in some basic metadata mapping:
+
+```ruby
+class SolrDocument
+  ...
+
+ field_semantics.merge!(    
+                         :title => "title_display",
+                         :author => "author_display",
+                         :language => "language_facet",
+                         :format => "format"
+                         )
+end
+```
+
+### Field Collapsing
+
+Blacklight 4.4 adds support for Solr Field Collapsing (aka results grouping). The initial implementation requires you to explicitly configure your solr request handler (or default solr parameters) to enable grouping. 
+
+Here are some solr request parameters to enable grouping on our demo index:
+
+```
+      :group => true,
+      :'group.field' => 'pub_date_sort',
+      :'group.ngroups' => true, # group.ngroups is REQUIRED.
+      :'group.limit' => 3
+```
+
+If you only define a single group.field, Blacklight will detect the grouped response and use it. If there are multiple fields defined, you have to configure Blacklight to detect the correct field, e.g.:
+
+```
+    config.index.group = "pub_date_sort"
+```
+
+### Thumbnails in results display
+
+Blacklight 4.4+ can render a representative thumbnail with a result on the search index page. 
+
+Blacklight can pull a URL to the thumbnail from a field in Solr:
+
+```ruby
+  configure_blacklight do |config|
+    config.index.thumbnail_field = :some_field_in_the_document
+  end
+```
+ 
+Or using custom logic in a helper method of your own creation:
+
+```ruby
+  configure_blacklight do |config|
+    config.index.thumbnail_method = :xyz
+  end
+```
+
+With this configuration, the helper method `xyz` will be called with the `SolrDocument` document and a hash of caller-supplied image options.
+
+Given that configuration, Blacklight will render a thumbnail (by default, right aligned, under the bookmark button) as a link to the document page. If no thumbnail is available (missing data in solr, the thumbnail method returned nil), the thumbnail block is not displayed at all.