blacklight 4.6.3 → 4.7.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5982a2428034dae378c31791d1d9d4a2cfcdd02d
-  data.tar.gz: dbe8685099072975e318962fd879410db0bec8f4
+  metadata.gz: 4813599bbaa8851d1b75d07b6633d4abf29ea757
+  data.tar.gz: 03def0b743980084a3ccab15df138b171723fe75
 SHA512:
-  metadata.gz: 49c5477a3ee2d0e5418a9cd4b1cad1683864398373be03b267a7896c4e8c6f850218163a98e6f0e4faf039bacdbef5ebf5782b23a06e29257780b83af685ce64
-  data.tar.gz: cee3f4ff93d8301b3e30e4fd8fc784486eaae15b47c209258b50c3d1b86adf53ccd7bd64ebae4233261f5c793312925164c43f8c9262c24fcecf81b1064b6592
+  metadata.gz: 492ed7e40e8b99aa34bff4a09caec3569b7d2daaf050c6f4f87159a2489cf7f045830feb4fc2518bd598e00c14dda14be1c838b36c0b7ed2fb10386a21bf894e
+  data.tar.gz: d1104e397c0a860d8cea7301afaf9658dc98825ba3518576058867179253344fd54455070fd234b7c38824bf03c6911bb05ab7768737a5d2e817e75bfabb860d

data/VERSION

@@ -1 +1 @@
-4.6.3
+4.7.0.pre1

data/app/controllers/bookmarks_controller.rb

@@ -97,4 +97,8 @@ class BookmarksController < CatalogController
   def verify_user
     flash[:notice] = I18n.t('blacklight.bookmarks.need_login') and raise Blacklight::Exceptions::AccessDenied  unless current_or_guest_user
   end
+
+  def start_new_search_session?
+    action_name == "index"
+  end
 end

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -140,8 +140,8 @@ module Blacklight::BlacklightHelperBehavior
     Hash[*index_fields(document).map { |key, field| [key, field.label] }.flatten]
   end
 
-  def spell_check_max
-    blacklight_config.spell_max
+  def should_show_spellcheck_suggestions? response
+    response.total <= spell_check_max and response.spelling.words.size > 0
   end
 
   ##
@@ -162,7 +162,7 @@ module Blacklight::BlacklightHelperBehavior
     document = args.first
 
     field = options[:field]
-    html_escape index_fields(document)[field].label
+    html_escape t(:'blacklight.search.index.label', label: index_fields(document)[field].label)
   end
 
   ##
@@ -236,6 +236,7 @@ module Blacklight::BlacklightHelperBehavior
 
   # Used in citation view for displaying the title
   def citation_title(document)
+    Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#citation_title is deprecated; use #document_heading instead")
     document[blacklight_config.show.html_title]
   end
 
@@ -287,7 +288,7 @@ module Blacklight::BlacklightHelperBehavior
 
     field = options[:field]
 
-    html_escape document_show_fields(document)[field].label
+    html_escape t(:'blacklight.search.show.label', label: document_show_fields(document)[field].label)
   end
 
   ##
@@ -451,7 +452,7 @@ module Blacklight::BlacklightHelperBehavior
 
   # Search History and Saved Searches display
   def link_to_previous_search(params)
-    link_to(raw(render_search_to_s(params)), catalog_index_path(params)).html_safe
+    link_to(render_search_to_s(params), catalog_index_path(params))
   end
 
   #
@@ -516,15 +517,60 @@ module Blacklight::BlacklightHelperBehavior
     link_to opts[:label], link_url
   end
 
