Instructions for local plugins - Revision history

Af05v@ecs.soton.ac.uk at 11:38, 21 January 2015

2015-01-21T11:38:24Z

2015-01-15T12:15:54Z

2010-10-19T09:50:47Z

2010-10-19T09:50:28Z

2010-10-19T09:50:12Z

2010-10-18T15:00:42Z

2010-10-18T11:15:59Z

2010-10-18T11:15:43Z

2010-10-18T11:03:48Z

2010-10-18T11:01:51Z

@@ Line 33: / Line 33: @@
 I have found that running ~/bin/epadmin reload ARCHIVEID doesn't always pick these changes up - you might need to restart Apache to see what you've done!
-If it still doesn't work, check that you don't have any other plugins running which are instantiating the changed plugin.  For example:
+=== Troubleshooting ===
-Local plugin: EPrints/Plugin/Screen/EPrint/MyUploadMethod.pm
+Note that the above only works for plugins that are actually rendered by EPrints.   Superclass plugins (e.g. EPrints/Plugin/Screen/EPrint/MyUploadMethod.pm) are never actually rendered, but provide common functionality to all subclassed plugins (e.g. EPrints/Plugin/Screen/EPrint/UploadMethod/File.pm).  If you wish a local superclass plugin, you will need to make sure your @ISA arrays are referring to the new classes.

← Older revision		Revision as of 12:15, 15 January 2015
Line 32:		Line 32:
	This makes calls to Screens::Items go via your new version - which has the locally defined sub (render in this case), and also makes sure that your new version doesn't appear alongside the original version.		This makes calls to Screens::Items go via your new version - which has the locally defined sub (render in this case), and also makes sure that your new version doesn't appear alongside the original version.
	I have found that running ~/bin/epadmin reload ARCHIVEID doesn't always pick these changes up - you might need to restart Apache to see what you've done!		I have found that running ~/bin/epadmin reload ARCHIVEID doesn't always pick these changes up - you might need to restart Apache to see what you've done!
		+
		+	If it still doesn't work, check that you don't have any other plugins running which are instantiating the changed plugin. For example:
		+
		+	Local plugin: EPrints/Plugin/Screen/EPrint/MyUploadMethod.pm
		+
		+	Instantiated by: EPrints/Plugin/Screen/EPrint/UploadMethod/File.pm
		+
		+	In the case above you need to ensure File.pm has the use and @ISA lines updated too:
		+
		+	use EPrints::Plugin::Screen::EPrint::MyUploadMethod;
		+
		+	@ISA = qw( EPrints::Plugin::Screen::EPrint::MyUploadMethod );

@@ Line 4: / Line 4: @@
 To change the functionality of a core plugin within a specific archive, you can make a subclass of the original package.
-'''NOTE:''' If you are on 3.2.0-3.2.3 there is a bug in plugin factory that may cause local customisation to plugins to bleed between archives. Ticket is here: [http://trac.eprints.org/eprints/ticket/3867]
+'''NOTE:''' If you are on 3.2.0-3.2.3 there is a bug in plugin factory that may cause local customisation to plugins to bleed between archives. Ticket is here: [http://trac.eprints.org/eprints/ticket/3867 http://trac.eprints.org/eprints/ticket/3867]
 Make a directory (in this example I'm subclassing a Screen plugin):

← Older revision		Revision as of 09:50, 19 October 2010
Line 3:		Line 3:

	To change the functionality of a core plugin within a specific archive, you can make a subclass of the original package.		To change the functionality of a core plugin within a specific archive, you can make a subclass of the original package.
		+
	'''NOTE:''' If you are on 3.2.0-3.2.3 there is a bug in plugin factory that may cause local customisation to plugins to bleed between archives. Ticket is here: [http://trac.eprints.org/eprints/ticket/3867]		'''NOTE:''' If you are on 3.2.0-3.2.3 there is a bug in plugin factory that may cause local customisation to plugins to bleed between archives. Ticket is here: [http://trac.eprints.org/eprints/ticket/3867]

← Older revision		Revision as of 09:50, 19 October 2010
Line 3:		Line 3:

	To change the functionality of a core plugin within a specific archive, you can make a subclass of the original package.		To change the functionality of a core plugin within a specific archive, you can make a subclass of the original package.
		+	'''NOTE:''' If you are on 3.2.0-3.2.3 there is a bug in plugin factory that may cause local customisation to plugins to bleed between archives. Ticket is here: [http://trac.eprints.org/eprints/ticket/3867]

	Make a directory (in this example I'm subclassing a Screen plugin):		Make a directory (in this example I'm subclassing a Screen plugin):

@@ Line 10: / Line 10: @@
   cp ~/perl_lib/EPrints/Plugin/Screen/Items.pm ~/archives/ARCHIVEID/cfg/plugins/EPrints/Plugins/Screen/MyItems.pm
-From the file, remove any subs that you don't need, and rename the package according to the name of the new file (in this example, I'm only redefining the 'render' sub).
+From the file, remove any subs that you don't want to redefine, and rename the package according to the name of the new file (in this example, I'm only redefining the 'render' sub).
 The file should look a bit like this:
   package EPrints::Plugin::Screen::MyItems;
@@ Line 24: / Line 24: @@
   ...
   } #end of sub render

@@ Line 1: / Line 1: @@
 [[Category:Plugins]]
 See also: [[Tips_to_write_plugins]]
 To change the functionality of a core plugin within a specific archive, you can make a subclass of the original package.

← Older revision		Revision as of 11:15, 18 October 2010
Line 1:		Line 1:
	[[Category:Plugins]]		[[Category:Plugins]]
		+	See also: [[Tips_to_write_plugins]]
	To change the functionality of a core plugin within a specific archive, you can make a subclass of the original package.		To change the functionality of a core plugin within a specific archive, you can make a subclass of the original package.

@@ Line 11: / Line 11: @@
 The file should look a bit like this:
   package EPrints::Plugin::Screen::MyItems;
-  @ISA = qw/ EPrints::Plugin::Screen::Items /;
+  @ISA = ( 'EPrints::Plugin::Screen::Items' );
   use strict;