SWORD

From DigiRepWiki

(Difference between revisions)
Revision as of 09:34, 4 August 2008
Adrianstevenson (Talk | contribs)
Interest in SWORD
← Previous diff		 Revision as of 13:49, 7 August 2008
JulieAllinson (Talk | contribs)

Next diff →
Line 2: Line 2:
[[Image:SwordLogo-Documents.jpg|right|SWORD logo]] [[Image:SwordLogo-Documents.jpg|right|SWORD logo]]
-== SWORD 2 ==+== What is SWORD? ==
-=== Project ===+SWORD is a lightweight protocol for deposit. SWORD is a profile of the Atom Publishing Protocol. SWORD is a JISC-funded project 2007-2008. SWORD stands for Simple Web-service Offering Repository Deposit. The motivator for SWORD is 'lowering the barriers to deposit', principally deposit into repositories, but potentially deposit into any system which wants to receive content from remote sources.
-The next phase of SWORD is just beginning. Add ideas for SWORD 2 development to the wiki:+For a handy introduction to the SWORD project, please see the following paper in [http://www.ariadne.ac.uk/issue54/allinson-et-al/ Ariadne] (as deposited in [http://cadair.aber.ac.uk/dspace/handle/2160/507 CADAIR]).
-* Proposal: http://docs.google.com/Doc?id=dfhxkpv_3278gvzwdf+== SWORD protocol ==
-* [[SWORD 2 kickoff meeting]] and ([[SWORD discussion paper|Discussion paper]])+
- +
-SWORD 2 is being managed by Julie Allinson (University of York) and Adrian Stevenson (UKOLN)+
- +
-The project is led by [http://www.ukoln.ac.uk/ UKOLN]+
- +
-=== Contact ===+
- +
-* For queries relating to the project please contact [[User:JulieAllinson|Julie Allinson]], [mailto:ja546@york.ac.uk Julie Allinson] or [mailto:a.stevenson@ukoln.ac.uk Adrian Stevenson]+
-* For technical queries regarding implementation of SWORD, please join our sourceforget mailing list at: https://lists.sourceforge.net/lists/listinfo/sword-app-tech+
- +
-== The original SWORD project ==+
- +
-Duration: The project ran from 1st March 2007 until 31 August 2007 - extended until 31 October 2007, with case studies following in 2008.+
- +
-=== Project description ===+
- +
-SWORD (Simple Web-service Offering Repository Deposit) will take forward the Deposit protocol developed by a small working group as part of the JISC Digital Repositories Programme by implementing it as a lightweight web-service in four major repository software platforms: EPrints, DSpace, Fedora and IntraLibrary. The existing protocol documentation will be finalised by project partners and a prototype ‘smart deposit’ tool will be developed to facilitate easier and more effective population of repositories. The project intends to take an iterative approach to developing and revising the protocol, web-services and client implementation through evaluative testing and feedback mechanisms. Community acceptance and take-up will be sought through dissemination activities. The project is led by UKOLN, University of Bath, with partners at the Aberystwyth University, the University of Southampton and Intrallect Ltd. The project aims to improve the efficiency and quality of repository deposit and to diversity and expedite the options for timely population of repositories with content whilst promoting a common deposit interface and supporting the Information Environment principles of interoperability.+
- +
-For a handy introduction to SWORD, please see the following paper in [http://www.ariadne.ac.uk/issue54/allinson-et-al/ Ariadne] (as deposited in [http://cadair.aber.ac.uk/dspace/handle/2160/507 CADAIR]).+
- +
-SWORD is continuing the activities of the the JISC Digital Repository Programme [[Deposit API]] working group. +
- +
-See the [[Deposit API]] pages for more information.+
- +
-=== Partners ===+
- +
-* UKOLN (Adrian Stevenson)+
-* University of York (Julie Allinson)+
-* EPrints, University of Southampton (Les Carr and Sebastien Francois)+
-* Intrallect Ltd. (Martin Morrey and Sarah Currier)+
-* Centre for Advanced Software and Intelligent Systems (CASIS), Aberystwyth University (Neil Taylor, Stuart Lewis, Richard Jones and Glen Robson)+
- +
-=== Standards and protocol ===+
- +
-==== Deposit protocol ====+
The SWORD protocol for deposit is a profile of the Atom Publishing Protocol. Current version: The SWORD protocol for deposit is a profile of the Atom Publishing Protocol. Current version:
Line 54: Line 18:
* previous working drafts: [[SWORD APP Profile 0.7|0.7]], [[SWORD APP Profile 0.6|0.6]], [[SWORD APP Profile 0.5|0.5]], [[SWORD APP Profile 0.4|0.4]], [[SWORD APP Profile 0.3|0.3]], [[SWORD APP Profile 0.2|0.2]], [[SWORD APP Profile 0.1|0.1]] * previous working drafts: [[SWORD APP Profile 0.7|0.7]], [[SWORD APP Profile 0.6|0.6]], [[SWORD APP Profile 0.5|0.5]], [[SWORD APP Profile 0.4|0.4]], [[SWORD APP Profile 0.3|0.3]], [[SWORD APP Profile 0.2|0.2]], [[SWORD APP Profile 0.1|0.1]]
-==== Parameters ====+== SWORD Code ==
-* [[SWORD parameters]] - outlines the parameters/requirements for the SWORD protocol +Code for implementing SWORD in DSpace, Fedora and EPrints is available from our Sourceforge project page, along with Java Libraries and the reference client code:
-==== Existing standards ====+http://sourceforge.net/projects/sword-app/ (from the [http://sourceforge.net/project/showfiles.php?group_id=208296 downloads] area)
-* [[SWORD Standards|Relevant standards]]+EPrints code is also available from http://files.eprints.org/305/
-* [[SWORD Evaluate existing standards|Evaluation of existing standards]]+
-** [[SWORD APP evaluation]]+
-==== Supported formats ====+== SWORD demonstrators ==
-* [[SWORD formats]]+Within the SWORD project, the profile was implemented in test versions of DSpace, IntraLibrary, Fedora and EPrints. Instructions on how to access these can be found on the following page:
-=== Technical development ===+* [[SWORD access]]
-This work package involves implementation of the SWORD protocol in test installations of DSpace, IntraLibrary, Fedora and EPrints and the development of a SWORD demonstration client for depositing to these, and other, installations.+Intrallect have made available details about their implementation, including acceptance tests at the link below (please note their terms and conditions of use).
-=== SWORD downloads ===+* [[intrallect_development|Intrallect development]]
-These are available from our Sourceforge project page:+There are two demonstration clients which can be used to test implementations within the SWORD project and are freely available for wider use.
-http://sourceforge.net/projects/sword-app/ (from the [http://sourceforge.net/project/showfiles.php?group_id=208296 downloads] area)+* Desktop client - available from [http://sourceforge.net/project/showfiles.php?group_id=208296 sourceforge]
 +* Online client - available from http://sword.aber.ac.uk/sword/client
-EPrints code is also available from http://files.eprints.org/305/+Other clients and implemetations are happening outside of the project:
 +
 +* [http://legolas.cetis.ac.uk/ Feedforward] project has produced a client which includes SWORD-compliance, among other features.
 +* [http://foresite.cheshire3.org/ Foresite] project is using SWORD to deposit ORE resource maps describing journals within JSTOR into a DSpace repository.
 +* [http://www.depot.edina.ac.uk/ The Depot] has implemented SWORD.
 +* Biomedcentral's [http://www.openrepository.com/ Open Repository] are implementing a SWORD interface
 +* Intrallect are implementing a desktop drag and drop tool which uses SWORD
 +* Microsoft are implementing 'save as' plugin based on SWORD
 +* [[SOURCE]] project
 +* SWORD Ruby Client: http://code.google.com/p/bibapp/
-=== SWORD implementations ===+* SWORD is bundled with the current release of DSpace, and will be part of forthcoming versions of EPrints, Fedora and IntraLibrary
-Intrallect have made available details about their implementation, including acceptance tests at the link below (please note their terms and conditions of use).+== Case studies ==
-* [[intrallect_development|Intrallect development]]+Four [[SWORD case studies|Case studies]] have been commissioned. The following are available now:
-==== Accessing the implementations ====+* [[SWORD_case_studies#Case_study_1_:_arXiv|arXiv]]
 +* [[SWORD_case_studies#Case_study_3_:_SPECTRa|SPECTRa]]
-Further information is available about how to access the current SWORD implementations:+== Contact ==
-* [[SWORD access]]+* For queries relating to the project please contact [[User:JulieAllinson|Julie Allinson]], [mailto:ja546@york.ac.uk Julie Allinson] or [mailto:a.stevenson@ukoln.ac.uk Adrian Stevenson]
 +* For technical queries regarding implementation of SWORD, please join our sourceforget mailing list at: https://lists.sourceforge.net/lists/listinfo/sword-app-tech
-=== SWORD demonstration clients ===+== Project background etc. ==
-There are two demonstration clients which can be used to test implementations within the SWORD project and are freely available for wider use.+=== SWORD 2 ===
-* Desktop client - available from [http://sourceforge.net/project/showfiles.php?group_id=208296 sourceforge]+* Proposal: http://docs.google.com/Doc?id=dfhxkpv_3278gvzwdf
-* Online client - available from http://sword.aber.ac.uk/sword/client+* [[SWORD 2 kickoff meeting]] and ([[SWORD discussion paper|Discussion paper]])
-Other clients developed outside of the project are also in development currently ...+SWORD 2 is being managed by Julie Allinson (University of York) and Adrian Stevenson (UKOLN)
-* for example, the [http://legolas.cetis.ac.uk/ Feedforward] project has recently produced a client which includes SWORD-compliance, among other features. Definitely worth a look.+The project is led by [http://www.ukoln.ac.uk/ UKOLN]
-* also, potentially implementation and testing in the [http://ice.usq.edu.au/ ICE] project, see this report on a recent [http://ice.usq.edu.au/blog/?p=105 workshop]+
-=== Case studies ===+=== SWORD 1 ===
-Four [[SWORD case studies|Case studies]] have been commissioned. The following are available now:+Duration: The project ran from 1st March 2007 until 31 August 2007 - extended until 31 October 2007, with case studies following in 2008.
-* [[SWORD_case_studies#Case_study_1_:_arXiv|arXiv]]+'''Project description:'''
-* [[SWORD_case_studies#Case_study_3_:_SPECTRa|SPECTRa]]+
-=== CRIG unconference workshop ===+SWORD (Simple Web-service Offering Repository Deposit) will take forward the Deposit protocol developed by a small working group as part of the JISC Digital Repositories Programme by implementing it as a lightweight web-service in four major repository software platforms: EPrints, DSpace, Fedora and IntraLibrary. The existing protocol documentation will be finalised by project partners and a prototype ‘smart deposit’ tool will be developed to facilitate easier and more effective population of repositories. The project intends to take an iterative approach to developing and revising the protocol, web-services and client implementation through evaluative testing and feedback mechanisms. Community acceptance and take-up will be sought through dissemination activities. The project is led by UKOLN, University of Bath, with partners at the Aberystwyth University, the University of Southampton and Intrallect Ltd. The project aims to improve the efficiency and quality of repository deposit and to diversity and expedite the options for timely population of repositories with content whilst promoting a common deposit interface and supporting the Information Environment principles of interoperability.
-There was a discussion of SWORD at the CRIG Unconference on December 6th:+SWORD is continuing the activities of the the JISC Digital Repository Programme [[Deposit API]] working group.
-[[SWORD at the unconference]]+See the [[Deposit API]] pages for more information.
-=== Community engagement and dissemination ===+'''Partners:'''
- +
-* Rachel Heery, Julie Allinson, Jim Downing, Christopher Gutteridge and Martin Morrey, [http://www.ukoln.ac.uk/ukoln/staff/j.allinson/or2007-deposit.pdf Repository Deposit Service Description] (MIME type: application/pdf). Presented by Julie Allinson at [http://openrepositories.org/ Open Repositories 2007], 23-26 January 2007, San Antonio, Texas. Also available on [http://www.slideshare.net/j.allinson/repository-deposit-service-description Slideshare]+
-* [http://www.ukoln.ac.uk/ukoln/staff/j.allinson/SWORD-2007-06-22.pdf Simple Web-service Offering Repository Deposit (SWORD)] (MIME type: application/pdf). Presentation at the Defining Image Access project meeting, Wolfson College, Oxford University, Oxford, 22nd June 2007. Also available on [http://www.slideshare.net/j.allinson/sword-2007-06-22 Slideshare]+
-* [http://www.ukoln.ac.uk/ukoln/staff/j.allinson/SWORD-cetis-2007-06-29.pdf Simple Web-service Offering Repository Deposit] (SWORD). Presentation at the JISC CETIS EC and MDR SIG meeting, Strathclyde University, Glasgow, 29th June 2007. Also available on [http://www.slideshare.net/j.allinson/sword-cetis-2007-06-29-73233/ Slideshare]+
 +* UKOLN (Adrian Stevenson)
 +* University of York (Julie Allinson)
 +* EPrints, University of Southampton (Les Carr and Sebastien Francois)
 +* Intrallect Ltd. (Martin Morrey and Sarah Currier)
 +* Centre for Advanced Software and Intelligent Systems (CASIS), Aberystwyth University (Neil Taylor, Stuart Lewis, Richard Jones and Glen Robson)
-=== Project documents ===+'''Project documents:'''
* [http://www.ukoln.ac.uk/repositories/sword/sword-project-plan-02.pdf SWORD project plan v2] (pdf) * [http://www.ukoln.ac.uk/repositories/sword/sword-project-plan-02.pdf SWORD project plan v2] (pdf)
Line 132: Line 105:
* [[Progress report 2008-01]] * [[Progress report 2008-01]]
-Project meetings:+'''Project meetings:'''
* [[SWORD meeting 2007-04]] * [[SWORD meeting 2007-04]]
* [[SWORD telephone meeting 2007-05-11]] * [[SWORD telephone meeting 2007-05-11]]
* [[SWORD telephone meeting 2007-06-15]] * [[SWORD telephone meeting 2007-06-15]]
 +
 +=== Paramenters/Requirements ===
 +
 +* [[SWORD parameters]] - outlines the parameters/requirements for the SWORD protocol
 +
 +=== Existing standards ===
 +
 +* [[SWORD Standards|Relevant standards]]
 +* [[SWORD Evaluate existing standards|Evaluation of existing standards]]
 +** [[SWORD APP evaluation]]
 +
 +=== Supported formats ===
 +
 +* [[SWORD formats]]
== Other relevant work == == Other relevant work ==
* [[OAI-ORE]] * [[OAI-ORE]]
-* [[SOURCE]] project 
* HAL (http://hal.archives-ouvertes.fr/) - in French * HAL (http://hal.archives-ouvertes.fr/) - in French
-* [http://www.depot.edina.ac.uk/ The Depot] 
- 
* Google Data APIs Protocol (http://code.google.com/apis/gdata/) * Google Data APIs Protocol (http://code.google.com/apis/gdata/)
** YouTube video from Google Developers Day (http://www.youtube.com/watch?v=O4SWAfisH-8) ** YouTube video from Google Developers Day (http://www.youtube.com/watch?v=O4SWAfisH-8)
Line 151: Line 135:
* Poster (https://addons.mozilla.org/en-US/firefox/addon/2691) - a Firefox add-on that can be used to test *some* SWORD functionality, see blog post [http://frittato.wordpress.com/2007/10/12/firefox-addon-for-web-service-interaction/ here] * Poster (https://addons.mozilla.org/en-US/firefox/addon/2691) - a Firefox add-on that can be used to test *some* SWORD functionality, see blog post [http://frittato.wordpress.com/2007/10/12/firefox-addon-for-web-service-interaction/ here]
* [http://ice.usq.edu.au/ ICE] Project * [http://ice.usq.edu.au/ ICE] Project
-* [http://legolas.cetis.ac.uk/ FeedForward] 
-* SWORD Ruby Client: http://code.google.com/p/bibapp/ 
-=== Interest in SWORD ===+=== Dissemination and praise ===
-Blog posts and publicity:+* SWORD. Presentation at Third International Conference on Open Repositories 2008, 1-4 April 2008, Southampton, United Kingdom. [http://pubs.or08.ecs.soton.ac.uk/9/ Paper and presenation].
 +* SWORD - where we are now and how we got here. [http://www-users.york.ac.uk/%7Eja546/pub/SWORD-crig-2007-12-06.ppt Presentation] at the JISC CRIG Unconference, Birkbeck College, 6th December 2007.
 +* Simple Web-service Offering Repository Deposit (SWORD). [http://www-users.york.ac.uk/%7Eja546/pub/SWORD-cetis-2007-06-29.ppt Presentation] at the JISC CETIS EC and MDR SIG meeting, Strathclyde University, Glasgow, 29th June 2007. Also available on Slideshare
 +* Simple Web-service Offering Repository Deposit (SWORD). [http://www-users.york.ac.uk/%7Eja546/pub/SWORD-2007-06-22.ppt Presentation] at the Defining Image Access project meeting, Wolfson College, Oxford University, Oxford, 22nd June 2007.
 +* Rachel Heery, Julie Allinson, Jim Downing, Christopher Gutteridge and Martin Morrey, [http://www-users.york.ac.uk/%7Eja546/pub/or2007-deposit.ppt Repository Deposit Service Description]. Presented by Julie Allinson at Open Repositories 2007, 23-26 January 2007, San Antonio, Texas.
-* Stuart Lewis' Blog 'Microsoft SWORD announcements' http://blog.stuartlewis.com/2008/07/28/microsoft-sword-announcements/  
* Pete Johnston, eFoundations: http://efoundations.typepad.com/efoundations/2007/07/putting-them-wi.html and http://efoundations.typepad.com/efoundations/2007/10/sword-unsheathe.html * Pete Johnston, eFoundations: http://efoundations.typepad.com/efoundations/2007/07/putting-them-wi.html and http://efoundations.typepad.com/efoundations/2007/10/sword-unsheathe.html
* David Davies' Weblog: http://david.davies.name/weblog/2007/06/30/how-project-sword-restored-my-faith-in-educational-technology/ * David Davies' Weblog: http://david.davies.name/weblog/2007/06/30/how-project-sword-restored-my-faith-in-educational-technology/

Revision as of 13:49, 7 August 2008

SWORD Home | SWORD Wiki | SWORD Project Background

SWORD logo

Contents

What is SWORD?

SWORD is a lightweight protocol for deposit. SWORD is a profile of the Atom Publishing Protocol. SWORD is a JISC-funded project 2007-2008. SWORD stands for Simple Web-service Offering Repository Deposit. The motivator for SWORD is 'lowering the barriers to deposit', principally deposit into repositories, but potentially deposit into any system which wants to receive content from remote sources.

For a handy introduction to the SWORD project, please see the following paper in Ariadne (as deposited in CADAIR).

SWORD protocol

The SWORD protocol for deposit is a profile of the Atom Publishing Protocol. Current version:

This document replaces:

SWORD Code

Code for implementing SWORD in DSpace, Fedora and EPrints is available from our Sourceforge project page, along with Java Libraries and the reference client code:

http://sourceforge.net/projects/sword-app/ (from the downloads area)

EPrints code is also available from http://files.eprints.org/305/

SWORD demonstrators

Within the SWORD project, the profile was implemented in test versions of DSpace, IntraLibrary, Fedora and EPrints. Instructions on how to access these can be found on the following page:

Intrallect have made available details about their implementation, including acceptance tests at the link below (please note their terms and conditions of use).

There are two demonstration clients which can be used to test implementations within the SWORD project and are freely available for wider use.

Other clients and implemetations are happening outside of the project:

  • Feedforward project has produced a client which includes SWORD-compliance, among other features.
  • Foresite project is using SWORD to deposit ORE resource maps describing journals within JSTOR into a DSpace repository.
  • The Depot has implemented SWORD.
  • Biomedcentral's Open Repository are implementing a SWORD interface
  • Intrallect are implementing a desktop drag and drop tool which uses SWORD
  • Microsoft are implementing 'save as' plugin based on SWORD
  • SOURCE project
  • SWORD Ruby Client: http://code.google.com/p/bibapp/
  • SWORD is bundled with the current release of DSpace, and will be part of forthcoming versions of EPrints, Fedora and IntraLibrary

Case studies

Four Case studies have been commissioned. The following are available now:

Contact

Project background etc.

SWORD 2

SWORD 2 is being managed by Julie Allinson (University of York) and Adrian Stevenson (UKOLN)

The project is led by UKOLN

SWORD 1

Duration: The project ran from 1st March 2007 until 31 August 2007 - extended until 31 October 2007, with case studies following in 2008.

Project description:

SWORD (Simple Web-service Offering Repository Deposit) will take forward the Deposit protocol developed by a small working group as part of the JISC Digital Repositories Programme by implementing it as a lightweight web-service in four major repository software platforms: EPrints, DSpace, Fedora and IntraLibrary. The existing protocol documentation will be finalised by project partners and a prototype ‘smart deposit’ tool will be developed to facilitate easier and more effective population of repositories. The project intends to take an iterative approach to developing and revising the protocol, web-services and client implementation through evaluative testing and feedback mechanisms. Community acceptance and take-up will be sought through dissemination activities. The project is led by UKOLN, University of Bath, with partners at the Aberystwyth University, the University of Southampton and Intrallect Ltd. The project aims to improve the efficiency and quality of repository deposit and to diversity and expedite the options for timely population of repositories with content whilst promoting a common deposit interface and supporting the Information Environment principles of interoperability.

SWORD is continuing the activities of the the JISC Digital Repository Programme Deposit API working group.

See the Deposit API pages for more information.

Partners:

  • UKOLN (Adrian Stevenson)
  • University of York (Julie Allinson)
  • EPrints, University of Southampton (Les Carr and Sebastien Francois)
  • Intrallect Ltd. (Martin Morrey and Sarah Currier)
  • Centre for Advanced Software and Intelligent Systems (CASIS), Aberystwyth University (Neil Taylor, Stuart Lewis, Richard Jones and Glen Robson)

Project documents:

Project meetings:

Paramenters/Requirements

  • SWORD parameters - outlines the parameters/requirements for the SWORD protocol

Existing standards

Supported formats

Other relevant work

Dissemination and praise

  • SWORD. Presentation at Third International Conference on Open Repositories 2008, 1-4 April 2008, Southampton, United Kingdom. Paper and presenation.
  • SWORD - where we are now and how we got here. Presentation at the JISC CRIG Unconference, Birkbeck College, 6th December 2007.
  • Simple Web-service Offering Repository Deposit (SWORD). Presentation at the JISC CETIS EC and MDR SIG meeting, Strathclyde University, Glasgow, 29th June 2007. Also available on Slideshare
  • Simple Web-service Offering Repository Deposit (SWORD). Presentation at the Defining Image Access project meeting, Wolfson College, Oxford University, Oxford, 22nd June 2007.
  • Rachel Heery, Julie Allinson, Jim Downing, Christopher Gutteridge and Martin Morrey, Repository Deposit Service Description. Presented by Julie Allinson at Open Repositories 2007, 23-26 January 2007, San Antonio, Texas.
Retrieved from "/repositories/digirep/index/SWORD"