README.rdoc in fcrepo_admin-0.3.0 vs README.rdoc in fcrepo_admin-0.3.1
- old
+ new
@@ -2,11 +2,12 @@
A Rails engine providing an administrative interface to a Fedora Commons repository built on the Hydra project framework.
=== Status
-This project is at an early stage of development. It should be considered experimental and not ready for production deployment.
+This project should be considered *experimental* and not ready for production deployment.
+Versions earlier than 1.0 may change API and/or UI without notice or regard for backward compatibility.
=== Requirements
fcrepo_admin is designed for installation on hydra-head 6.0.0 or higher.
See https://github.com/projecthydra/hydra-head/wiki/Installation-Prerequisites.
@@ -35,45 +36,24 @@
mount FcrepoAdmin::Engine => '/admin', :as=> 'fcrepo_admin'
You may replace <code>'/admin'</code> with any mount point (except perhaps <code>'/catalog'</code>),
including <code>'/'</code>. All routes include <code>objects</code> as a subpath.
-* Add abilities to your Ability class
-
- In app/models/ability.rb add this line after the Hydra abilities:
-
- include FcrepoAdmin::DatastreamAbility
-
-* Extend the SolrDocument model
-
- In app/models/solr_document.rb add this line:
-
- use_extension FcrepoAdmin::SolrDocumentExtension
-
- (This may only be necessary if customizing the catalog show page as indicated below.)
-
* Add Javascript
In app/assets/javascripts/application.js add this line:
//= require bootstrap-tab
-* Add CSS
+* Customize catalog search results (optional)
- In app/assets/stylesheets/application.css add this line:
+ If you would like items from the catalog search results list to the object admin view
+ instead of the catalog show view, create app/helpers/blacklight_helper.rb with this content:
- //= require fcrepo_admin/fcrepo_admin
-
-* Customize catalog show page (optional)
-
- If you would like to add Fedora object information to the catalog show page,
- copy the partial <code>app/views/catalog/_show_default.html.erb</code> from the Blacklight
- gem to your application, then add to the bottom of the file:
-
- <%= render :partial => 'fcrepo_admin/catalog/show', :locals => {:document => document} %>
-
- Use Blacklight's config options in CatalogController to control the basic content on the show page
- (HTML title, page title, and list of the fields/values at the top of the page).
+ module BlacklightHelper
+ include Blacklight::BlacklightHelperBehavior # Default Blacklight behaviors
+ include FcrepoAdmin::BlacklightHelperBehavior # fcrepo_admin overrides
+ end
=== License
See the LICENSE file in the root directory of the project for copyright and license information.