-  def params_for_search(options={})
-    # special keys
-    # params hash to mutate
-    source_params = options.delete(:params) || params
-    omit_keys = options.delete(:omit_keys) || []
+  # @overload params_for_search(source_params, params_to_merge)
+  #   Merge the source params with the params_to_merge hash
+  #   @param [Hash] Hash 
+  #   @param [Hash] Hash to merge into above
+  # @overload params_for_search(params_to_merge)
+  #   Merge the current search parameters with the 
+  #      parameters provided. 
+  #   @param [Hash] Hash to merge into the parameters
+  # @overload params_for_search
+  #   Returns the current search parameters after being sanitized by #sanitize_search_params
+  # @overload legacy_method
+  #   @params [Hash] Hash of params to merge, may include:
+  #      - :omit_keys
+  #      - :params
+  # @yield [params] The merged parameters hash before being sanitized
+  def params_for_search(*args, &block)
+
+    omit_keys = []
+    
+    source_params, params_to_merge = case args.length
+    when 0
+      [params, {}]
+    when 1
+      options = args.first
+
+      if options.has_key? :omit_keys
+        Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#params_for_search with :omit_keys is deprecated; use params_for_search to generate the hash, and either provide a block or clean up the params after the fact")
+        omit_keys = options.delete(:omit_keys)
+      end
+
+      if options.has_key? :params
+        Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#params_for_search with :params option is deprecated; use the 2-arg form of #params_for_search(params, params_to_merge)")
+      end
+
+      [options.delete(:params) || params, options]
+    when 2
+      options = args.last
+
+      if options.has_key? :omit_keys
+        Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#params_for_search with :omit_keys is deprecated; use params_for_search to generate the hash, and either provide a block or clean up the params after the fact")
+        omit_keys = options.delete(:omit_keys)
+      end
+
+      [args.first, options]
+    else
+      raise ArgumentError.new "wrong number of arguments (#{args.length} for 0..2)"
+    end
 
     # params hash we'll return
-    my_params = source_params.dup.merge(options.dup)
+    my_params = source_params.dup.merge(params_to_merge.dup)
 
+    if block_given?
+      yield my_params
+    end
 
     # remove items from our params hash that match:
     #   - a key
@@ -555,29 +601,34 @@ module Blacklight::BlacklightHelperBehavior
       my_params[:page] = 1
     end
 
-    my_params.reject! { |k,v| v.nil? }
+    sanitize_search_params(my_params)
+  end
+
+  ##
+  # Sanitize the search parameters by removing unnecessary parameters
+  # from the provided parameters
+  # @param [Hash] Hash of parameters
+  def sanitize_search_params source_params
+
+    my_params = source_params.reject { |k,v| v.nil? }
 
-    # removing action, controller, and id from duplicate params so that we don't get hidden fields for them.
-    my_params.delete(:action)
-    my_params.delete(:controller)
-    my_params.delete(:id)
-    # commit is just an artifact of submit button, we don't need it, and
-    # don't want it to pile up with another every time we press submit again!
-    my_params.delete(:commit)
+    my_params.except(:action, :controller, :id, :commit, :utf8)
 
-    my_params
   end
 
+
   # Create form input type=hidden fields representing the entire search context,
   # for inclusion in a form meant to change some aspect of it, like
   # re-sort or change records per page. Can pass in params hash
   # as :params => hash, otherwise defaults to #params. Can pass
   # in certain top-level params keys to _omit_, defaults to :page
   def search_as_hidden_fields(options={})
+    Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#search_as_hidden_fields is deprecated; use render_hash_as_hidden_fields(params_for_search(..)..) instead")
+    
     my_params = params_for_search({:omit_keys => [:page]}.merge(options))
 
     # hash_as_hidden_fields in hash_as_hidden_fields.rb
-    return hash_as_hidden_fields(my_params)
+    return render_hash_as_hidden_fields(my_params)
   end
 
   def link_to_previous_document(previous_document)
@@ -643,4 +694,8 @@ module Blacklight::BlacklightHelperBehavior
     has_user_authentication_provider? and current_or_guest_user.present?
   end
 
+  def spell_check_max
+    blacklight_config.spell_max
+  end
+
 end

data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb

@@ -10,11 +10,13 @@
 # This is used to serialize a complete current query from current params
 # to form fields used for sort and change per-page
 module Blacklight::HashAsHiddenFieldsHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'blacklight 5.0'
 
   # Writes out zero or more <input type="hidden"> elements, completely
   # representing a hash passed in using Rails-style request parameters
   # for hashes nested with arrays and other hashes. 
-  def hash_as_hidden_fields(hash)
+  def render_hash_as_hidden_fields(hash)
     
     hidden_fields = []
     flatten_hash(hash).each do |name, value|
@@ -27,6 +29,11 @@ module Blacklight::HashAsHiddenFieldsHelperBehavior
     hidden_fields.join("\n").html_safe
   end
 
+  def hash_as_hidden_fields *args
+    Deprecation.warn(Blacklight::HashAsHiddenFieldsHelperBehavior, "#hash_as_hidden_fields is deprecated; use #render_hash_as_hidden_fields instead")
+    render_hash_as_hidden_fields *args
+  end
+
   protected
   
   def flatten_hash(hash = params, ancestor_names = [])

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

@@ -1,7 +1,7 @@
 
 <% @documents.each do |document| %>
 
