Blacklight is an open source, Ruby on Rails engine/gem that provides a discovery interface for Apache 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:
A demo application 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.
Blacklight provides a Ruby on Rails -based interface to the Apache Solr Enterprise Search Server. More information about Solr is available at the Solr web site. In order to fully understand how to develop a Blacklight-based application, you should also be familiar with Solr, ways to index data into Solr, how to configure request handlers, and how to change a Solr schema. Those topics are covered in the official Apache Solr Tutorial.
There are many ways to override specific behaviors and views in Blacklight. Blacklight is distributed as a Rails engine-based gem. All customization of Blacklight behavior should be done within your application by overriding Blacklight-provided behaviors with your own.
If you find that there is no other way to make your customization, please describe your problem on the mailing list -- 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.
Don't be scared to ask a question on the Blacklight mailing list. 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
#blacklight. Stop in and say hi, we're happy to help with questions when we have time. http://freenode.net/faq.shtml.
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:
Last edited by Chris Beer,