Contribute: Plugins/ExportPluginsHelloOld - Revision history

Pm705 at 16:11, 24 February 2010

2010-02-24T16:11:56Z

← Older revision		Revision as of 16:11, 24 February 2010
Line 40:		Line 40:
	my ($plugin, $dataobj) = @_;		my ($plugin, $dataobj) = @_;

	return $dataobj->~~get_value~~('title')."\n";		return $dataobj->value('title')."\n";
	}		}

Line 117:		Line 117:

	# Return a scalar containing the title.		# Return a scalar containing the title.
	return $dataobj->~~get_value~~('title')."\n";		return $dataobj->value('title')."\n";
	}		}
	</pre>		</pre>

Pm705: moved Contribute: Plugins/ExportPluginsHello to Contribute: Plugins/ExportPluginsHelloOld

2010-02-24T16:02:02Z

moved Contribute: Plugins/ExportPluginsHello to Contribute: Plugins/ExportPluginsHelloOld

← Older revision	Revision as of 16:02, 24 February 2010
(No difference)

Pm705: /* In More Detail */

2010-02-12T11:39:39Z

In More Detail

← Older revision		Revision as of 11:39, 12 February 2010
Line 48:		Line 48:


	== In More Detail ==		= In More Detail =

	== Housekeeping ==		== Housekeeping ==
	<pre>		<pre>

Pm705: /* Testing Your Plugin */

2010-02-12T11:37:54Z

Testing Your Plugin

← Older revision		Revision as of 11:37, 12 February 2010
Line 129:		Line 129:

	= Testing Your Plugin =		= Testing Your Plugin =
	~~Restart~~ your web server ~~and~~ perform a search.		Remember you must always '''restart your web server''' when you change perl code in EPrints to reload the perl. Alternatively you can call bin/epadmin reload <archive_id>.

			Now perform a search.

	If all is well your plugin should appear in the dropdown menu. Select it and click export. As long as the search provided some results, you should get a list of EPrint titles returned.		If all is well your plugin should appear in the dropdown menu. Select it and click export. As long as the search provided some results, you should get a list of EPrint titles returned.

Pm705: /* HelloExport.pm */

2010-02-12T11:32:01Z

HelloExport.pm

← Older revision		Revision as of 11:32, 12 February 2010
Line 12:		Line 12:
	= HelloExport.pm =		= HelloExport.pm =

	~~Replace MyPlugins with the name of the directory you have decided to put your export plugins in and~~ place the code below in a file called HelloExport.pm in that directory.		Now place the code below in a file called HelloExport.pm in that directory.

	<pre>		<pre>

Pm705: /* Before You Start */

2010-02-12T11:31:10Z

Before You Start

← Older revision		Revision as of 11:31, 12 February 2010
Line 8:		Line 8:
	= Before You Start =		= Before You Start =

	Create a directory for your export plugins in the ~~main export plugin~~ directory ~~(usually~~ /~~opt~~/~~eprints3~~/~~perl_lib~~/EPrints/Plugin/Export). The directory used for these examples is called "MyPlugins".		Create a directory for your export plugins in the local repository cfg directory, <EPrints_root>/archives/<archive_name>cfg/plugins/EPrints/Plugin/Export. Note archvies/<archive_name>cfg/plugins/ is a special directory which is added to the perl path when your webserver starts. Then in the directory create a directory for your plugins. The directory used for these examples is called "MyPlugins".

	= HelloExport.pm =		= HelloExport.pm =

Pm705 at 11:47, 8 February 2010

2010-02-08T11:47:01Z

← Older revision		Revision as of 11:47, 8 February 2010
Line 1:		Line 1:
			[[Category:Contribute]]
			[[Category:Plugins]]

	= Export Plugin Tutorial 1: "Hello, World!" =		= Export Plugin Tutorial 1: "Hello, World!" =

Tom: /* Before You Start */

2007-09-28T19:02:56Z

Before You Start

