Difference between revisions of "EdShareCollections"

From EPrints Documentation
Jump to: navigation, search
(Introduction)
Line 3: Line 3:
  
 
=Introduction=
 
=Introduction=
The collections plugin is part of [[EdShare]] suite. It is based on code developed in EdShare and LanguageBox. The goal of this project is to produce a package that allows the easy installation of the collections functionality on a vanilla EPrints installation.
+
Collections allow users to group and arbitary set of eprints together. They have their own workflow and workflow component for selecting EPrints to add to the collection. They appear in search results in browse views and go through the normal inbox->buffer->archive->retire life cycle. They can also be configured to have custom abstract pages.
  
'''For installation instructions head to [[EdShareCollectionsInstallation]].'''
+
The collections plugin is part of [http://edshare.org.uk EdShare] suite. It is based on code developed in EdShare and LanguageBox. The goal of this project is to produce a package that allows the easy installation of the collections functionality on a vanilla EPrints installation.
  
==Current Version==
+
==Installation==
The latest version of EdShareCollections is 1.0.2 and can be found at the download site.
+
You can install Collections onto 3.3 series EPrints repository using the EPrints Bazaar. It should be listed in Admin > EPrints Bazaar > Available.
 
+
==Download==
+
The plugin is available for download from http://files.eprints.org.
+
  
 
==Authors==
 
==Authors==
The original collections code was developed by Sebastien Francois and Patrick McSweeny. The EdShare package was created by Marcus Ramsden based upon the original collections code by Sebastien and Patrick.
+
The original collections code was developed by Sebastien Francois and [http://www.ecs.soton.ac.uk/people/pm5 Patrick McSweeney]. Updates and the 3.1.3 version of the package have been made by Marcus Ramsden based upon the original collections code. Collections were packaged for the bazaar by Patrick McSweeney
 +
 
 +
==The Source==
 +
 
 +
The current definitive source can be found  [https://github.com/patrickmcsweeney/Collections on GitHub at https://github.com/patrickmcsweeney/Collections]
  
 
==Copyright==
 
==Copyright==
Line 21: Line 22:
 
This plugin is released under the terms of the GNU General Public License v3. Details of this license can be found [http://www.gnu.org/licenses/gpl.txt here].
 
This plugin is released under the terms of the GNU General Public License v3. Details of this license can be found [http://www.gnu.org/licenses/gpl.txt here].
  
=Features=
+
==Post installation configuration==
  
==Collections==
+
At the time of writing (May 2013) collections render in the same way as any other item in the repository but they have been written to have this behaviour overwritten.
* Allows a user to remix a number of resources into a new resource.
+
  
==Collection Workflow==
+
x_collections.pl you can see the following two lines
* A new workflow has been introduced with this plugin.  
+
* This workflow integrates seamlessly into your installation of EPrints adding an additional button to the ''Manage Items'' screen for the user. It also adds an appropriate editor screen. The workflow does not interfere with the original EPrint workflow.
+
  
==Collection Abstract View==
+
<pre>
* A different abstract view is rendered for collections. The collection workflow is modified in a similar way to eprint abstracts.
+
#overwrite collection_render in order to make a custom render method for collections
 +
$c->{collection_render} = $c->{eprint_render};
 +
</pre>
 +
 
 +
this can be replaced with:
 +
 
 +
<pre>
 +
$c->{collection_render} = sub {
 +
  my( $eprint, $session, $preview ) = @_;
 +
 
 +
  #special rendering for collections goes here
 +
 
 +
  return( $page, $title, $links ); # these three are dom fragments (same as eprint_render)
 +
}
 +
</pre>
 +
 
 +
For some idea of what you might want to do here you might use to take inspiration from [[eprint_render.pl]] - code here: [https://github.com/eprints/eprints/blob/master/lib/defaultcfg/cfg.d/eprint_render.pl]
 +
 
 +
 
 +
==Old Stuff==
 +
'''For installation instructions head to [[EdShareCollectionsInstallation]].'''
  
 
==Bookmarks==
 
==Bookmarks==
 
* Allows a user to create bookmarks of resources that are currently stored within your repository.
 
* Allows a user to create bookmarks of resources that are currently stored within your repository.

Revision as of 10:24, 29 May 2013


EdShare

Edshare logo.png

Supported EPrints Versions 3.2

Project Started 2009

Project Webpage http://edshare.org.uk


Created By ECS, University of Southampton

Introduction

Collections allow users to group and arbitary set of eprints together. They have their own workflow and workflow component for selecting EPrints to add to the collection. They appear in search results in browse views and go through the normal inbox->buffer->archive->retire life cycle. They can also be configured to have custom abstract pages.

The collections plugin is part of EdShare suite. It is based on code developed in EdShare and LanguageBox. The goal of this project is to produce a package that allows the easy installation of the collections functionality on a vanilla EPrints installation.

Installation

You can install Collections onto 3.3 series EPrints repository using the EPrints Bazaar. It should be listed in Admin > EPrints Bazaar > Available.

Authors

The original collections code was developed by Sebastien Francois and Patrick McSweeney. Updates and the 3.1.3 version of the package have been made by Marcus Ramsden based upon the original collections code. Collections were packaged for the bazaar by Patrick McSweeney

The Source

The current definitive source can be found on GitHub at https://github.com/patrickmcsweeney/Collections

Copyright

EdShare Collections, University of Southampton ©2009

This plugin is released under the terms of the GNU General Public License v3. Details of this license can be found here.

Post installation configuration

At the time of writing (May 2013) collections render in the same way as any other item in the repository but they have been written to have this behaviour overwritten.

x_collections.pl you can see the following two lines

#overwrite collection_render in order to make a custom render method for collections
$c->{collection_render} = $c->{eprint_render};

this can be replaced with:

$c->{collection_render} = sub {
  my( $eprint, $session, $preview ) = @_;

  #special rendering for collections goes here

  return( $page, $title, $links ); # these three are dom fragments (same as eprint_render)
}

For some idea of what you might want to do here you might use to take inspiration from eprint_render.pl - code here: [1]


Old Stuff

For installation instructions head to EdShareCollectionsInstallation.

Bookmarks

  • Allows a user to create bookmarks of resources that are currently stored within your repository.