Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The Islandora Bookmark module allows users to build, manage, share, track via RSS, and export lists of Islandora objects.

...

Gallery
includeObject Detail Page with Add.png, Bookmark List Detail View.png, Solr Results Page With Bookmark.png
columns3
sortdate
titleScreenshots

Dependencies

  • Islandora Core Module
  • Islandora Solr  (optional, provides batch addition to lists)
  • Islandora Bookmark CSV Exports (optional, included as a submodule, provides CSV field configuration, requires Solr)
  • Islandora Bibliography (optional, provides RIS, RTF, and PDF export formats)

Configuration

To configure this module,

  1. Grant permissions to the users who should be able to create bookmark lists.
  2. Configure options for this module including whether users get "Default lists".
  3. Provide a link to "My Bookmarks" (/islandora-bookmarks) for users with bookmark lists.
  4. (Optional) Place the "Islandora bookmark" block so that users can add objects from object pages.
  5. (Optional) Enable and make accessible the Solr display profile so that users can add objects from Solr result pages.
  6. (Optional) Configure export formats.

1. Permissions

Set the permissions for the Bookmark module in Administration » People » Permissions (/admin/people/permissions).

...

Anonymous user's lists are not saved permanently, and cannot be shared. If an anonymous user 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.

2. Module Options

Go to Administration » Islandora » Islandora Utility Modules » Bookmark (/admin/islandora/tools/islandora-bookmark) to configure the module.

  • The "name of the type of list" defaults to "bookmark" so interface cues refer to lists as "bookmark lists", "Export selected bookmarks", etc.  This can be configured to be "favourite lists", "Export selected favourites", for example.
    • Note: This generalization is imperfect and the word "Bookmark" is hard coded in a few places in the interface. Most of them can be overridden by configuring blocks and menus.
  • The "Bookmarks overview table" variable refers to the number of "Bookmark Lists" that appear per page at My Bookmarks (/islandora-bookmarks).
  • "Detailed bookmark table" variable refers to the number of objects that appear per page within a Bookmark list.
  • A "Default list" can be automatically created for users when they log in.
    • If you check this option, you will need to log out and back in for your default list to be created.
    • Users cannot delete their default bookmark list.

3. "My Bookmarks"

The My Bookmarks page is at /islandora-bookmarks. This is where users create and manage their lists, so there should be a way to navigate to it. By default, there is a "My bookmarks" link in the Navigation menu, but not all themes make this available to all users. Consider adding a link to an exposed menu, or placing a custom block.

4. Bookmark Block

The Islandora Bookmark block provides a way to add a single object to a Bookmark list from that object's page. It needs to be configured to appear at Structure » Blocks (/admin/structure/block) in a region such as Content or First Sidebar. It automatically appears on all Islandora object pages. Once an object has been bookmarked, the block will show a link to the bookmark list(s) that contains that object.  (Note:  After you add this block to a region, you may have to clear the cache (Configuration » Performance » Clear all caches) in order to see the new block as you browse pages.)

Info

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

5. "Bookmark" display profile for Solr search results

To allow users to select and bookmark objects based on a Solr search:

...

This mode can also be reached by adding ?display=bookmark to the end of any Solr query URL.

5. Exporting bookmarks

Bookmarks can be exported from a Bookmark List's detail page at /islandora-bookmarks, or from Solr search results if enabled (see #5).

...

The Islandora Bibliography module provides the following formats:  RTF, RIS, PDF. This module uses Bibutils to format object metadata as citations, using configurable citation styles (by default only APA is available). The MODS <genre> tag is used to determine how to format the citation - see "About CSL" on the Scholar Documentation for more information.


Customization

Theme customizations

Table cells referencing the bookmarked objects in both bookmark lists and bookmark Solr results can be modified in one of the following ways:

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


Downloads

Release Notes and Downloads

Installation

Install as usual, see this for further information.