README.rdoc in blacklight_unapi-0.0.3 vs README.rdoc in blacklight_unapi-0.1.0
- old
+ new
@@ -16,19 +16,19 @@
gem "blacklight_unapi"
to your Gemfile and run "bundle install".
-Then, run "rails generate blacklight_unapi" to install the unAPI configuration and hooks into the CatalogController.
+Then, run "rails generate blacklight_unapi:install" to install the unAPI configuration and hooks into the CatalogController.
= Configuration
See ./config/initializers/blacklight_config for unAPI configuration options, where you can list the default set of document formats (which must be available for every document served).
Out of the box, only the OAI Dublin Core XML format is advertised as it can be be automatically generated from the Blacklight "semantic fields" configuration. Other common export formats must be defined within the Blacklight configuration. Implementors SHOULD customize this list using the [[Blacklight.config[:unapi]|https://github.com/projectblacklight/blacklight/blob/master/config/initializers/blacklight_config.rb#L263]] hash, which is formatted as the [Blacklight::Solr::Document#export_formats](https://github.com/projectblacklight/blacklight/blob/master/lib/blacklight/solr/document.rb#L155) output, e.g.:
- config[:unapi] = {
+ config.unapi = {
'oai_dc_xml' => { :content_type => 'text/xml' },
'marc' => { :content_type => 'application/marc' },
'jpg' => { :content_type => 'image/jpg' }
}
@@ -66,12 +66,9 @@
Source: [[http://demo.projectblacklight.org/catalog/unapi]]
=== /catalog/unapi?id=IDENTIFIER
Provides a list of object formats available for the object identified by "IDENTIFIER". The object formats are generated from the Document Extension Framework [Blacklight::Solr::Document#export_formats](https://github.com/projectblacklight/blacklight/blob/master/lib/blacklight/solr/document.rb#L155).
-
-In the future, Blacklight may provide mechanisms within the Document Extension Framework for filtering the list of object formats (see [CODEBASE-301](http://jira.projectblacklight.org/jira/browse/CODEBASE-301)). In the meantime, to filter this list of object formats, implementors are encouraged to override [./app/views/catalog/unapi.xml.builder](https://github.com/projectblacklight/blacklight/blob/master/app/views/catalog/unapi.xml.builder) (or CatalogController#unapi) locally.
-
<?xml version="1.0" encoding="UTF-8"?>
<formats id="u1">
<format type="text/plain" name="refworks_marc_txt"/>
<format type="text/xml" name="dc_xml"/>