blacklight 3.1.2 → 3.2.0pre1

data/app/assets/stylesheets/yui.css

@@ -1,31 +0,0 @@
-/*
-Copyright (c) 2008, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://developer.yahoo.net/yui/license.txt
-version: 2.6.0
-*/
-html{color:#000;background:#FFF;}body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,textarea,p,blockquote,th,td{margin:0;padding:0;}table{border-collapse:collapse;border-spacing:0;}fieldset,img{border:0;}address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}li{list-style:none;}caption,th{text-align:left;}h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}q:before,q:after{content:'';}abbr,acronym{border:0;font-variant:normal;}sup{vertical-align:text-top;}sub{vertical-align:text-bottom;}input,textarea,select{font-family:inherit;font-size:inherit;font-weight:inherit;}input,textarea,select{*font-size:100%;}legend{color:#000;}del,ins{text-decoration:none;}
-
-/*
-Copyright (c) 2008, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://developer.yahoo.net/yui/license.txt
-version: 2.6.0
-*/
-h1{font-size:138.5%;}h2{font-size:123.1%;}h3{font-size:108%;}h1,h2,h3{margin:1em 0;}h1,h2,h3,h4,h5,h6,strong{font-weight:bold;}abbr,acronym{border-bottom:1px dotted #000;cursor:help;} em{font-style:italic;}blockquote,ul,ol,dl{margin:1em;}ol,ul,dl{margin-left:2em;}ol li{list-style:decimal outside;}ul li{list-style:disc outside;}dl dd{margin-left:1em;}th,td{border:1px solid #000;padding:.5em;}th{font-weight:bold;text-align:center;}caption{margin-bottom:.5em;text-align:center;}p,fieldset,table,pre{margin-bottom:1em;}input[type=text],input[type=password],textarea{width:12.25em;*width:11.9em;}
-
-/*
-Copyright (c) 2008, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://developer.yahoo.net/yui/license.txt
-version: 2.6.0
-*/
-body{font:13px/1.231 arial,helvetica,clean,sans-serif;*font-size:small;*font:x-small;}select,input,button,textarea{font:99% arial,helvetica,clean,sans-serif;}table{font-size:inherit;font:100%;}pre,code,kbd,samp,tt{font-family:monospace;*font-size:108%;line-height:100%;}
-
-/*
-Copyright (c) 2008, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://developer.yahoo.net/yui/license.txt
-version: 2.6.0
-*/
-body{text-align:center;}#ft{clear:both;}#doc,#doc2,#doc3,#doc4,.yui-t1,.yui-t2,.yui-t3,.yui-t4,.yui-t5,.yui-t6,.yui-t7{margin:auto;text-align:left;width:57.69em;*width:56.25em;min-width:750px;}#doc2{width:73.076em;*width:71.25em;}#doc3{margin:auto 10px;width:auto;}#doc4{width:74.923em;*width:73.05em;}.yui-b{position:relative;}.yui-b{_position:static;}#yui-main .yui-b{position:static;}#yui-main,.yui-g .yui-u .yui-g{width:100%;}{width:100%;}.yui-t1 #yui-main,.yui-t2 #yui-main,.yui-t3 #yui-main{float:right;margin-left:-25em;}.yui-t4 #yui-main,.yui-t5 #yui-main,.yui-t6 #yui-main{float:left;margin-right:-25em;}.yui-t1 .yui-b{float:left;width:12.30769em;*width:12.00em;}.yui-t1 #yui-main .yui-b{margin-left:13.30769em;*margin-left:13.05em;}.yui-t2 .yui-b{float:left;width:13.8461em;*width:13.50em;}.yui-t2 #yui-main .yui-b{margin-left:14.8461em;*margin-left:14.55em;}.yui-t3 .yui-b{float:left;width:23.0769em;*width:22.50em;}.yui-t3 #yui-main .yui-b{margin-left:24.0769em;*margin-left:23.62em;}.yui-t4 .yui-b{float:right;width:13.8456em;*width:13.50em;}.yui-t4 #yui-main .yui-b{margin-right:14.8456em;*margin-right:14.55em;}.yui-t5 .yui-b{float:right;width:18.4615em;*width:18.00em;}.yui-t5 #yui-main .yui-b{margin-right:19.4615em;*margin-right:19.125em;}.yui-t6 .yui-b{float:right;width:23.0769em;*width:22.50em;}.yui-t6 #yui-main .yui-b{margin-right:24.0769em;*margin-right:23.62em;}.yui-t7 #yui-main .yui-b{display:block;margin:0 0 1em 0;}#yui-main .yui-b{float:none;width:auto;}.yui-gb .yui-u,.yui-g .yui-gb .yui-u,.yui-gb .yui-g,.yui-gb .yui-gb,.yui-gb .yui-gc,.yui-gb .yui-gd,.yui-gb .yui-ge,.yui-gb .yui-gf,.yui-gc .yui-u,.yui-gc .yui-g,.yui-gd .yui-u{float:left;}.yui-g .yui-u,.yui-g .yui-g,.yui-g .yui-gb,.yui-g .yui-gc,.yui-g .yui-gd,.yui-g .yui-ge,.yui-g .yui-gf,.yui-gc .yui-u,.yui-gd .yui-g,.yui-g .yui-gc .yui-u,.yui-ge .yui-u,.yui-ge .yui-g,.yui-gf .yui-g,.yui-gf .yui-u{float:right;}.yui-g div.first,.yui-gb div.first,.yui-gc div.first,.yui-gd div.first,.yui-ge div.first,.yui-gf div.first,.yui-g .yui-gc div.first,.yui-g .yui-ge div.first,.yui-gc div.first div.first{float:left;}.yui-g .yui-u,.yui-g .yui-g,.yui-g .yui-gb,.yui-g .yui-gc,.yui-g .yui-gd,.yui-g .yui-ge,.yui-g .yui-gf{width:49.1%;}.yui-gb .yui-u,.yui-g .yui-gb .yui-u,.yui-gb .yui-g,.yui-gb .yui-gb,.yui-gb .yui-gc,.yui-gb .yui-gd,.yui-gb .yui-ge,.yui-gb .yui-gf,.yui-gc .yui-u,.yui-gc .yui-g,.yui-gd .yui-u{width:32%;margin-left:1.99%;}.yui-gb .yui-u{*margin-left:1.9%;*width:31.9%;}.yui-gc div.first,.yui-gd .yui-u{width:66%;}.yui-gd div.first{width:32%;}.yui-ge div.first,.yui-gf .yui-u{width:74.2%;}.yui-ge .yui-u,.yui-gf div.first{width:24%;}.yui-g .yui-gb div.first,.yui-gb div.first,.yui-gc div.first,.yui-gd div.first{margin-left:0;}.yui-g .yui-g .yui-u,.yui-gb .yui-g .yui-u,.yui-gc .yui-g .yui-u,.yui-gd .yui-g .yui-u,.yui-ge .yui-g .yui-u,.yui-gf .yui-g .yui-u{width:49%;*width:48.1%;*margin-left:0;}.yui-g .yui-g .yui-u{width:48.1%;}.yui-g .yui-gb div.first,.yui-gb .yui-gb div.first{*margin-right:0;*width:32%;_width:31.7%;}.yui-g .yui-gc div.first,.yui-gd .yui-g{width:66%;}.yui-gb .yui-g div.first{*margin-right:4%;_margin-right:1.3%;}.yui-gb .yui-gc div.first,.yui-gb .yui-gd div.first{*margin-right:0;}.yui-gb .yui-gb .yui-u,.yui-gb .yui-gc .yui-u{*margin-left:1.8%;_margin-left:4%;}.yui-g .yui-gb .yui-u{_margin-left:1.0%;}.yui-gb .yui-gd .yui-u{*width:66%;_width:61.2%;}.yui-gb .yui-gd div.first{*width:31%;_width:29.5%;}.yui-g .yui-gc .yui-u,.yui-gb .yui-gc .yui-u{width:32%;_float:right;margin-right:0;_margin-left:0;}.yui-gb .yui-gc div.first{width:66%;*float:left;*margin-left:0;}.yui-gb .yui-ge .yui-u,.yui-gb .yui-gf .yui-u{margin:0;}.yui-gb .yui-gb .yui-u{_margin-left:.7%;}.yui-gb .yui-g div.first,.yui-gb .yui-gb div.first{*margin-left:0;}.yui-gc .yui-g .yui-u,.yui-gd .yui-g .yui-u{*width:48.1%;*margin-left:0;} .yui-gb .yui-gd div.first{width:32%;}.yui-g .yui-gd div.first{_width:29.9%;}.yui-ge .yui-g{width:24%;}.yui-gf .yui-g{width:74.2%;}.yui-gb .yui-ge div.yui-u,.yui-gb .yui-gf div.yui-u{float:right;}.yui-gb .yui-ge div.first,.yui-gb .yui-gf div.first{float:left;}.yui-gb .yui-ge .yui-u,.yui-gb .yui-gf div.first{*width:24%;_width:20%;}.yui-gb .yui-ge div.first,.yui-gb .yui-gf .yui-u{*width:73.5%;_width:65.5%;}.yui-ge div.first .yui-gd .yui-u{width:65%;}.yui-ge div.first .yui-gd div.first{width:32%;}#bd:after,.yui-g:after,.yui-gb:after,.yui-gc:after,.yui-gd:after,.yui-ge:after,.yui-gf:after{content:".";display:block;height:0;clear:both;visibility:hidden;}#bd,.yui-g,.yui-gb,.yui-gc,.yui-gd,.yui-ge,.yui-gf{zoom:1;}

data/app/views/catalog/opensearch.xml.erb

@@ -1,11 +0,0 @@
-<?xml version="1.0"?>
-<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
-  <ShortName><%= application_name %></ShortName>
-  <Description><%= application_name %> Search</Description>
-  <Image height="16" width="16" type="image/x-icon">/favicon.ico</Image>
-  <Contact/>
-  <Url type="text/html" method="get" template="<%= url_for :controller=>'catalog', :only_path => false %>?q={searchTerms}"/>
-  <Url type="application/rss+xml" method="get" template="<%= url_for :controller=>'catalog', :only_path => false %>.rss?q={searchTerms}"/>
-  <Url type="application/atom+xml" method="get" template="<%= url_for :controller=>'catalog', :only_path => false %>.atom?q={searchTerms}"/>
-  <Url type="application/x-suggestions+json" method="get" template="<%= url_for :controller=>'catalog',:action => 'opensearch', :format=> 'json', :only_path => false %>?q={searchTerms}"/>
-</OpenSearchDescription>

data/doc/Atom-Responses.md

@@ -1,90 +0,0 @@
-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_helper.rb#L311]]` 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/CUSTOMIZING.md

@@ -1,121 +0,0 @@
-# Customizing Blacklight
-
-There are lots of way to override specific behaviors and views in Blacklight. Blacklight is distributed as a Ruby gem with a Rails Engine framework built in. All customization of Blacklight behavior should be done within your application (partly as good practice, but also to not lose your changes with every new Blacklight release).
-
-If you find that there is no other way to make your customization, please describe your problem on the [[mailing list|http://groups.google.com/group/blacklight-development]] -- we'll do the best we can to help out, and even make changes to Blacklight as needed. If you are interested in contributing code to Blacklight, see the [[Contributing to Blacklight]] page.
-
-## Layouts 
-
-The built-in Blacklight controllers all by default use a Rails view layout called "blacklight", that lives in the Blacklight source. This ends up being a bit confusing, but is the best way we have at present to have out of the box default using a layout with full functionality, without stepping on a possibly existing local 'application' layout. 
-
-To change what layout the Blacklight controllers use, simply implement a method #layout_name in your local application_controller.rb that returns the name of the layout you'd like them to use. 
-
-```ruby
-    def layout_name
-       "application"
-    end
-```
-
-When implmeenting your own layout instead of using the stock one, you may want to look at the Blacklight app/views/layouts/blacklight.html.erb file to see what helper methods are called there, to maintain full Blacklight functionality you may want to call these same helper methods. An example would be insertion of alternate format auto-discovery link tags in the head section; if you call out to BL helpers, BL will make sure it happens.  Another example would be the sidebar_items helper; if you don't call out to that, your page won't include sidebar content such as facet lists. 
-
-## Overriding Views (templates and partials)
-As a Rails Engine, you can easily override views in your app. You can see what views and partials are provided by looking in `[[./app/views|https://github.com/projectblacklight/blacklight/tree/master/app/views]]` inside the Blacklight source.
-
-Once you find the view you'd like to change, you should create a file with the same name and relative path in your own application (e.g. if you wanted to override [[./app/views/catalog/_show_partials/_default.html.erb|https://github.com/projectblacklight/blacklight/blob/master/app/views/catalog/_show_partials/_default.html.erb]] you would create ./app/views/catalog/_show_partials/_default.html.erb in your local application. Frequently, you will start by copying the existing Blacklight view and modifying it from there.
-
-It is generally recommended that you override as little as possible, in order to maximize your forward compatibility. Look to override either a small, focused partial template, or a helper method of partial template called from a larger template, so your application's version can call out to those same helpers or partial templates within blacklight core code. 
-
-## Overriding the Catalog controller
-Overriding the Blacklight CatalogController implementation is easy, and the skeleton of the `CatalogController` is generated into your application for you when you install Blacklight. 
-
-See the [[Extending or Modifying Blacklight Search Behavior]] for tips and approaches to customizing the catalog.
-
-## Overriding Other Controllers
-
-1. Find the controller you're interested in in blacklight's app/controllers/  . 
-2. Create a file with the same name in your local app/controllers. 
-3. This file requires the original class, and then re-opens it to add more methods.
- 
-```ruby
-require "#{Blacklight.controllers_dir}/some_controller"
-
-class SomeController < ApplicationController
-   # custom code goes here
-end
-```
-
-In that "custom code goes here", you can redefine certain methods (action methods or otherwise) to do something different.  You can also add new methods (again action methods or otherwise), etc. 
-
-It's kind of hard to call 'super' to call original functionality: 
-
-* the ruby language features here make 'super' unavailable, although you can work around that confusingly with the rails #alias_method_chain method. 
-* but more importantly, action methods in particular don't really suit themselves to being over-ridden and called by super, because the original implementation often does something you'd want to change but there's no easy way to 'undo' -- calling 'render', which can only be called once. 
-
-So basically, if you find yourself wanting to access some functionaltiy in the original implementation of a method that you also want to over-ride -- the best solution is probably to refactor Blacklight core code to put that functionality in a subsidiary method, so you can over-ride the action method entirely but call that logic from core.  Action methods should be short and sweet anyway. 
-
-
-## Custom View Helpers
-
-(This is accurate for Blacklight 3.1.1 and subsequent. Before that, things were messier). 
-
-One of the most common things you might need to do is create a view helper -- especially to override some Blacklight behavior implemented in it's own view helpers. The first step is looking at Blacklight source to determine what view helper method you want to override. 
-
-Blacklight comes packaged with several view helper modules. There is a BlacklightHelper in (blacklight source) app/helpers/blacklight_helper.rb , and several others that correspond to specific controller. (Note, depending on version of Rails and configuration, all helpers may get loaded for every request, even ones that are named to correspond only to a particular other controller). 
-
-If you simply created a local helper with the same name as a helper in Blacklight, that will end up preventing the Blacklight helper from being loaded at all though, which is not what you want to do to override. 
-
-We've structured each Blacklight view helper module into two parts to make it easy to selectively over-ride methods. For instance, here's Blacklight's app/helpers/blacklight_helper.rb:
-
-```ruby
-module BlacklightHelper
-  include Blacklight::BlacklightHelperBehavior
-end
-```
-
-Now, the actual methods will be found in app/helpers/blacklight/blacklight_helper_behavior.rb instead. 
-
-If you want to over-ride a helper method, copy the wrapper blacklight_helper into your local app, with the 'include' line, and now you can individually over-ride methods from BlacklightHelpersBehavior, and the other methods you don't over-ride will still have their default implementation. 
-
-YOUR `app/helpers/blacklight_helper.rb`
-
-```ruby
-module BlacklightHelper
-  include Blacklight::BlacklightHelperBehavior
-
-  def application_name
-    "Bestest University Search"
-  end
-end
-```
-
-One helper you might want to over-ride for customization is #render_document_partial (currently defined in [[blacklight_helper|https://github.com/projectblacklight/blacklight/blob/master/app/helpers/blacklight_helper.rb]]), which you can over-ride to choose differnet local partial views to display a document on search results or detail page, possibly varying depending on type of document according to your own local logic. 
-
-## Adding in your own CSS or Javascript
-
-You probably already have a local `app/controllers/application_controller.rb`. If you've installed the Blacklight plugin already, it probably looks something like this:
-```ruby
-class ApplicationController < ActionController::Base
-  # Adds a few additional behaviors into the application controller 
-  include Blacklight::Controller
-end
-```
-
-Now create a css file called whatever you want in the application's `./public/stylesheets` directory inside the class definition, add like so:
-```ruby
-    class ApplicationController < ActionController::Base
-        before_filter :add_my_own_assets
-
-        protected
-        def add_my_own_assets
-            stylesheet_links << "my_css"
-
-            # You can do something similar with javascript files too:
-            # javascript_includes << "my_js"
-        end
-    end
-```
-
-## See also
-
-* [[Extending or Modifying Blacklight Search Behavior]]
-* [[Pagination]]

data/doc/Extending-blacklight-with-the-document-extension-framework.md

@@ -1 +0,0 @@
-See [[Blacklight::Solr::Document rdoc|http://rdoc.info/github/projectblacklight/blacklight/master/Blacklight/Solr/Document]]

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

@@ -1,131 +0,0 @@
-# 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 `[[./config/initializers/blacklight_config.rb|https://github.com/projectblacklight/blacklight/blob/master/lib/generators/blacklight/templates/config/blacklight_config.rb]]`.
-
-Nothing special about the filename 'blacklight_config.rb', anything in a Rails app at `./config/initializers/*.rb` gets run on application startup, what matters it the code.
-
-## 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.  We 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, usually set in the `config/blacklight_config.rb` file, and the user-supplied URL parameters.
-
-* `[[Blacklight.config[:default_solr_params]|https://github.com/projectblacklight/blacklight/blob/master/config/initializers/blacklight_config.rb#L44]]`
-    * 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/config/initializers/blacklight_config.rb#L194]]`
-   * An array of hashes, each of which defines a 'search field' which 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 the `blacklight_config.rb` (or in many other places) 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
-CatalogController.solr_search_params_logic << :show_only_public_records
-```
-(note, this method of using an initiailizer has trouble if the local CatalogController is reloaded with Rails development-mode class reloading, it'll miss the mod to solr_search_params_logic on reload. To get around this, either use `to_prepare do`, or just mod the solr_search_params_logic in the local CatalogController class definition, as below)
-
-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/

data/doc/Features.md

@@ -1,147 +0,0 @@
-## Discovery
-### Search Features
-Blacklight uses Solr as its "search engine". More information about Solr is available at the [[Solr web site|http://lucene.apache.org/solr/]]
-
-* 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
-  # 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[:search_fields] << {
-    :key => 'title',     
-    # solr_parameters hash are sent to Solr as ordinary url query params. 
-    :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
-    :solr_local_parameters => {
-      :qf => "$title_qf",
-      :pf => "$title_pf"
-    }
-  }
-```
-
->  Source: [[./config/initializers/blacklight_config.rb|https://github.com/projectblacklight/blacklight/blob/master/lib/generators/blacklight/templates/config/blacklight_config.rb#L155]]
-
-
-- 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]]
-
-```ruby
-  # solr fields that will be treated as facets by the blacklight application
-  #   The ordering of the field names is the order of the display
-  # TODO: Reorganize facet data structures supplied in config to make simpler
-  # for human reading/writing, kind of like search_fields. Eg,
-  # config[:facet] << {:field_name => "format", :label => "Format", :limit => 10}
-  config[:facet] = {
-    :field_names => (facet_fields = [
-      "format",
-      "pub_date",
-      "subject_topic_facet",
-      "language_facet",
-      "lc_1letter_facet",
-      "subject_geo_facet",
-      "subject_era_facet"
-    ]),
-    :labels => {
-      "format"              => "Format",
-      "pub_date"            => "Publication Year",
-      "subject_topic_facet" => "Topic",
-      "language_facet"      => "Language",
-      "lc_1letter_facet"    => "Call Number",
-      "subject_era_facet"   => "Era",
-      "subject_geo_facet"   => "Region"
-    },
-    # Setting a limit will trigger Blacklight's 'more' facet values link.
-    # * If left unset, then all facet values returned by solr will be displayed.
-    # * If set to an integer, then "f.somefield.facet.limit" will be added to
-    # solr request, with actual solr request being +1 your configured limit --
-    # you configure the number of items you actually want _displayed_ in a page.    
-    # * If set to 'true', then no additional parameters will be sent to solr,
-    # but any 'sniffed' request limit parameters will be used for paging, with
-    # paging at requested limit -1. Can sniff from facet.limit or 
-    # f.specific_field.facet.limit solr request params. This 'true' config
-    # can be used if you set limits in :default_solr_params, or as defaults
-    # on the solr side in the request handler itself. Request handler defaults
-    # sniffing requires solr requests to be made with "echoParams=all", for
-    # app code to actually have it echo'd back to see it.     
-    :limits => {
-      "subject_topic_facet" => 20,
-      "language_facet" => true
-    }
-  }
-```
-
-> Source: [[./config/initializers/blacklight_config.rb|https://github.com/projectblacklight/blacklight/blob/master/lib/generators/blacklight/templates/config/blacklight_config.rb#L39]]
-
-* Blacklight provides basic spellcheck suggestions for poor search queries
-[[https://github.com/projectblacklight/projectblacklight.github.com/raw/master/images/search_spellcheck.png|frame|alt=Spellchecking user queries]]
-
-* Blacklight provides flexible mapping from user queries to solr parameters, which are easily overridable in local applications (see [[Extending or Modifying Blacklight Search Behavior]]).
-
-```ruby
-    # Each symbol identifies a _method_ that must be in
-    # this class, taking two parameters (solr_parameters, user_parameters)
-    # Can be changed in local apps or by plugins, eg:
-    # CatalogController.include ModuleDefiningNewMethod
-    # CatalogController.solr_search_params_logic << :new_method
-    # CatalogController.solr_search_params_logic.delete(:we_dont_want)
-    self.solr_search_params_logic = [:default_solr_parameters , :add_query_to_solr, :add_facet_fq_to_solr, :add_facetting_to_solr, :add_sorting_paging_to_solr ]
-```
-
-> Source: [[./lib/blacklight/solr_helper.rb|https://github.com/projectblacklight/blacklight/blob/master/lib/blacklight/solr_helper.rb#L70]]
-
-
-### Other
-- Stable URLs allow users to bookmark, share, and save search queries for later access
-- Recent searches are saved in the Search History for quick access to previous queries
-- Folder + Bookmarks allow users to collect and keep track of items as they browse
-- Every Blacklight search provides RSS and [[Atom Responses]] of search results 
-- Blacklight supports [[OpenSearch|http://www.opensearch.org/Home]], a collection of simple formats for the sharing of search results. The OpenSearch description document format can be used to describe a search engine so that it can be used by search client applications. The OpenSearch response elements can be used to extend existing syndication formats, such as RSS and Atom, with the extra metadata needed to return search results. (From OpenSearch Introduction)
-
-## Access
-### Export
-- Cite
-- Refworks
-- Endnote
-- Email
-- SMS
-- Librarian View
-
-For compatible records, an [[OpenURL/Z39.88 COinS|http://www.zotero.org/support/dev/making_coins]] object is embedded in each document, which allows plugins like Zotero to easily extract data from the page. 
-
-### Semantic Fields
-
-### Document Extension Framework
-
-The main use case for extensions is for transforming a Document to another
-format. Either to another type of Ruby object, or to an exportable string in
-a certain format. 
-
-An Blacklight::Solr::Document extension is simply a ruby module which is mixed
-in to individual Document instances.  The intended use case is for documents
-containing some particular format of source material, such as Marc. An
-extension can be registered with your document class, along with a block
-containing custom logic for which documents to apply the extension to.
-
-```ruby
-    SolrDocument.use_extension(MyExtension) {|document| my_logic_on_document(document}
-```
-
-MyExtension will be mixed-in (using ruby 'extend') only to those documents
-where the block results in true.
-
-Underlying metadata formats, or other alternative document views, are linked to from the HTML page <head>. 
-
-### Data Formats
-MaRC
-
-## Testing
-
-
-Additional features are available through [[Blacklight Add-ons]].