forked from Islandora/islandora_bookmark
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request Islandora#2 from Islandora/7.x
7.x update
- Loading branch information
Showing
31 changed files
with
2,405 additions
and
344 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,6 +2,7 @@ language: php | |
php: | ||
- 5.3.3 | ||
- 5.4 | ||
- 5.5 | ||
branches: | ||
only: | ||
- 7.x | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,55 +1,67 @@ | ||
BUILD STATUS | ||
------------ | ||
Current build status: | ||
[![Build Status](https://travis-ci.org/Islandora/islandora_bookmark.png?branch=7.x)](https://travis-ci.org/Islandora/islandora_bookmark) | ||
# Islandora Bookmark [![Build Status](https://travis-ci.org/Islandora/islandora_bookmark.png?branch=7.x)](https://travis-ci.org/Islandora/islandora_bookmark) | ||
|
||
CI Server: | ||
http://jenkins.discoverygarden.ca | ||
## Introduction | ||
|
||
ISLANDORA BOOKMARK | ||
================== | ||
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: | ||
|
||
SUMMARY | ||
------- | ||
|
||
The Islandora Bookmark module allows users to build, manage, share and track lists of objects. | ||
Manage your bookmarks under /islandora_bookmark. There's 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 | ||
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 | ||
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: | ||
|
||
* [Islandora](https://github.com/islandora/islandora) | ||
* [Tuque](https://github.com/islandora/tuque) | ||
* [Islandora Solr](https://github.com/islandora/islandora_solr_search) (optional) | ||
|
||
|
||
## Installation | ||
|
||
Install as usual, see [this](https://drupal.org/documentation/install/modules-themes/modules-7) for further information. | ||
|
||
## Configuration | ||
|
||
Configure general bookmark settings in Administration » Islandora » Islandora Utility Modules » Bookmark (admin/islandora/tools/islandora-bookmark). | ||
|
||
![Configuration](https://camo.githubusercontent.com/e851eaa47d5ba712ff7e8579a91dd6da2b38ae64/687474703a2f2f692e696d6775722e636f6d2f7664747444534d2e706e67) | ||
|
||
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. | ||
|
||
## Troubleshooting/Issues | ||
|
||
Having problems or solved a problem? Check out the Islandora google groups for a solution. | ||
|
||
REQUIREMENTS | ||
------------ | ||
* [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora) | ||
* [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev) | ||
|
||
* Islandora | ||
* Islandora Solr (optional) | ||
## FAQ | ||
|
||
Q. How do I set up bookmarking through Solr? | ||
|
||
CONFIGURATION | ||
------------- | ||
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. | ||
|
||
* General settings can be configured on the admin page at admin/islandora/islandora_bookmark. | ||
* In the solr client admin page (admin/islandora/search/islandora_solr), enable the Islandora Bookmark | ||
display profile. | ||
* Set the permissions: there are permissions to administer, use and share bookmarks. Anonymous users can never | ||
share bookmarks. | ||
## Maintainers/Sponsors | ||
Current maintainers: | ||
|
||
CUSTOMIZATION | ||
------------- | ||
* [Jordan Dukart](https://github.com/jordandukart) | ||
|
||
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. | ||
## Development | ||
|
||
If you would like to contribute to this module, please check out our helpful [Documentation for Developers](https://github.com/Islandora/islandora/wiki#wiki-documentation-for-developers) info, as well as our [Developers](http://islandora.ca/developers) section on the Islandora.ca site. | ||
|
||
TROUBLESHOOTING | ||
--------------- | ||
## License | ||
|
||
* How do I set up bookmarking through Solr? | ||
|
||
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. | ||
[GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
.islandora-bookmark-list-column { | ||
display: inline-block; | ||
max-width: 16em; | ||
margin: 0.1em; | ||
vertical-align: text-top; | ||
text-align: center; | ||
} | ||
.islandora-bookmark-list-column > div { | ||
margin: 0.2em; | ||
background-color: #E4E4E4; | ||
border-style: solid; | ||
border-width: 0.1em; | ||
} | ||
.islandora-bookmark-list-column img { | ||
max-width: 15em; | ||
display: block; | ||
/*Center alignment.*/ | ||
margin-left: auto; | ||
margin-right: auto; | ||
} | ||
.list-links { | ||
float: right; | ||
margin: 0.2em; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
.list-links { | ||
float: right; | ||
margin: 0.2em; | ||
} |
Oops, something went wrong.