← Older revision		Revision as of 19:02, 28 September 2007
Line 5:		Line 5:
	= Before You Start =		= Before You Start =

	Create a directory for your export plugins in the main export plugin directory (usually /opt/eprints3/perl_lib/EPrints/Plugin/Export). The directory used for these examples is called "MyPlugins"		Create a directory for your export plugins in the main export plugin directory (usually /opt/eprints3/perl_lib/EPrints/Plugin/Export). The directory used for these examples is called "MyPlugins".

	= HelloExport.pm =		= HelloExport.pm =

Tom: /* Processing DataObjs */

2007-09-28T14:48:24Z

Processing DataObjs

← Older revision		Revision as of 14:48, 28 September 2007
Line 103:		Line 103:
	This method handles the export of each DataObj. DataObjs make up most of the content of an EPrint repository. The three main types are EPrint defining individual eprints, Document defining collections of one or more files belonging to an EPrints, and User which defines users of the repository.		This method handles the export of each DataObj. DataObjs make up most of the content of an EPrint repository. The three main types are EPrint defining individual eprints, Document defining collections of one or more files belonging to an EPrints, and User which defines users of the repository.

	Besides an implicit reference to the Plugin object, this method is also provided with a reference to an individual DataObj. It is called by several [http://en.wikipedia.org/wiki/Common_Gateway_Interface CGI] and command line scripts to export single DataObjs, for instance the item control screen for repository staff. It is also called by the list handling method on each DataObj in a list, for example the results of a search. That will be explained in [[Contribute:_Plugins/~~ExportPluginList~~\|the next tutorial]].		Besides an implicit reference to the Plugin object, this method is also provided with a reference to an individual DataObj. It is called by several [http://en.wikipedia.org/wiki/Common_Gateway_Interface CGI] and command line scripts to export single DataObjs, for instance the item control screen for repository staff. It is also called by the list handling method on each DataObj in a list, for example the results of a search. That will be explained in [[Contribute:_Plugins/ExportPluginsList\|the next tutorial]].

	In the example below we get the title of each DataObj, but there are large number of fields which you can extract from each DataObj. For example try changing "title" to "abstract" to print the abstract of each eprint.		In the example below we get the title of each DataObj, but there are large number of fields which you can extract from each DataObj. For example try changing "title" to "abstract" to print the abstract of each eprint.

Tom: /* Processing DataObjs */

2007-09-28T14:47:47Z

Processing DataObjs

← Older revision		Revision as of 14:47, 28 September 2007
Line 103:		Line 103:
	This method handles the export of each DataObj. DataObjs make up most of the content of an EPrint repository. The three main types are EPrint defining individual eprints, Document defining collections of one or more files belonging to an EPrints, and User which defines users of the repository.		This method handles the export of each DataObj. DataObjs make up most of the content of an EPrint repository. The three main types are EPrint defining individual eprints, Document defining collections of one or more files belonging to an EPrints, and User which defines users of the repository.

	Besides an implicit reference to the Plugin object, this method is also provided with a reference to an individual DataObj. It is called by several [http://en.wikipedia.org/wiki/Common_Gateway_Interface CGI] and command line scripts to export single DataObjs, for instance the item control screen for repository staff. It is also called by the list handling method on each DataObj in a list, for example the results of a search. That will be explained in [[~~User~~:~~Tom~~/~~Export Plugins/Hello Lists~~\|the next tutorial]].		Besides an implicit reference to the Plugin object, this method is also provided with a reference to an individual DataObj. It is called by several [http://en.wikipedia.org/wiki/Common_Gateway_Interface CGI] and command line scripts to export single DataObjs, for instance the item control screen for repository staff. It is also called by the list handling method on each DataObj in a list, for example the results of a search. That will be explained in [[Contribute:_Plugins/ExportPluginList\|the next tutorial]].

	In the example below we get the title of each DataObj, but there are large number of fields which you can extract from each DataObj. For example try changing "title" to "abstract" to print the abstract of each eprint.		In the example below we get the title of each DataObj, but there are large number of fields which you can extract from each DataObj. For example try changing "title" to "abstract" to print the abstract of each eprint.