Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added more description from Github and own notes.

...

The Islandora Bookmark module allows users to build, manage, share, track and export lists of Islandora objects. The module includes the following components: There are two ways to add bookmarks to your lists:

  1. Through object pages: every object page will have a little tool at the bottom to bookmark the current object.
  2. Through Solr searches: Islandora Bookmark provides a SOLR display with functionality to bookmark objects based on a custom Solr query
  3. A page at /islandora_bookmark for users to manage their bookmark lists.
  4. A bookmark tool that appears on every object page.
  5. A Solr display profile for generating bookmarks from Islandora search results.

Dependencies

Downloads

Release Notes and Downloads

Installation

Unzip this module into your site's modules directory as you would any other contrib module. SInstall as usual, see this for further information.

...

After you have installed and enabled the Islandora Bookmark module, go to Administration » Islandora » Islandora Utility Modules » Bookmark (admin/islandora/tools/islandora-bookmark) to configure the module.

Image Modified

Select "Create a default list for users?" and click Save Configuration.  After you log out and back in, a default bookmark list will be created for your user accountIf a user is anonymous, adds items to a bookmark list, and then logs in those items will be added to a new list, or appended to their default list.

Info

Users cannot delete their default bookmark list.

...

Add the Islandora Bookmark tool to a block that is used on object pages (admin/structure/block) such as the Content or First Sidebar blocks.

Screenshot of the Islandora Bookmark tool appearing at the bottom of the Content BlockImage Modified

 

Info

The Bookmark Tool will not display until at least one list exists for bookmarks to be added to.

 

Bookmark Search Results

To create a display of objects that can be bookmarked based on the results of an Islandora search:

...

Once you have bookmarked an object, the Islandora Bookmark tool will show a link to the bookmark list that contains that object.

Bookmarking an object from search results

  1. Search in the Islandora simple search or advanced search.
  2. In the "Islandora Displays" block, click "Bookmark." Enable this block to see the displays (admin/structure/block).
    1. You can also access the Solr bookmark display by adding ?display=bookmark to the end of any Solr query URL.
  3. Use the Bookmark Solr display to export all results or create a new bookmark list from some or all of the search results.

...

When logged in, users can view their bookmark lists and create new lists at http://path.to.your.site/islandora-bookmark.

Add a new bookmark list

  1. Click on the 'Add' tab
  2. Enter a list name and description.
  3. Click Add list

View the bookmarks in a list

On the 'Overview' tab, click a list name. The 'Detailed list' view shows a list of all the objects that you have bookmarked. From the detailed list, you can remove one or all bookmarks, export some or all bookmarks, or share the list with other users. Clicking on the label takes you to the bookmarked object.

...

  • Overriding the default template file located at theme/islandora-bookmark-object-display.tpl.php.
  • Using hook_islandora_bookmark_object_markup() to let another module define the content and markup.

FAQ

Q. How do I set up bookmarking through Solr?

A. Islandora Bookmark provides a Islandora Solr primary display which has to be enabled in the solr client admin page (admin/islandora/search/islandora_solr). To set up Islandora Solr check the module's documentation. Islandora Solr comes with a 'Display switch' block which lets you switch primary displays. When enabled, the bookmark display can be accessed by appending ?display=bookmark to the Solr results URL.