Difference between revisions of "EdShareToolbox"

From EPrints Documentation
Jump to: navigation, search
(Usage)
Line 18: Line 18:
  
 
=Usage=
 
=Usage=
 +
Having your plugin register an action on the toolbox is very simple. All you need to do is add a <code>render_toolbox_item</code> 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==
 
==Static Rendered Actions==
  
 
==Dynamic Rendered Actions==
 
==Dynamic Rendered Actions==
 +
If your action fires it's own ajax based request then you need to make a call to <code>ep_refresh_edshare_toolbox</code>.

Revision as of 14:26, 16 December 2009

Introduction

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

Authors

The EdShareToolbox was created by Marcus Ramsden.

Copyright

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.

Installation

Install CGI Scripts

Link the toolbox CGI script to the EPrints CGI directory;

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

Usage

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.