From EPrints Documentation
Revision as of 14:27, 16 December 2009 by Mmr@ecs.soton.ac.uk (talk | contribs) (Installation)
Jump to: navigation, search


The EdShareToolbox is a very simple plugin that allows a repository administrator to easily add links to carry out actions on EPrint items.


The EdShareToolbox was created by Marcus Ramsden.


EdShare Toolbox, Copyright © 2009 University of Southampton

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


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 toolbox-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 toolbox CGI script to the EPrints CGI directory;

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


Having your plugin register an action on the toolbox is very simple. All you need to do is add a render_toolbox_item function to your plugin. This function is expected to return a DOM node that will be appended to a list element in the toolbox.

Static Rendered Actions

Dynamic Rendered Actions

If your action fires it's own ajax based request then you need to make a call to ep_refresh_edshare_toolbox.