SWORD - Revision history

Kiz at 14:22, 17 October 2013

2013-10-17T14:22:50Z

Kiz: /* Importer Plugin */

2013-10-14T07:41:49Z

Importer Plugin

@@ Line 117: / Line 117: @@
 === Importer Plugin ===
 The importer plugin is a perl package that handles the deposited file, and creates a new record in the repository for the record deposited.
 In practice, the best way to learn how importers are written is to look at existing importers (<tt>~~eprints/perl-lib/EPrints/Plugin/Sword/Import/...</tt>)
 ==== Basic framework ====
-The very basic framework for an importer is to subclass from the generic "import" class:
+The very basic framework for an importer is just to register the importer with EPrints, and leave all functions to be handled by inheritence:
 <pre>
@@ Line 141: / Line 148: @@
 ;
 </pre>

Kiz: /* Writing your own Importer */

2013-10-11T15:38:09Z

Writing your own Importer

← Older revision		Revision as of 15:38, 11 October 2013
Line 114:		Line 114:
	* The <tt>qvalue</tt> is what's known as the "Quality Value" - how closely the importer matches all the metadata wanted by the repository.		* The <tt>qvalue</tt> is what's known as the "Quality Value" - how closely the importer matches all the metadata wanted by the repository.
	** The theory is that clients have a list of packages they can export as, and servers have a list of packages they understand - therefore a client can determine the best package for that transfer, based on relative QValues.		** The theory is that clients have a list of packages they can export as, and servers have a list of packages they understand - therefore a client can determine the best package for that transfer, based on relative QValues.

			=== Importer Plugin ===
			The importer plugin is a perl package that handles the deposited file, and creates a new record in the repository for the record deposited.

			In practice, the best way to learn how importers are written is to look at existing importers (<tt>~~eprints/perl-lib/EPrints/Plugin/Sword/Import/...</tt>)

			==== Basic framework ====
			The very basic framework for an importer is to subclass from the generic "import" class:

			<pre>
			package EPrints::Plugin::Sword::Import::MyImporter;

			use strict;

			use EPrints::Plugin::Sword::Import;
			our @ISA = qw/ EPrints::Plugin::Sword::Import /;


			sub new {
			my ( $class, %params ) = @_;
			my $self = $class->SUPER::new(%params);
			$self->{name} = "My Sword Importer";
			return $self;
			} ## end sub new

			1;

			</pre>

Kiz: /* Supported packages */

2013-10-11T15:30:39Z

Supported packages

@@ Line 87: / Line 87: @@
 </pre>
-== Supported packages ==
+== Writing your own Importer ==
-maybe how to write new importer plugins
+# You need to configure the repository to recognise a new packagge format, and associate that format with the code that handles it

Kiz: /* servicedocument */

2013-10-11T15:16:38Z

servicedocument

@@ Line 46: / Line 46: @@
 == servicedocument ==
-The default
+The servicedocument is an XML listing of which "collections" are available, and what "packages" can be used with each one.
 == Supported packages ==
 maybe how to write new importer plugins

Kiz at 16:35, 12 March 2013

2013-03-12T16:35:01Z

← Older revision		Revision as of 16:35, 12 March 2013
Line 4:		Line 4:
	The SWORD project was funded by [http://www.jisc.ac.uk/ JISC] and more information can be found on the [http://swordapp.org official website].		The SWORD project was funded by [http://www.jisc.ac.uk/ JISC] and more information can be found on the [http://swordapp.org official website].

	~~The current version of the protocol is 1.3 and this page is only about this version.~~		== SWORD made easy ==

			SWORD is basically an http put (or '''POST''') to a defined web URL, where the content of the posted request is the thing being deposited.

			SWORD 1.3 uses an http header field to define how the ''thing'' has been wrapped up ('''packaged''')

			SWORD 2.0 uses the content-type to deduce how to understand ''thing''

			By default, sword is ENABLED in all SWORD 3.2 & 3.3 EPrints servers, and access is available to all registered users.

			EPrints 3.2 uses SWORD 1.3

			EPrints 3.3 uses SWORD 2.0

			This document covers EPrints 3.2 & SWORD 1.3
			For information on SWORD 2 see [[API:EPrints/Apache/CRUD]].

			== Terminology ==

			SWORD 1.3 uses some specific terms for specific meanings
			* '''collection''' The specific URL within the server for the data to go into. For EPrints this generally means inbox, review, archive, deleted - however for DSpace, there is a Collection concept; and Fedora has a similar RDF tag for defining collective groupings.
			* '''package''' The URI that identifies how a particular deposit has been wrapped up.
			* '''mediation''' This is where one user can deposit ''on behalf of'' another user.
			* '''servicedocument''' The document that the SWORD server can return to inform clients of what collections and what packages are understood by the service

	== Protocol implementation ==		== Protocol implementation ==

	~~v1.3~~
	verbose		verbose
	no-op		no-op

	~~For information on~~ SWORD ~~2 see [[API:EPrints/Apache/CRUD]].~~		== Configuring SWORD ==



			The default location for SWORD configuration is

	~~== Configuring SWORD ==~~		archives/<your repo>/cfg/cfg.d/sword.pl

	~~configuring sword.pl~~		This is where you enable and disable access to various ''collections'', and add/remove ''packages''

	~~archives/<your repo>/cfg/cfg.d/sword.pl~~		== servicedocument ==

			The default
	== Supported packages ==		== Supported packages ==

	~~which features of the protocol are supported~~

	maybe how to write new importer plugins		maybe how to write new importer plugins

Adb1a11@ecs.soton.ac.uk: Removed ", which will become standard when EPrints v3.2 is released"

2012-06-15T09:21:26Z

Removed ", which will become standard when EPrints v3.2 is released"

← Older revision		Revision as of 09:21, 15 June 2012
Line 4:		Line 4:
	The SWORD project was funded by [http://www.jisc.ac.uk/ JISC] and more information can be found on the [http://swordapp.org official website].		The SWORD project was funded by [http://www.jisc.ac.uk/ JISC] and more information can be found on the [http://swordapp.org official website].

	The current version of the protocol is 1.3 and this page is only about this version~~, which will become standard when EPrints v3.2 is released~~.		The current version of the protocol is 1.3 and this page is only about this version.

Tdb01r at 15:48, 18 May 2012

2012-05-18T15:48:38Z

← Older revision		Revision as of 15:48, 18 May 2012
Line 13:		Line 13:
	no-op		no-op

			For information on SWORD 2 see [[API:EPrints/Apache/CRUD]].

Pm705 at 17:48, 9 February 2010

2010-02-09T17:48:28Z

← Older revision		Revision as of 17:48, 9 February 2010
Line 1:		Line 1:
	[[Category:Plugins]]		[[Category:EPrints 3 Plugins]]
	This page is about SWORD which is a lightweight protocol for remotely depositing content into repositories.		This page is about SWORD which is a lightweight protocol for remotely depositing content into repositories.

Pm705 at 16:51, 8 February 2010

2010-02-08T16:51:48Z

← Older revision		Revision as of 16:51, 8 February 2010
Line 1:		Line 1:
			[[Category:Plugins]]
	This page is about SWORD which is a lightweight protocol for remotely depositing content into repositories.		This page is about SWORD which is a lightweight protocol for remotely depositing content into repositories.