-  <h3><%= citation_title(document) %></h3>
+  <h3><%= Deprecation.silence(Blacklight::BlacklightHelperBehavior) { citation_title(document) } %></h3>
 
 <% if document.respond_to?(:export_as_mla_citation_txt) %>
   <h4><%= t('blacklight.citation.mla') %></h4>

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

@@ -1,4 +1,4 @@
-<% if @response.total <= spell_check_max and @response.spelling.words.size > 0 %>
+<% if should_show_spellcheck_suggestions? @response %>
   <div id="spell">
     <h4 class="suggest"><em><%= t('blacklight.did_you_mean', :options =>  @response.spelling.words.map { |word| link_to_query(word) }.join(" #{t('blacklight.or')} ")).html_safe %></em></h4>
   </div>

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

@@ -1,5 +1,5 @@
   <%= form_tag search_action_url, :method => :get, :class => 'search-query-form form-inline clearfix' do %>
-    <%= search_as_hidden_fields(:omit_keys => [:q, :search_field, :qt, :page]).html_safe %> 
+    <%= render_hash_as_hidden_fields(params_for_search().except(:q, :search_field, :qt, :page, :utf8)) %> 
 
     <% unless search_fields.empty? %>
       <div class="pull-left">

data/blacklight.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
   s.add_dependency "kaminari", "~> 0.13"  # the pagination (page 1,2,3, etc..) of our search results
   s.add_dependency "sass-rails" 
   s.add_dependency "bootstrap-sass", ">= 2.2.0", "< 2.4"
-  s.add_dependency "deprecation"
+  s.add_dependency "deprecation", "~> 0.1"
   s.add_development_dependency "jettywrapper", ">= 1.4.1"
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency 'engine_cart', ">= 0.1.0"

data/config/locales/blacklight.en.yml

@@ -217,8 +217,11 @@ en:
         leader: 'LEADER %{leader}'
         empty: 'No MARC data found.'
       start_over: 'Start Over'
+      index:
+        label: '%{label}'
       show:
         title: '%{document_title} - %{application_name}'
+        label: '%{label}'
       rss_feed: 'RSS for results'
       atom_feed: 'Atom for results'
       fields:

data/config/locales/blacklight.fr.yml

@@ -233,8 +233,11 @@ fr:
         leader: 'LABEL %{leader}'
         empty: 'Pas MARC trouvé.'
       start_over: 'Accueil'
+      index:
+        label: '%{label}'
       show:
         title: '%{document_title} - %{application_name}'
+        label: '%{label}'
       rss_feed: 'RSS pour les résultats'
       atom_feed: 'Atom pour les résultats'
       fields:

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-3.0-Release-Notes-And-Upgrade-Guide.md

