blacklight 4.6.3 → 4.7.0.pre1

data/doc/Configuring-rails-routes.md

@@ -0,0 +1,13 @@
+If your solr ids happen to have dots in them, Rails is going interpret the dots as the separator between the file name and the file exension, and your documents won't be displayed on the show view.  In order to fix that you can override the default routes like this:
+
+```ruby
+ALLOW_DOTS ||= /[a-zA-Z0-9_.:]+/
+MyApp::Application.routes.draw do
+  root :to => "catalog#index"
+  ...
+  resources :catalog, :only => [:show, :update], :constraints => { :id => ALLOW_DOTS, :format => false }
+  Blacklight::Routes.new(self, {}).catalog
+end
+```
+
+you must put the line defining the route with the constraints before you call Blacklight::Routes because the first route that matches is the one that will be used.

data/doc/Contributing-to-Blacklight.md

@@ -0,0 +1,25 @@
+# Contributing to Blacklight
+Blacklight is a collaborative open source project by developers at various institutions, which we each work on largely motivated by our own local institutions' needs. We work on the shared project together so we can benefit from each other's code, but most developers primary priorities are to their own local development. In this it is like many such projects.
+
+The Blacklight developers do want to create a product that is easy for newcomers to install and get started with -- both as a service to the community and in the interests of our own institutions in creating a sustainable project and product that continue to thrive through personnel changes. However, the developers may not always have time to find or fix bugs that may be affecting you, or lead you through every detail of getting Blacklight to work for you.
+
+But we do try when we can -- please don't be scared to ask a question on the [[Blacklight mailing list|http://groups.google.com/group/blacklight-development]], just don't be shocked if we can't always give you the answer you want. We always welcome patch submissions; and we are always excited to hear about what others are doing with Blacklight. We're also always looking for more committers, although we usually like to see a patch or two before considering granting committer status.
+
+If you follow this short guide, it will make it much easier for the community to review your changes, and the core team to get them included in the next release. If you are new to Git, be sure to read Github's (really good) [[step-by-step directions|http://help.github.com/fork-a-repo/]] for contributing to projects. If you want a basic introduction to git, check out [[Git Reference|http://gitref.org/]].
+
+We also encourage a lot of peripheral functionality -- especially for features that may not be used by most implementations, as the Blacklight install base has a wide range of users -- to consider developing stand-alone, optional [[Blacklight add-ons]].
+
+## Adding a ticket
+Let us know you're interested in working on a feature by filing a ticket in our [[issue tracker|https://github.com/projectblacklight/blacklight/issues]].  
+
+## Making Your Changes
+
+* Fork the project (Github has really good step-by-step directions
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
+* After making your changes, be sure to run the [[Blacklight rspec and cucumber tests|Testing]] to make sure everything works. 
+* Submit your change as a [[Pull Request|http://help.github.com/pull-requests/]].
+
+## Support
+If you are interested in working on the Blacklight plugin, but want guidance or support, please send an email to our [[Blacklight-development mailing list|http://groups.google.com/group/blacklight-development]] and we'll be glad to help.

data/doc/Examples.md

@@ -0,0 +1,94 @@
+You can see a demonstration of the generic Blacklight plugin at http://demo.projectblacklight.org
+
+Blacklight 5.x demo site
+http://bootstrap3.demo.projectblacklight.org
+
+Agriculture Network Information Center
+http://www.agnic.org/search
+
+American Legislative and Issue Campaign Exchange (ALICE)
+http://alicelaw.org/
+
+Bibliothèque Clermont Université 
+http://195.221.120.231
+
+Columbia University:
+
+* CLIO - Unified search and discovery - http://clio.columbia.edu
+* Academic Commons - Institutional Repository - http://academiccommons.columbia.edu
+* Human Rights Web Archive - http://hrwa.cul.columbia.edu
+* Special Collection Site - Lindquist - http://lindquist.cul.columbia.edu
+
+Cornell University 
+http://newcatalog.library.cornell.edu/
+
+Danmarks Tekniske Universitet (Technical University of Denmark) - DTU Findit - http://findit.dtu.dk
+
+Indiana University Libraries
+* IUCAT library catalog - http://iucat.iu.edu/
+* Digital Collections Search - http://webapp1.dlib.indiana.edu/dcs/
+
+Johns Hopkins University Libraries (Catalyst)
+http://catalyst.library.jhu.edu
+
+Lowcountry Digital Library (College of Charleston):
+* http://lcdl.library.cofc.edu/
+* Code4Lib Article - http://journal.code4lib.org/articles/8327
+
+NCSU Libraries' Digital Collections: Rare and Unique Materials (This application superseded the Historical State application which was also a Blacklight application.)
+http://d.lib.ncsu.edu/collections/
+
+The New York Public Library
+
+* Andre Studios 1930-1941 - http://andrestudios.nypl.org 
+* Prints & Photographs Online Catalog - http://wallachprintsandphotos.nypl.org/
+
+Northwest Digital Archives
+http://nwda.projectblacklight.org
+
+Northwestern University Library Archival and Manuscript Collections
+http://findingaids.library.northwestern.edu
+
+NRM (Natural Resource Management) knowledge online
+http://nrmonline.nrm.gov.au/
+
+The Pennsylvania State University (Penn State)
+https://scholarsphere.psu.edu/
+
+Rock & Roll Hall of Fame
+http://catalog.rockhall.com/
+
+Stanford University
+http://searchworks.stanford.edu
+
+Tufts University
+http://dl.tufts.edu
+
+University of Virginia
+http://search.lib.virginia.edu
+
+University of Wisconsin-Madison
+http://search.library.wisconsin.edu/
+
+United States Holocaust Memorial Museum
+http://collections.ushmm.org
+
+WGBH Open Vault
+http://openvault.wgbh.org
+
+University of Hull:
+
+* Institutional repository - http://hydra.hull.ac.uk
+* Library catalogue - http://libsearch.hull.ac.uk/
+
+The World Maritime University (using Koha ILS )
+http://beacon.wmu.se
+
+The UI component of the Hydra Framework - http://projecthydra.org
+
+
+
+
+## Media/Presentations
+
+* ["Highly Relevant Search Result Ranking for Large Law Enforcement Information Sharing Systems"](http://www.lucidimagination.com/blog/2011/06/01/solr-and-law-enforcement-highly-relevant-results-can-be-a-crime/), presented by Ronald Mayer of Forensic Logic at Lucene Revolution 2011 - Blacklight was used to quickly provide a proof-of-concept on law enforcement data.

data/doc/Extending-or-Modifying-Blacklight-Search-Behavior.md

@@ -0,0 +1,141 @@
+# Extending or Modifying Blacklight Search Behavior
+
+Solr parameters used by for a given request can come from several different places. 
+
+* Solr request handler: `solrconfig.xml` in your solr config
+* Application logic: logic in the BL rails app itself
+
+## Solr request handler
+
+The Solr [[Request Handlers|http://wiki.apache.org/solr/SolrRequestHandler]] may be configured in the [[solrconfig.xml|http://wiki.apache.org/solr/SolrConfigXml]] and are baked into the request handler itself. Depending on how you have blacklight configured, your app may be using the same Solr request handler for all searches, or may be using different request handlers for different "search fields".  
+
+The request handler is often set up with default parameters:
+
+```xml
+  <requestHandler name="standard" class="solr.SearchHandler" >
+     <lst name="defaults">
+       <str name="echoParams">explicit</str>
+       <str name="rows">10</str> 
+       <str name="fl">*</str>   
+       <str name="facet">true</str>
+       <str name="facet.mincount">1</str>
+       <str name="facet.limit">30</str> 
+       <str name="facet.field">access_facet</str>
+       <str name="facet.field">author_person_facet</str>
+       <str name="facet.field">author_other_facet</str>
+       <str name="facet.field">building_facet</str>
+       <str name="facet.field">callnum_1_facet</str>
+       <str name="facet.field">era_facet</str>
+       <str name="facet.field">format</str>
+       <str name="facet.field">geographic_facet</str>
+       <str name="facet.field">language</str>
+       <str name="facet.field">pub_date_group_facet</str>
+       <str name="facet.field">topic_facet</str>
+     </lst>
+  </requestHandler>
+```
+## Configuration
+
+The default application logic (explained below) looks in configuration for things like the name of a the solr request handler to use, and default request parameters to send on every solr search request (or with every request from a certain blacklight search type/field). An example getting started configuration is generally installed into your app when you install Blacklight at `[[./app/controllers/catalog_controller.rb|https://github.com/projectblacklight/blacklight/blob/master/lib/generators/blacklight/templates/catalog_controller.rb]]`.
+
+## Application logic
+
+The logic Blacklight uses to determine how to map user-supplied parameters into Solr request parameters for a given application request is in the [[#solr_search_params method in the SolrHelper module|https://github.com/projectblacklight/blacklight/blob/master/lib/blacklight/solr_helper.rb#L76]]. Note that `[[CatalogController|https://github.com/projectblacklight/blacklight/blob/master/app/controllers/catalog_controller.rb]]` extends `[[SolrHelper|https://github.com/projectblacklight/blacklight/blob/master/lib/blacklight/solr_helper.rb]]`, so the `SolrHelper` methods become available in the `CatalogController` (and other controllers, if they extend `SolrHelper` too). 
+
+Behind the scenes, #solr_search_params uses the `class_inheritable_accessor` method [[solr_search_params_logic|https://github.com/projectblacklight/blacklight/blob/master/lib/blacklight/solr_helper.rb#L30]]. solr_search_params_logic is essentially a class variable that is mixed into the CatalogController and provides an ordered list of methods to call that may inspect the supplied user parameters and add, remove, or modify the Solr request parameters that will be sent to an [[RSolr|https://github.com/mwmitchell/rsolr/]] object, which in turn will convert the hash into query parameters for a Solr request. One confusing thing is that RSolr and  [[RSolr-ext|https://github.com/mwmitchell/rsolr-ext]] provide their own mappings from certain custom terms to Solr-recognized request parameters. For instance, a `:per_page` key in that hash will get mapped to the Solr `&rows` parameter -- but a `:rows` key will also.  Blacklight developers have found that using these special RSolr "aliases" leads to confusion, as well as confusing bugs (if both `:per_page` and `:rows` are set in the hash, what happens can be hard to predict).  So we try to avoid using the special RSolr aliases, and just use ordinary Solr parameters in our hashes. But you may encounter older code that uses the RSolr aliases. 
+
+There can be similar confusing behavior or bugs if one piece of code adds a key to a `Hash` using a `Symbol`, but another piece of code looks for and/or adds that same key to the `Hash` using a `String` instead. RSolr happens to accepts either one, but if both are present RSolr behavior can be unexpected. And even before it gets to RSolr, you may have code that thinks it replaced a key but did not becuase it was using the wrong form. Blacklight developers have agreed to try and always use `Symbol` based keys in hashes meant for Solr parameters, to try and avoid these problems. Longer term, we could probably make some code changes to make this kind of error less likely. 
+
+The default `#solr_search_params_logic` is meant to handle very common cases and patterns based on simple configuration options from the controller and the user-supplied URL parameters.
+
+* `[[blacklight_config.default_solr_params|https://github.com/projectblacklight/blacklight/blob/master/lib/generators/blacklight/templates/catalog_controller.rb#L9]]`
+    * Default params sent to solr with every search, including the default :qt param, which determines which Solr request handler will be targetted. Some people like to use solrconfig.xml request handler defaults exclusively, and include only a :qt here; others find it more convenient to specify some defaults at the application level here. 
+* `[[blacklight_config.search_fields|https://github.com/projectblacklight/blacklight/blob/master/lib/generators/blacklight/templates/catalog_controller.rb#L81]]`
+   * Each search field will be presented in a select menu in the BL user interface search box. These 'search fields' don't neccesarily correspond 1-to-1 with Solr fields. What they instead correspond to is Solr parameter over-rides that will be used for this BL UI search field.  Those over-rides are present here. 
+   * You could simply chose a different `:qt` Solr request handler for each search field, which has it's own default parameters in the sorlconfig.xml. This is what we started out doing with Solr, but found it led to much duplication of information in solrconfig.xml. 
+   * You can continue using the same Solr request handler, but simply specify different parameters which will be included in the http query string sent to Solr here, with the `:solr_parameters`  key. This works fine, but some people don't like how it makes your Solr requests much longer/more complex in the Solr logs; and/or they prefer to control this Solr side instead of Application side. 
+   * For the best of both worlds, although it's a bit confusing at first, you can use the `:solr_local_parameters` key to have parameters supplied to Solr using the Solr [[LocalParams|http://wiki.apache.org/solr/LocalParams]] syntax, which means you can use "parameter dereferencing"  with dollar-sign-prefixed references to variables defined in solrconfig.xml request handler. This is what the current example BL setup does. 
+
+So the default implementation of `#solr_search_params` takes these configured parameters, combines them with certain query parameters from the current users HTTP request to the BL app, and prepares a Hash of parameters that will be sent to solr. For common use patterns, this is all you need. 
+
+But sometimes you want to add some custom logic to `#solr_search_params` to come up with the solr params Hash in different ways. Typically to support a new UI feature of some kind, either in your local app or in a Blacklight add-on plugin you are developing. 
+
+
+# Extending Blacklight::SolrHelper#solr_search_params
+
+To add new search behaviors (e.g. authorization controls, pre-parsing query strings, etc), the easiest route is to add additional steps to the `#solr_search_params_logic`, either at the beginning of the list (to set default parameters) or at the end of the list (to force particular parameters). Because `#solr_search_params_logic` is just an ordinary array, you may perform any normal array operation (e.g. push/pop/delete/insert) to customize the parameter generation to meet your needs.
+
+`#solr_search_params_logic` steps take two inputs, the hash of `solr_parameters` and the hash of `user_parameters` (often provided by the URL parameters), and modifies the `solr_parameters` directly, as needed. 
+
+You can add custom solr_search_params_logic steps within your controller (or in many other places, including initializers, mixins, etc) by adding a Symbol with the name of a method (provided by the controller) you wish to use, e.g.:
+
+*./config/initializers/blacklight_config.rb*
+
+```ruby
+class CatalogController
+  self.solr_search_params_logic += :show_only_public_records
+end
+```
+The controller must provide the method added to `solr_search_params_logic`, in this case `show_only_public_records`. It is often convenient to do this in a separate `Module` and include it into the controller:
+
+*./app/controllers/catalog_controller.rb*
+
+```ruby
+require 'blacklight/catalog'
+class CatalogController < ApplicationController 
+  include Blacklight::Catalog
+  include MyApplication::SolrHelper::Authorization
+  
+  # Instead of defining this within an initializer, you may instead wish to do it on the controller directly:
+  # self.solr_search_params_logic << :show_only_public_records
+
+  # You could also define the actual method here, but this is not recommended.
+  # def show_only_public_records solr_parameters, user_parameters
+  #  [...]
+  # end
+end
+```
+
+The included module then defines the logic method:
+ 
+*./lib/my_application/solr_helper/authorization.rb*
+
+```ruby
+module MyApplication::SolrHelper::Authorization
+#  You could also add the logic here
+#  def self.included base
+#    base.solr_search_params_logic << :show_only_public_records
+#  end
+
+  # solr_search_params_logic methods take two arguments
+  # @param [Hash] solr_parameters a hash of parameters to be sent to Solr (via RSolr)
+  # @param [Hash] user_parameters a hash of user-supplied parameters (often via `params`)
+  def show_only_public_records solr_parameters, user_parameters
+    # add a new solr facet query ('fq') parameter that limits results to those with a 'public_b' field of 1 
+    solr_parameters[:fq] ||= []
+    solr_parameters[:fq] << 'public_b:1'
+  end
+end
+```
+
+## Other examples
+
+In addition to providing this behavior locally, some Blacklight plugins also extend the `#solr_search_params`:
+
+* [[Blacklight Range Limit|https://github.com/projectblacklight/blacklight_range_limit/blob/master/lib/blacklight_range_limit/controller_override.rb]]
+
+* A walk through on adding a checkbox limit at: http://bibwild.wordpress.com/2011/06/13/customing-blacklight-a-limit-checkbox/
+
+* A much more complicated walk-through on adding an 'unstemmed search' checkbox limit: http://bibwild.wordpress.com/2011/06/20/customizing-blacklight-disable-automatic-stemming/
+
+## Suppressing search results
+
+You can configure your `solrconfig.xml` to not show results based on fields in your solr document.  For example, if you have a solr boolean field such as `show_b`, you can suppress any records that have this field present.  To do so, add:
+```
+<lst name="appends"><str name="fq">-show_b:["" TO *]</str></lst>
+```
+to the request handler in your `solrconfig.xml` file.  If you would like this to be for standard solr searches, add the above line to this request handler:
+```
+<requestHandler name="search" class="solr.SearchHandler" default="true">
+```
+By doing so, solr queries that use the "document" request handler will still give you any records with the show_b field, but solr queries with the "search" handler will not.

data/doc/FAQs.md

@@ -0,0 +1 @@
+Currently no FAQs are written. Feel free to add any.

data/doc/Home.md

@@ -0,0 +1,80 @@
+#
+[[https://github.com/projectblacklight/projectblacklight.github.com/raw/master/images/logo.png]]
+
+## Introduction
+
+Blacklight is an open source, Ruby on Rails engine/gem that provides a discovery interface for  [Apache Solr](http://lucene.apache.org/solr). Blacklight provides a basic user interface for searching a Solr index, and provides search box, facet constraints, stable document urls, etc., all of which is customizable via Rails (templating) mechanisms.  Blacklight accommodates heterogeneous data, allowing different information displays for different types of objects. 
+
+Some other features include:
+
+* Stable URLs for search and record pages allow users to bookmark, share, and save search queries for later access
+* Every Blacklight search provides RSS and Atom Responses of search results
+* For certain types of solr documents, an OpenURL/Z39.88 COinS object is embedded in each document, which allows plugins like Zotero to easily extract data from the page.
+* Blacklight supports OpenSearch, a collection of simple formats for the sharing of search results.
+* Faceted searching
+* Search queries can be targeted at specific sets of fields
+* Results sorting
+* Tools for exporting records to Refworks or Endnote, sending records via Email or SMS, or as a formatted citation.
+
+A [demo application](http://demo.projectblacklight.org) uses the latest version of Blacklight to display a basic library catalog.
+
+> NOTE: This wiki provides developer documentation for the latest Blacklight release. For documentation of older releases, see the end of this page.
+
+## Getting Started
+* [[Quickstart Guide|Quickstart]]
+* [[Site Search|http://projectblacklight.org/search.html]]
+* [[Demo|http://demo.projectblacklight.org]]
+* [[Example installations|Examples]]
+* [[Release Notes And Upgrade Guides]]
+
+## Developing your application
+* [[Blacklight Configuration]]: Search results, facets, query fields
+* [[Providing your own view templates]]: Overriding the out-of-the-box Blacklight templates the Rails way.
+* [[Theming]]: Overriding the Blacklight CSS
+* [[User Authentication]]: Connecting Blacklight with an existing Authentication system
+* [[Extending or Modifying Blacklight Search Behavior]] How to change the way the Blacklight discovery feature works.
+* [[Internationalization]]: Translating (or simply customizing) the Blacklight copy
+* [[Common Blacklight Patterns]]
+* [[JSON API]]
+* [[Configuring Rails Routes]]
+* [[Indexing your data into Solr]]
+* [[Additional Blacklight-specific Solr documentation|README_SOLR]]
+* [[Blacklight on Heroku]]
+* [[Pagination]]: Advice on how to customize pagination with Kaminari
+* [[Blacklight Plugins/Addons|Blacklight-Add-ons]]
+
+
+## Support
+Don't be scared to ask a question on the [[Blacklight mailing list|http://groups.google.com/group/blacklight-development]]. We appreciate you checking the documentation first and asking an educated question, but don't beat your head against the wall -- sometimes the existing documentation may be out of date and inaccurate.
+
+In order to reduce spam, the first time you post your email will be held in a moderation queue, but as soon as your first message is approved your posts won’t be held for moderation any longer. 
+
+Some Blacklight developers aso hang out on our IRC channel, usually during North American office hours. On `chat.freenode.net`, channel `#blacklight`. Stop in and say hi, we're happy to help with questions when we have time. [[http://freenode.net/faq.shtml]].
+
+* [[Bug Tracker|https://github.com/projectblacklight/blacklight/issues/]]
+* [[Mailing List|http://groups.google.com/group/blacklight-development]]
+* [![Build Status](https://travis-ci.org/projectblacklight/blacklight.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight)
+
+## Contributing to Blacklight
+
+* [[Contributing to Blacklight]]
+* [[Community Principles]]
+* [[How to release a version]]
+* [[Testing]]
+
+## Releases
+Blacklight releases are published on the [[Rubygems.org blacklight project|https://rubygems.org/gems/blacklight]].
+
+For a list of features and bugfixes in Blacklight releases, see the [[Release announcements|Release Notes And Upgrade Guides]] on this wiki.
+
+### Older Documentation
+This wiki provides developer documentation for the ```master``` branch of Blacklight, which may include documentation of features not present in every Blacklight version. For documentation of specific Blacklight releases, see also:
+
+* [[Home]]
+* [[Blacklight 3.x|https://github.com/projectblacklight/blacklight/tree/release-3.8/doc]]
+* [[Blacklight 3.0 or 3.1|https://github.com/projectblacklight/blacklight/tree/release-3.1/doc]]
+* [[Blacklight 2.x|https://github.com/projectblacklight/blacklight/tree/v2.9-frozen/doc]] for all Blacklight 2.x releases; version-specific documentation is also available:
+    * [[Blacklight 2.7|https://github.com/projectblacklight/blacklight/tree/v2.7.0/doc]]
+    * [[Blacklight 2.6|https://github.com/projectblacklight/blacklight/tree/v2.6.0/doc]]
+    * [[Blacklight 2.5|https://github.com/projectblacklight/blacklight/tree/v2.5.0/doc]]
+    * [[Blacklight 2.4|https://github.com/projectblacklight/blacklight/tree/v2.4.2/doc]]

data/doc/How-to-release-a-version.md

@@ -0,0 +1,29 @@
+Before releasing, ensure that you're on the master branch.  Run all  tests and ensure that they pass. Also check the [[continuous integration server|https://travis-ci.org/projectblacklight/blacklight]] to make sure tests are passing.
+    ```bash
+    $ bundle exec rake
+    ```
+
+1. Update the version number in ./VERSION
+    ```
+    {major}.{minor}.{patch}
+    ```
+
+1. Fix GitHub issue tracker to know about the release
+      * Create a milestone in GitHub for the NEXT version.
+      * Move any open tickets for released version to the next version.
+      * Mark the milestone as closed.
+
+1. Write Github [release notes](https://github.com/projectblacklight/blacklight/tags) for the tag.
+
+1. Prepare announcement
+  * Include URL to GitHub closed issues for version 
+  * Include URL to github commits between tags. github can show all commits between two versions with a URL of this form: [[http://github.com/projectblacklight/blacklight/compare/v2.5.0...v2.6.0]]  Replace with previous version and current release version tags. 
+  * Include URL to the Github wiki [[Release Notes And Upgrade Guides]].
+
+1. Release the gem 
+```bash
+$ rake release
+```
+
+1. Announce
+  * Write emails announcing the release to Blacklight Development 

data/doc/Indexing-your-data-into-solr.md

@@ -0,0 +1,32 @@
+Blacklight uses Solr as its data index. Blacklight is agnostic as to how that Solr index gets populated. Many Blacklight contributors work in university libraries and have to deal with library data in the MARC format. The Blacklight out-of-the-box demo and test suite is geared towards that use case.
+
+## Common Patterns
+
+If you're not dealing with MARC records, you might do something like the following:
+
+    class MyModel < ActiveRecord::Base
+      after_save :index_record
+      before_destroy :remove_from_index
+
+      attr_accessible :field_i_want_to_index
+
+      def to_solr
+        # *_texts here is a dynamic field type specified in solrconfig.xml
+        {'id' => id,
+         'field_i_want_to_index_texts' => field_i_want_to_index}
+      end
+
+      def index_record
+        SolrService.add(self.to_solr)
+        SolrService.commit
+      end
+
+      def remove_from_index
+        SolrService.delete_by_id(self.id)
+        SolrService.commit
+      end
+    end
+
+## What’s the relationship between Blacklight and SolrMarc?
+
+However, one excellent way to index lots of MARC records into Solr quickly is to use SolrMarc. Some of the same people are active in both projects, e.g, Bob Haschart from UVA and Naomi Dushay from Stanford University. SolrMarc is not a Blacklight-specific project, it is also used by VuFind and other projects, and is a separate project that exists in its own right.

data/doc/Integration-with-Rails-Footnotes.md

@@ -0,0 +1,20 @@
+[[Rails Footnotes|https://github.com/josevalim/rails-footnotes]] is a helpful plugin that displays footnotes in your application for easy debugging, such as sessions, request parameters, cookies, filter chain, routes, queries, etc. Installing Rails Footnotes is very easy, just add this to your Gemfile:
+```ruby
+gem 'rails-footnotes', '>= 3.7', :group => :development
+```
+
+And add something like this to config/initializers/footnotes.rb to run the Footnotes plugin:
+```ruby
+if defined?(Footnotes) && Rails.env.development?
+  Footnotes.run!
+end
+```
+
+To add RSolr debugging information to the footnotes panel, you can use the [[RSolr Footnotes|https://github.com/cbeer/rsolr-footnotes]] gem by adding this to your Gemfile:
+```ruby
+gem "rsolr-footnotes", :group => :development
+```
+
+RSolr footnotes will capture every solr request with basic performance information and provide a link back to the Solr request URL.
+
+[[https://github.com/projectblacklight/projectblacklight.github.com/raw/master/images/rsolr_footnotes_example.png|frame|alt=Example of RSolr Footnotes in the Blacklight Demo App]]