Difference between revisions of "EdShareCollectionsInstallation"

From EPrints Documentation
Jump to: navigation, search
(→‎Customisation)
Line 23: Line 23:
  
 
  ln -s /opt/eprints3/archives/ARCHIVEID/cgi/collectionselect/ /opt/eprints3/cgi/
 
  ln -s /opt/eprints3/archives/ARCHIVEID/cgi/collectionselect/ /opt/eprints3/cgi/
 +
 +
===Patch the default workflow===
  
 
===Edit Configuration Files===
 
===Edit Configuration Files===
 +
 +
====archive/ARCHIVEID/cfg/namedsets/eprint====
 +
Add <code>collection</code> to the ''types for eprint'' list. The position it is in this list will be the position it will appear when choosing a type in the new item workflow.
  
 
====archive/ARCHIVEID/cfg/cfg.d/eprints_warnings.pl====
 
====archive/ARCHIVEID/cfg/cfg.d/eprints_warnings.pl====
Line 36: Line 41:
  
 
This should stop the warning from appearing.
 
This should stop the warning from appearing.
−
 
−
===Edit Core Files===
 
−
 
−
====perl_lib/EPrints/Plugin/Screen/EPrint.pm====
 
−
Look for the workflow subroutine in this file and comment out the following line:
 
−
 
−
$self->{processor}->{$cache_id} = EPrints::Workflow->new( $self->{session}, "default", %opts );
 
−
 
−
Then add in the following two lines:
 
−
 
−
my $workflow_id = $self->workflow_id;
 
−
$self->{processor}->{$cache_id} = EPrints::Workflow->new( $self->{session}, $workflow_id, %opts );
 
−
 
−
Finally after the workflow subroutine add the following subroutine;
 
−
 
−
sub workflow_id
 
−
{
 
−
        return 'default';
 
−
}
 
−
 
−
===Update Database Tables===
 
−
The EdShare collections package requires an additional database field. To get this setup all you need to do is run;
 
−
 
−
bin/epadmin update_database_structure ARCHIVEID
 
  
 
===Restart Web Server===
 
===Restart Web Server===
Line 65: Line 46:
  
 
==Customisation==
 
==Customisation==
−
'''When editing anything in ''archives/ARCHIVEID/cfg/cfg.d/z_collection.pl'' take care not to change anything after the warning, unless you know what you want to do with the settings, as these are critical to the functionality of the EdShare Collections plugin.'''
 
−
 
 
A level of customisation is possible with collections. All of the settings for the plugin can be found in ''archives/ARCHIVEID/cfg/cfg.d/z_collection.pl''. The main setting of interest is ''collection_render''. This subroutine is similar to ''eprint_render'' but it does a special case render for collections. A default is supplied but you are free to customise this to your requirements. One thing to note is that the function '''must''' return 3 values. Look at the default ''collection_render'' subroutine for an example.
 
A level of customisation is possible with collections. All of the settings for the plugin can be found in ''archives/ARCHIVEID/cfg/cfg.d/z_collection.pl''. The main setting of interest is ''collection_render''. This subroutine is similar to ''eprint_render'' but it does a special case render for collections. A default is supplied but you are free to customise this to your requirements. One thing to note is that the function '''must''' return 3 values. Look at the default ''collection_render'' subroutine for an example.
  
Line 72: Line 51:
  
 
There are other settings in the file but you should avoid changing anything below the supplied note unless you know what you are doing.
 
There are other settings in the file but you should avoid changing anything below the supplied note unless you know what you are doing.
−
 
−
==Testing==
 
−
 
−
# Login as a user to your EPrints install and go to the ''Manage Deposits'' page. There should be a new button labelled ''Create Collection''.
 
−
# First ensure that you can still create an EPrint in the usual manner using ''New Item''.
 
−
# Head back to the ''Manage Deposits'' page and choose ''Create Collection''.
 
−
# Give your collection a name.
 
−
# Search for an EPrint and add it to the collection, it should appear in a list in the ''Items In The Collection'' section.
 
−
# Remove that EPrint from the collection by clearing the tick next to it, the list should now be empty.
 
−
# Add an EPrint from My Deposits.
 
−
# Submit the Collection and deposit it in the standard way.
 
−
# Go to the appropriate resource page for the published collection and ensure that there is the correct number of items in the collection.
 
  
 
==Bugs==
 
==Bugs==
 
Please report all bugs to the [http://lslvm-mmr4.ecs.soton.ac.uk/ OneShare Bugtracker]. There is a project setup for OneShare collections called ''OneShare Packages >> Collections''.
 
Please report all bugs to the [http://lslvm-mmr4.ecs.soton.ac.uk/ OneShare Bugtracker]. There is a project setup for OneShare collections called ''OneShare Packages >> Collections''.

Revision as of 15:05, 25 November 2009

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.

For more details about this plugin see EdShareCollections.

Requirements

The EdShare Collections plugin has been tested and confirmed to run on EPrints 3.1.3.

Installation

As with all package installations it is important to remember to backup your installation of EPrints before continuing.

Extract Package

The package should be extracted in the appropriate archive directory of your EPrints installation. Run the following commands replacing ARCHIVEID with the name of the archive you want the collections on, and replace VERSION with the appropriate version number based on the package you have downloaded; 

cd /opt/eprints3/archives/ARCHIVEID
tar -xzf collections-VERSION.tar.gz

These commands assume that you installed EPrints to /opt/eprints3 substitute this for something else if you installed it elsewhere. Users of the Ubuntu version of EPrints will find that it is installed by default at /usr/share/eprints3.

Install CGI Scripts

Link the collections CGI scripts to the EPrints CGI directory: 

ln -s /opt/eprints3/archives/ARCHIVEID/cgi/collectionselect/ /opt/eprints3/cgi/

Patch the default workflow

Edit Configuration Files

archive/ARCHIVEID/cfg/namedsets/eprint

Add collection to the types for eprint list. The position it is in this list will be the position it will appear when choosing a type in the new item workflow.

archive/ARCHIVEID/cfg/cfg.d/eprints_warnings.pl

You will need to add an exception here to stop warnings appearing for users when they deposit a collection. A warning will appear because no files have been loaded for the collection but this is fine. If you have not edited this file before look for the following line; 

if( @docs == 0 )

Replace it with the following; 

if( $eprint->get_type ne 'collection' && @docs == 0 )

This should stop the warning from appearing.

Restart Web Server

Once you have completed all of these previous steps, you will need to restart your web server in the usual fashion.

Customisation

A level of customisation is possible with collections. All of the settings for the plugin can be found in archives/ARCHIVEID/cfg/cfg.d/z_collection.pl. The main setting of interest is collection_render. This subroutine is similar to eprint_render but it does a special case render for collections. A default is supplied but you are free to customise this to your requirements. One thing to note is that the function must return 3 values. Look at the default collection_render subroutine for an example.

If you do change the collection_render subroutine you will need to run the bin/generate_abstracts ARCHIVEID script in order to see any changes you have made reflected in your repository.

There are other settings in the file but you should avoid changing anything below the supplied note unless you know what you are doing.

Bugs

Please report all bugs to the OneShare Bugtracker. There is a project setup for OneShare collections called OneShare Packages >> Collections.

Retrieved from ‘https://wiki.eprints.org/w/index.php?title=EdShareCollectionsInstallation&oldid=7947’