Contribute: Plugins/ExportPluginsList - Revision history

Pm705: /* HelloList.pm */

2010-02-12T11:59:20Z

HelloList.pm

← Older revision		Revision as of 11:59, 12 February 2010
Line 7:		Line 7:

	= HelloList.pm =		= HelloList.pm =
	The code in the section below should be placed in a file called HelloList.pm in the directory created previously~~, and MyPlugins~~		The code in the section below should be placed in a file called HelloList.pm in the directory created previously.
	~~should be changed to the name of that directory~~.

	<pre>		<pre>

2010-02-08T13:33:38Z

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

	= Export Plugin Tutorial 2: List Handling =		= Export Plugin Tutorial 2: List Handling =

2007-09-28T18:55:15Z

Filehandles

← Older revision		Revision as of 18:55, 28 September 2007
Line 98:		Line 98:

	== Filehandles ==		== Filehandles ==
	The command line export tool provides the output list method with a filehandle for output in the opts hash, while the ~~cgi~~ export uses a value returned from the method. You must deal with the filehandle or you will get no output from the command line tool. In most cases this won't matter, but it is good practice to deal with it.		The command line export tool provides the output list method with a filehandle for output in the opts hash, while the [http://en.wikipedia.org/wiki/Common_Gateway_Interface CGI] export uses a value returned from the method. You must deal with the filehandle or you will get no output from the command line tool. In most cases this won't matter, but it is good practice to deal with it.

	The best way to handle output is to check if a filehandle has been provided every time something needs to be output. If a filehandle is provided we print to it, otherwise we save the output for later. At the end of the method we either return undef if a filehandle was provided or we return the saved output otherwise.		The best way to handle output is to check if a filehandle has been provided every time something needs to be output. If a filehandle is provided we print to it, otherwise we save the output for later. At the end of the method we either return undef if a filehandle was provided or we return the saved output otherwise.

2007-09-28T10:24:28Z

Testing Your Plugin

← Older revision		Revision as of 10:24, 28 September 2007
Line 142:		Line 142:
	= Testing Your Plugin =		= Testing Your Plugin =

	Restart your webserver and test the plugin as in [[~~User~~:~~Tom~~/~~Export_Plugins/Hello_World~~\| the previous tutorial]].		Restart your webserver and test the plugin as in [[Contribute:_Plugins/ExportPluginsHello\| the previous tutorial]].

	== Sample Output ==		== Sample Output ==
	[[Image:Explist.png]]		[[Image:Explist.png]]

2007-09-28T10:24:10Z

In More Detail

← Older revision		Revision as of 10:24, 28 September 2007
Line 76:		Line 76:

	= In More Detail =		= In More Detail =
	The above code is very similar to the HelloExport.pm file in [[~~User~~:~~Tom~~/~~Export_Plugins/Hello_World~~\| the previous tutorial]] so only the points where it deviates significantly from that file will be discussed below.		The above code is very similar to the HelloExport.pm file in [[Contribute:_Plugins/ExportPluginsHello\| the previous tutorial]] so only the points where it deviates significantly from that file will be discussed below.

	== Housekeeping ==		== Housekeeping ==

2007-09-28T10:23:29Z

Export Plugin Tutorial 2: List Handling

← Older revision		Revision as of 10:23, 28 September 2007
Line 1:		Line 1:
	= Export Plugin Tutorial 2: List Handling =		= Export Plugin Tutorial 2: List Handling =

	In this tutorial you will learn to create a slightly more complex export plugin than the one created in [[~~User~~:~~Tom~~/~~Export_Plugins/Hello_World~~\| the previous tutorial]] that changes the way lists of eprints are exported.		In this tutorial you will learn to create a slightly more complex export plugin than the one created in [[Contribute:_Plugins/ExportPluginsHello\| the previous tutorial]] that changes the way lists of eprints are exported.

	= HelloList.pm =		= HelloList.pm =

2007-09-27T20:54:50Z

User:Tom/Export Plugins/Hello Lists moved to Contribute: Plugins/ExportPluginsList

← Older revision	Revision as of 20:54, 27 September 2007
(No difference)

2007-09-27T20:52:10Z

Export Plugin Tutorial 2: Hello, Lists

← Older revision		Revision as of 20:52, 27 September 2007
Line 1:		Line 1:
	= Export Plugin Tutorial 2: ~~Hello, Lists~~ =		= Export Plugin Tutorial 2: List Handling =

	In this tutorial you will learn to create a slightly more complex export plugin than the one created in [[User:Tom/Export_Plugins/Hello_World\| the previous tutorial]] that changes the way lists of eprints are exported.		In this tutorial you will learn to create a slightly more complex export plugin than the one created in [[User:Tom/Export_Plugins/Hello_World\| the previous tutorial]] that changes the way lists of eprints are exported.

2007-09-27T12:29:52Z

HelloList.pm

← Older revision		Revision as of 12:29, 27 September 2007
Line 40:		Line 40:
	my ($plugin, %opts) = @_;		my ($plugin, %opts) = @_;

	my $~~output~~ = "ID\tTitle\n\n";		my $r = [];

			my $header = "ID\tTitle\n\n";
			if (defined $opts{fh})
			{
			print {$opts{fh}} $header;
			}
			else
			{
			push @{$r}, $header;
			}

	foreach my $dataobj ($opts{list}->get_records)		foreach my $dataobj ($opts{list}->get_records)
	{		{
	$~~output .~~= $plugin->output_dataobj($dataobj, %opts);		my $part = $plugin->output_dataobj($dataobj, %opts);
			if (defined $opts{fh})
			{
			print {$opts{fh}} $part;
			}
			else
			{
			push @{$r}, $part;
			}
	}		}

	return $~~output~~;		if (defined $opts{fh})
			{
			return undef;
			}
			return join('', @{$r});
	}		}

2007-09-27T12:29:36Z

Filehandles

← Older revision		Revision as of 12:29, 27 September 2007
Line 79:		Line 79:

	The best way to handle output is to check if a filehandle has been provided every time something needs to be output. If a filehandle is provided we print to it, otherwise we save the output for later. At the end of the method we either return undef if a filehandle was provided or we return the saved output otherwise.		The best way to handle output is to check if a filehandle has been provided every time something needs to be output. If a filehandle is provided we print to it, otherwise we save the output for later. At the end of the method we either return undef if a filehandle was provided or we return the saved output otherwise.

	~~Replace the code in output_list above with the code provided below.~~

	<pre>		<pre>