Contribute: Plugins/ImportPluginsCSV - Revision history

Tdb01r: /* CSV.pm */

2011-06-17T15:04:02Z

‎CSV.pm

2010-02-08T13:51:29Z

2008-01-21T11:38:37Z

‎Compound fields: corrected wrong field names in example

2008-01-21T10:25:34Z

‎Before You Start

2007-09-28T19:09:42Z

‎convert_input

2007-09-28T19:08:31Z

‎input_fh

2007-09-28T19:07:28Z

‎Constructor

2007-09-28T19:03:45Z

‎CSV.pm

2007-09-28T19:03:14Z

‎Before You Start

2007-09-28T19:02:00Z

‎Import Plugin Tutorial 1: CSV

@@ Line 113: / Line 113: @@
          my %output = ();
-         my $dataset = $plugin->{session}->{repository}->get_dataset('archive');
+         my $dataset = $plugin->{session}->get_dataset('archive');
          my $i = 0;

@@ Line 415: / Line 415: @@
 Here is an example of setting the creators field:
 <pre>
-title,creators_names,creators_ids,
+title,creators_name,creators_id
 Setting compound fields.,"Bloggs, Joe;Doe, John","joe@bloggs.com;john@doe.com"
 </pre>
 If you import this record and then examine the view items screen you will find that the "Creators" field has been setup with the values displayed in a table.

@@ Line 7: / Line 7: @@
 = Before You Start =
-Create a directory for your import plugins in the main plugin directory (usually /opt/eprints3/perl_lib/EPrints/Plugin/import). The directory used for these examples is called "MyPlugins".
+Create a directory for your import plugins in the main plugin directory (usually /opt/eprints3/perl_lib/EPrints/Plugin/Import). The directory used for these examples is called "MyPlugins".
 To prepare for this tutorial you should install the [http://search.cpan.org/~erangel/Text-CSV/CSV.pm Text::CSV] module. The following command as root, or using sudo should work.

@@ Line 263: / Line 263: @@
 === convert_input ===
-This method takes data in a particular format, in this case CSV and transforms it into a hash of metadata field names and values.
+This method takes data in a particular format, in this case [http://en.wikipedia.org/wiki/Comma-Separated_Values CSV] and transforms it into a hash of metadata field names and values.
 We take the second argument to the method and convert the array reference into an array.

@@ Line 211: / Line 211: @@
 </pre>
-We create a Text::CSV object to handle the input. Using a dedicated CSV handling package is preferable to using Perl's split function as it handles a number of more complicated scenarios such as commas within records using double quotes.
+We create a Text::CSV object to handle the input. Using a dedicated [http://en.wikipedia.org/wiki/Comma-Separated_Values CSV] handling package is preferable to using Perl's split function as it handles a number of more complicated scenarios such as commas within records using double quotes.
 <pre>
          my $csv = Text::CSV->new();

@@ Line 177: / Line 177: @@
 == Constructor ==
-For import plugins we must set a 'produce' property, to tell the repository what kinds of objects the plugin can import. This plugin only supports importing lists of eprints, but if it supported importing individual eprints we could add 'dataobj/eprint' to this property. We would then have to implement the "input_dataobj" method. Most plugins implement this method, but it is rarely used in practice. Most imports are done in lists (even if that list only contains one member), via the import items screen.
+For import plugins we must set a 'produce' field, to tell the repository what kinds of objects the plugin can import. This plugin only supports importing lists of eprints, but if it supported importing individual eprints we could add 'dataobj/eprint' to this property. We would then have to implement the "input_dataobj" method. Most plugins implement this method, but it is rarely used in practice. Most imports are done in lists (even if that list only contains one member), via the import items screen.
 <pre>

@@ Line 16: / Line 16: @@
 = CSV.pm =
 <pre>
 package EPrints::Plugin::Import::MyPlugins::CSV;

@@ Line 1: / Line 1: @@
 = Import Plugin Tutorial 1: CSV =
-In this tutorial we will look at creating a relatively simple plugin to import eprints into our repository by reading files containing comma separated variables. We won't be dealing with documents and files, but will be focusing on importing eprint metadata.
+In this tutorial we will look at creating a relatively simple plugin to import eprints into our repository by reading files containing [http://en.wikipedia.org/wiki/Comma-Separated_Values comma-separated values]. We won't be dealing with documents and files, but will be focusing on importing eprint metadata.
 Import plugins are inherently more complicated than export plugins because of the error checking that must be done, however in this example error checking has been kept to a minimum to simplify the example. In a "real" plugin you should check that the appropriate metadata fields are set for a given type of eprint, and unfortunately there appears to be no quick way to do this.