/islandora_bookmark

Allows creation and management of lists of PIDs that are attached to a Drupal user, and can be shared with other users. These lists can be used to track and sort PIDs, or to export lists of citations. The module can also be used in conjunction with Solr search results to perform some export tasks.

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

Islandora Bookmark Build Status

Introduction

The Islandora Bookmark module allows users to build, manage, share and track lists of objects. Manage your bookmarks under /islandora-bookmark. 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.

Requirements

This module requires the following modules/libraries:

Installation

Install as usual, see this for further information.

Configuration

Configure general bookmark settings in Administration » Islandora » Islandora Utility Modules » Bookmark (admin/islandora/tools/islandora-bookmark).

Configuration

Enable 'Bookmark' in Administration » Islandora » Solr index » Solr Settings (admin/islandora/search/islandora_solr/settings).

Set the permissions in Administration » People (admin/people/permissions). There are permissions to administer, use, and share bookmarks. Anonymous users can never share bookmarks.

The admin page has an option to create a default bookmark list for each individual user (Users cannot delete their default lists). The first time you enable default bookmark lists, you will have to log out and log back in before you can view your default list.

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

Customization

Table cells referencing the bookmarked objects in both bookmark lists and bookmark Solr results can be modified. One way is by overriding the default template file located at theme/islandora-bookmark-object-display.tpl.php. Another way is to use hook_islandora_bookmark_object_markup() to let another module define the content and markup.

Documentation

Further documentation for this module is available at our wiki.

Troubleshooting/Issues

Having problems or solved a problem? Check out the Islandora google groups for a solution.

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.

Maintainers/Sponsors

Current maintainers:

Development

If you would like to contribute to this module, please check out CONTRIBUTING.md. In addition, we have helpful Documentation for Developers info, as well as our Developers section on the Islandora.ca site.

License

GPLv3