https://github.com/projectblacklight/blacklight_folders
Allow grouping of blacklight bookmarks into user created reference folders
https://github.com/projectblacklight/blacklight_folders
Last synced: 11 months ago
JSON representation
Allow grouping of blacklight bookmarks into user created reference folders
- Host: GitHub
- URL: https://github.com/projectblacklight/blacklight_folders
- Owner: projectblacklight
- License: other
- Created: 2014-10-13T16:25:13.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-04-21T18:43:29.000Z (about 10 years ago)
- Last Synced: 2025-04-03T03:47:07.355Z (about 1 year ago)
- Language: Ruby
- Size: 258 KB
- Stars: 6
- Watchers: 28
- Forks: 7
- Open Issues: 12
-
Metadata Files:
- Readme: README.rdoc
- License: LICENSE
Awesome Lists containing this project
README
{
}[https://travis-ci.org/projectblacklight/blacklight_folders]
= Blacklight Folders
{
}[https://cloud.githubusercontent.com/assets/92044/5508092/f2ad37b0-876e-11e4-8f73-f08afe23c17b.png]
---
{
}[https://cloud.githubusercontent.com/assets/92044/5416801/a437a8c0-81f8-11e4-9285-01d230caf80c.png]
---
{
}[https://cloud.githubusercontent.com/assets/92044/5416800/a434b49e-81f8-11e4-85a0-d302aa5c7e24.png]
---
== To create a new blacklight application with blacklight_folders
* Create a new rails application
* Add the blacklight gem and the blacklight_folders gem to your Gemfile
* Run bundle install
* Run the blacklight generator with the --devise switch, following the {instructions on the blacklight wiki}[https://github.com/projectblacklight/blacklight/wiki/Quickstart#creating-a-new-application-the-hard-way] to set up your blacklight app. _NOTE:_ If you're using blacklight_folders for a library catalog, you probably want the --marc switch as well; if you're running it locally (for testing, etc.), you probably want the --jettywrapper switch too.
$ rails g blacklight:install --devise --marc --jettywrapper
* Run the blacklight_folders generator
$ rails g blacklight_folders:install
== To add blacklight_folders to an existing blacklight application
* Add the blacklight_folders gem to your Gemfile, and run bundle install
* Run the blacklight_folders generator
$ rails g blacklight_folders:install
==== Migrate Existing Data
* If your blacklight app has existing users that already have bookmarks saved, run the migration task to add each user's existing bookmarks to their default folder.
$ rake blacklight_folders:db:migrate_data
== Configuration
* By default, the user's 5 most recently updated folders will appear in the drop-down menu in the navigation bar. If you want to change the number of folders that appear in the list, you can set the MENU_LIMIT constant in an initializer (config/initializers/blacklight_folders.rb).
Blacklight::Folders::Folder::MENU_LIMIT = 5
* If you wish to change the name of each user's default folder, override the entry for default_folder_name in the localization files, using the config/locales/blacklight_folders.en.yml file as an example.
---
{Developers Guide}[https://github.com/projectblacklight/blacklight_folders/wiki/Developer-Guide]