Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 31 lines (23 sloc) 2.01 kb
86ce97f @jkeck Initial commit
jkeck authored
1 This is an advanced search plugin for Blacklight ( http://www.projectblacklight.org ). It is meant to be installed alongside the Blacklight plugin in your application's vendor/plugins directory.
61f5f55 @jkeck cleaning up rdoc
jkeck authored
2
86ce97f @jkeck Initial commit
jkeck authored
3 This plugin is currently in an ALPHA release and is experimental. Better installation instructions, more tests, and documentation will be coming soon. There are also a few very minor changes that will be made in the Blacklight plugin which will be needed to make this work properly.
4
606d346 @jkeck Changing instructions for when there is no config file to use rake ta…
jkeck authored
5 == Pre-requisites:
483722b @jkeck Little more rdoc cleanup.
jkeck authored
6 * The Blacklight plugin ( http://github.com/projectblacklight/blacklight )
7 * RubyTree gem ( http://rubytree.rubyforge.org/ )
8 * An appropriate solr request handler for advanced search.
9 * See advanced_search request handler in blacklight-jetty ( http://github.com/projectblacklight/blacklight-jetty ) for an example.
86ce97f @jkeck Initial commit
jkeck authored
10
11 == Installation:
12 Clone the advanced search plugin from github into your application's vendor/plugins directory
483722b @jkeck Little more rdoc cleanup.
jkeck authored
13 * cd into your application's vendor/plugins directory and run the following command:
14 git clone http://github.com/projectblacklight/blacklight_advanced_search.git
86ce97f @jkeck Initial commit
jkeck authored
15
16 Now run the template installer from your application.
483722b @jkeck Little more rdoc cleanup.
jkeck authored
17 * cd back to your application's root directory then run the the following command:
18 rake rails:template LOCATION=vendor/plugins/blacklight_advanced_search/template.rb
86ce97f @jkeck Initial commit
jkeck authored
19
20 == Configuration:
21 This plugin will copy a configuration file in your application's config/initializers directory named blacklight_advanced_search_config.rb.
61f5f55 @jkeck cleaning up rdoc
jkeck authored
22
86ce97f @jkeck Initial commit
jkeck authored
23 This configuration has several important components:
483722b @jkeck Little more rdoc cleanup.
jkeck authored
24 * search_field needs to be the name of your advanced search request handler.
25 * fields is an array of the actual fields that we want in our form. This is used in a couple of different places so that we can pass the appropriate parameters around as well as build the advanced search form.
26 * Then there should be an element in the hash for every key in fields.
27 * This contains the pf and/or qf in your request handler.
61f5f55 @jkeck cleaning up rdoc
jkeck authored
28
483722b @jkeck Little more rdoc cleanup.
jkeck authored
29 Example:
30 :author => {:qf => "qf_author",:pf => "pf_author"}
Something went wrong with that request. Please try again.