<img src=“https://travis-ci.org/projectblacklight/blacklight_folders.svg?branch=master” alt=“Build Status” />

Blacklight Folders¶ ↑

---

---

---

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 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