Contribute: Plugins/ExportPluginsZip - Revision history

Pm705 at 13:51, 8 February 2010

2010-02-08T13:51:09Z

Tom: /* Handling DataObjs */

2007-09-28T19:01:13Z

‎Handling DataObjs

Tom: /* Navigation */

2007-09-28T19:00:43Z

‎Navigation

Tom: /* Constructor */

2007-09-28T19:00:25Z

‎Constructor

Tom: /* Zip.pm */

2007-09-28T14:02:10Z

‎Zip.pm

Tom: /* Testing Your Plugin */

2007-09-28T10:26:37Z

‎Testing Your Plugin

Tom: User:Tom/Export Plugins/Zip moved to Contribute: Plugins/ExportPluginsZip

2007-09-27T20:57:16Z

User:Tom/Export Plugins/Zip moved to Contribute: Plugins/ExportPluginsZip

Tom: /* In More Detail */

2007-09-27T11:38:01Z

‎In More Detail

Tom: /* Zip.pm */

2007-09-27T11:32:31Z

‎Zip.pm

Tom: /* Sample Output */

2007-09-04T14:41:32Z

‎Sample Output

← Older revision		Revision as of 13:51, 8 February 2010
Line 1:		Line 1:
		+	[[Category:Contribute]]
		+	[[Category:Plugins]]
	= Export Plugin Tutorial 5: Zip =		= Export Plugin Tutorial 5: Zip =
	In this tutorial we'll look at packaging the results of a search into a Zip file. We'll create a directory for each eprint, and a sub-directory for each document belonging to that eprint. We'll also add an HTML index file to the archive to make it easier to navigate.		In this tutorial we'll look at packaging the results of a search into a Zip file. We'll create a directory for each eprint, and a sub-directory for each document belonging to that eprint. We'll also add an HTML index file to the archive to make it easier to navigate.

@@ Line 197: / Line 197: @@
 We loop over the DataObjs as we have done before.
-This time we setup some DOM objects to be added to our index. Each eprint will have it's title printed out followed by a list of documents.
+This time we setup some [http://en.wikipedia.org/wiki/Document_Object_Model DOM] objects to be added to our index. Each eprint will have it's title printed out followed by a list of documents.
 <pre>
      my $div = $session->make_element('div');
@@ Line 278: / Line 278: @@
 </pre>
-Finally we add the DOM object for our eprint to the index.
+Finally we add the [http://en.wikipedia.org/wiki/Document_Object_Model DOM] object for our eprint to the index.
 <pre>
      $index .= EPrints::XML::to_string($div);

@@ Line 189: / Line 189: @@
 </pre>
-Now we get the Session object, we'll be using it to manipulate DOM objects later.
+Now we get the Session object, we'll be using it to manipulate [http://en.wikipedia.org/wiki/Document_Object_Model DOM] objects later.
 <pre>
    my $session = $plugin->{session};

@@ Line 147: / Line 147: @@
 </pre>
-The file extension and MIME type are set to values appropriate for Zip files.
+The file extension and [http://en.wikipedia.org/wiki/MIME MIME] type are set to values appropriate for Zip files.
 <pre>
    $self->{suffix} = '.zip';

← Older revision		Revision as of 14:02, 28 September 2007
Line 9:		Line 9:

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

	<pre>		<pre>

@@ Line 301: / Line 301: @@
 = Testing Your Plugin =
-Restart your webserver and test the plugin as in [[User:Tom/Export_Plugins/Excel | the previous tutorial]].
+Restart your webserver and test the plugin as [[Contribute:_Plugins/ExportPluginsHello| before]].
 == Sample Output ==

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

@@ Line 140: / Line 140: @@
 = In More Detail =
 == Constructor ==
 For the sake of simplicity this plugin will only deal with lists of eprints. This avoids some code duplication, and it would be fairly easy to modify the plugin to deal with both individual eprints and lists of eprints sensibly.
@@ Line 154: / Line 148: @@
 The file extension and MIME type are set to values appropriate for Zip files.
 <pre>
-   $self->{suffix} = ".zip";
+   $self->{suffix} = '.zip';
-   $self->{mimetype} = "application/zip";
+   $self->{mimetype} = 'application/zip';
 </pre>
@@ Line 193: / Line 198: @@
 This time we setup some DOM objects to be added to our index. Each eprint will have it's title printed out followed by a list of documents.
 <pre>
-     my $div = $session->make_element("div");
+     my $div = $session->make_element('div');
-     my $heading = $session->make_element("h2");
+     my $heading = $session->make_element('h2');
-     $heading->appendChild($session->make_text($dataobj->get_value("title")));
+     $heading->appendChild($session->make_text($dataobj->get_value('title')));
      $div->appendChild($heading);
-     my $uldoc = $session->make_element("ul");
+     my $uldoc = $session->make_element('ul');
      $div->appendChild($uldoc);
 </pre>
@@ Line 205: / Line 210: @@
 <pre>
-     my $dirpath = "eprints-search/".$dataobj->get_id()."/";
+     my $dirpath = 'eprints-search/'.$dataobj->get_id().'/';
 </pre>
@@ Line 219: / Line 224: @@
 Here we create a list item for the document containing a link to the main file.
 <pre>
-       my $lidoc = $session->make_element("li");
+       my $lidoc = $session->make_element('li');
        $uldoc->appendChild($lidoc);
-       my $adoc = $session->make_element("a", href=>$dataobj->get_id."/doc$i/".$doc->get_main);
+       my $adoc = $session->make_element('a', href=>$dataobj->get_id."/doc$i/".$doc->get_main);
        $lidoc->appendChild($adoc);
 </pre>
 If a description of the main file has been set we use that as the link text, otherwise we use the filename.
 <pre>
-       if ($doc->exists_and_set("formatdesc"))
+       if ($doc->exists_and_set('formatdesc'))
+       {
-         $adoc->appendChild($session->make_text($doc->get_value("formatdesc")));
+         $adoc->appendChild($session->make_text($doc->get_value('formatdesc')));
+       }
        else
@@ Line 248: / Line 253: @@
+       {
          my $filepath = $subdirpath.$filename;
-         my $file = $doc->local_path."/".$filename;
+         my $file = $doc->local_path.'/'.$filename;
 </pre>
@@ Line 280: / Line 285: @@
 After finishing off our index file we add it to the zip file.
 <pre>
-   $index .= "</body></html>";
+   $index .= '</body></html>';
-   $zip->add_file("eprints-search/index.htm",$index);
+   $zip->add_file('eprints-search/index.htm',$index);
 </pre>
 If a file handle has been provided we write to it, otherwise we write to the scalar file handle created earlier. We then return in the usual fashion.
 <pre>
-   if (defined $opts{"fh"})
+   if (defined $opts{fh})
+   {
-     $zip->write_filehandle($opts{"fh"},"zip");
+     $zip->write_filehandle($opts{fh},'zip');
      return undef;
+   }
-   $zip->write_filehandle($FH,"zip");
+   $zip->write_filehandle($FH,'zip');
    return $archive;
 </pre>

@@ Line 292: / Line 292: @@
 == Sample Output ==
-[[Image:Expzip.png]]
+[[Image:Expzipv2.png]]
 The accompanying HTML index.
 [[Image:Expzip2.png]]