EdShareToolbox - Revision history

Mmr@ecs.soton.ac.uk at 14:44, 10 February 2010

2010-02-10T14:44:27Z

← Older revision		Revision as of 14:44, 10 February 2010
Line 1:		Line 1:
	[[Category:EdShare]]		[[Category:EdShare]]
			{{EdShare}}
	=Introduction=		=Introduction=
	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 is a very simple plugin that allows a repository administrator to easily add links to carry out actions on EPrint items.

2010-02-08T14:05:52Z

← Older revision		Revision as of 14:05, 8 February 2010
Line 1:		Line 1:
			[[Category:EdShare]]
	=Introduction=		=Introduction=
	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 is a very simple plugin that allows a repository administrator to easily add links to carry out actions on EPrint items.

2009-12-16T16:03:48Z

@@ Line 26: / Line 26: @@
   ln -s /opt/eprints3/archives/ARCHIVEID/cgi/edsharetoolbox/ /opt/eprints3/cgi/
-=Usage=
+==Modify Plugins==
-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.
+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. You then just need to add the name of the plugin to the ''archives/ARCHIVEID/cfg/cfg.d/edsharetoolbox.pl'' file.
-==Static Rendered Actions==
+Here is an example for EPrints::Plugin::Foo.
-==Dynamic Rendered Actions==
+First in EPrints::Plugin::Foo we add the following <code>render_toolbox_item</code> function;
-If your action fires it's own ajax based request then you need to make a call to <code>ep_refresh_edshare_toolbox</code>.

2009-12-16T14:28:55Z

Installation

← Older revision		Revision as of 14:28, 16 December 2009
Line 11:		Line 11:

	=Installation=		=Installation=
			Installation should be relatively simple and similar to the installation of other plugins from the EdShare family.

	==Extract Package==		==Extract Package==

2009-12-16T14:27:56Z

Installation

← Older revision		Revision as of 14:27, 16 December 2009
Line 11:		Line 11:

	=Installation=		=Installation=

			==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==		==Install CGI Scripts==

2009-12-16T14:26:31Z

Usage

← Older revision		Revision as of 14:26, 16 December 2009
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>.

2009-12-16T12:21:47Z

← Older revision		Revision as of 12:21, 16 December 2009
Line 11:		Line 11:

	=Installation=		=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=		=Usage=

2009-12-16T12:01:15Z

Usage

2009-12-16T11:59:25Z

2009-12-16T11:59:05Z

← Older revision		Revision as of 11:59, 16 December 2009
Line 6:		Line 6:

	==Copyright==		==Copyright==
	EdShare Toolbox, Copyright &copy 2009 University of Southampton		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 [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].

	=Installation=		=Installation=