@@ -0,0 +1,107 @@
+This page outlines the basic steps needed to upgrade your customized installation of Blacklight 2.x to work with Blacklight 3.x. 
+
+## Rails 3 Specific Changes:
+Please see [[http://omgbloglol.com/post/353978923/the-path-to-rails-3-approaching-the-upgrade]] - for a good introduction.
+ 
+1. Start by installing Rails3, generate a new app, make sure it works. Doing this not only proves your rails3 installation is working, but it will also get you familiar with the command line tools - which are very different now.
+1. Now, create a new rails app on top of your existing application. This will make all sorts of modifications, creating and updating your Gemfile, Rakefile, application.rb, locals, new javascript, etc...  You should also remove all the files in /script/ except for rails - since these scripts are no longer used.
+
+```bash
+$ rails new my_existing_app
+```
+
+1. Routes are WAY different in rails 3.  Please see [[http://www.engineyard.com/blog/2010/the-lowdown-on-routes-in-rails-3/]]
+1. Most of your application specific configuration now takes place in a file called `config/application.rb`  - you will need to move most of what is currently in your `config/environment.rb` and `config/boot.rb` into this new file. 
+1. The `lib` directory is no longer auto-loaded - and the general recommendation is not to make it so (though it is possible inside of `config/application.rb`) - I went through and added requires methods where and when they are needed in the individual files, which is nice - because now it is far more clear what needs what.
+1. Rails 3 escapes strings by default.  You will have to add `#html_safe` to any ruby string variables that were created 'from scratch' rather than using a "safe" helper (e.g. `content_tag`, `link_to`) which escape the string internally.
+
+## Other Gems that will need upgrading
+1. If you were using the ExceptionNotification gem, things have changed in rails,  There is a good explanation here:
+    [[http://stackoverflow.com/questions/3524127/exception-notification-gem-and-rails-3]]
+1.  If your are using RSpec, you will need to upgrade it in your gem file to version 2.  And you will need to re-run the generator
+
+    ```ruby
+    gem 'rspec', '>2.0.0'
+    $ rails generate rspec:install
+    ```
+
+1.  Recapcha, and Prawnto - I was previously using these as plugins, but they have good gems now, so I removed these from the plugin directory, and added them to the `Gemfile`.
+
+1. If you are using the Marc gem, make sure you are running 0.4.1 - ran into some problems related to changes in the way Rails3 handles json prior to this upgrade.
+
+## Blacklight Specific Changes
+1. There is no `application_helper.rb` file in Blacklight now.  It was moved to `blacklight_helper`, and its methods are made available automatically. (see `blacklight/engine.rb` for more information) So if you were attempting to include this file and override it, don't.  Just redefine the methods in your own `ApplicationHelper`, and you should be fine.
+1.  Remove the Blacklight plugin directory from /vendor - since you will be installing in as a gem.  Include the Blacklight gem in your `Gemfile` list and run `bundle install`:
+
+```ruby
+   gem 'blacklight' 
+```
+
+ If you have Blacklight checked out somewhere, you can point to it in your gem file as follows:
+```ruby
+   gem 'blacklight', :path => '../some/file/path/to/blacklight' 
+```
+
+1. Most of the customization of Blacklight is done through overriding Blacklight-provided methods and templates.  In Virgo you would often see lines like:
+```ruby
+  require_dependency 'vendor/plugins/blacklight/....
+```
+at the top of a file that re-opened the class and made modifications to it. 
+You would now need to change this to:
+```ruby
+  require "#{Blacklight.controllers_dir}/bookmarks_controller" For controllers, and ...
+  require "#{Blacklight.models_dir}/bookmark" For models.
+```
+1. Blacklight no longer includes a `User` model or `SessionController` out of the box. If you want Blacklight to provide user authentication services, you will need to install a separate library. Blacklight recommends Devise, and the Blacklight generator (in the next step) can be used to setup Devise for you.
+
+If you choose to roll-your-own, you will need to add in whatever you need - in my case, that was just creating a `User` model and include the `Blacklight::User` mixin.  
+
+```ruby
+       class User < ActiveRecord::Base                                    
+         include Blacklight::User
+         acts_as_authentic                               
+       end
+```
+Please also see the notes on the `ApplicationController` below ...
+
+1. Run the Blacklight Generator   - This will add all kinds of files to your local application - including stylesheets, images, jar files, database migrations, etc..  It will try it's best to be "idempotent" - that it is shouldn't mess anything up to run this over and over again.  It will verify that the changes it's making are not already in place.
+```bash
+      $ rails generate blacklight (--devise, if you want Blacklight to install devise or MODEL_NAME, to point at a custom User model)
+```
+1. For the most part, you override a controller provided by Blacklight by including the class and then reopening it.  That said, the `CatalogController`  is generated for you into your application (unless you already have one).  Your `CatalogController` should look something like this:
+```ruby
+class CatalogController < ApplicationController
+    inlcude Blacklight::Catalog
+     .....
+ end
+```
+If you end up overriding a large number of `SolrHelper` methods, you can also override the solr helpers in your own file, and then include that file.
+```ruby
+module UVA::SolrHelper
+   include Blacklight::SolrHelper
+   .....
+end
+
+class CatalogController < ApplicationController
+   include UVA::SolrHelper
+   include Blacklight::Catalog
+  ....
+end
+```
+1. Application Controller
+     The Blacklight generator, will add a line to your `ApplicationController` if isn't there already which will cause the `ApplicationController` to include the base controller logic for Blacklight:
+```ruby
+     class ApplicationController < ActionController::Base
+         include Blacklight::Controller
+     end     
+```
+    The `Blacklight::Controller` module adds a number of helper methods, forces the the Blacklight layout, adds the `before_filter :default_html_head`.  Blacklight by no means requires the inclusion of this file.  In the case of Virgo, we do not. 
+
+   You will most likely need to define the following methods in your application controller, particularly if you have any sort of custom user authentication.
+
+* `user_session` - which should return the current rails session object.
+* `current_user`  - which should return a user object that includes `Blacklight::User`
+* `new_user_session_path` - which should return the path for logging into your application
+* `destroy_user_session_path` - which should return the path for logging out of your application.
+
+`SolrDocument` is no longer a file in Blacklight, but rather a generated model in your application, in this way you can easily override and modify the behavior of individual documents. This is automatically created for you, I just wanted to draw you attention to it.