Current Release
This documentation covers the latest release of Islandora 7.x. For the very latest in Islandora, we recommend Islandora 8.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

Overview

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

A user's lists are managed at /islandora-bookmark. Objects can be added to existing 'bookmark lists' in two ways:

  1. Through individual object pages: if the "Islandora Bookmark" block has been enabled, it will allow users to bookmark the current object.
  2. Through Solr searches: if the "Bookmark" Solr display profile (and Solr itself) is enabled, users can select and add objects to their bookmark lists from search result pages. This also allows direct export of objects from search result pages.

Users can share lists (view-only) with other users, or the world. If available to the world, an RSS feed can be used to track changes to the list.

Lists can be exported as CSV (default fields: Title, PID). The included submodule, Islandora Bookmark CSV Exports, allows administrators to configure CSV fields from Solr. The Islandora Bibliography module also supplies additional export formats (RIS, RTF, and PDF) which treat the object metadata as citation data and format it accordingly.

Screenshots:






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 /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 to allow users to 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).

  • Administer Islandora Bookmark - This is the permission for changing the module configuration settings, and should only be granted to administrators.
  • Use Islandora Bookmark - Create, manage, and add new bookmarks to bookmark lists. Grant to any role that needs to be able to add bookmarks to a list, including anonymous users (users without an account).
  • Share bookmarks - Share bookmarks with other users, including Everyone (the public).
  • Export bookmarks - Export bookmark lists.

Anonymous user's lists are not saved permanently, and cannot be shared.

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. 
  • The "Bookmarks overview table" refers to the number of "Bookmark Lists" that appear per page at My Bookmarks (/islandora-bookmarks).
  • "Detailed bookmark table" 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.
    • 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.
    • 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 the Content or First Sidebar. It automatically appears on all pages for Islandora objects.  (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.)


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

5. Bookmark Search Results

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

  1. Enable the 'Bookmark' Display Profile in Administration » Islandora » Solr index » Solr Settings (admin/islandora/search/islandora_solr/settings).
  2. Either make it the default display profile,  or place the 'Islandora Displays' block in a visible region (admin/structure/block) to allow the user to toggle between enabled Solr display profiles.

Using Bookmarks and Lists

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.

Managing Bookmarks and Lists

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


View the bookmarks in a list

On the 'Overview' tab of "My bookmarks", 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.

Exporting the bookmarks in a list

You can export bookmark lists in the following formats:  RTF, RIS, PDF (as citations, default in APA), or csv (title, pid). If you also enable the module Islandora Bookmark CSV Exports, then you can configure the fields to include in the CSV.

For the export of PDF formatted citation lists according to APA, the default format is to pull from metadata and format the cite as an article.  The exporter looks to the MODS <genre> field for each item to determine how to format the cite.  If MODS reads <genre>book chapter</genre> or <genre>book section</genre>, then it will format as a book chapter in APA.  If MODS reads <genre>book</genre> then it will format like a book.  So, with consistent use of the <genre> field and good metadata can give you a good export of cites to material on your site.

To export, click to /islandora-bookmark and click to the list you want to export.  Then under "Export", use the drop down menu to select an export format and export the list.

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.

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.


Downloads

Release Notes and Downloads

Installation

Install as usual, see this for further information.

  • No labels

For more information please visit https://islandora.ca/