Read Me

This directory contains the DSpace related outputs of the JISC funded
Storelink project to enable the Trackback protocol for DSpace, based on
earlier work done in the Claddier project. It was developed for
DSpace 1.5.0 but has been retested with DSpace 1.5.1. At this point
in time it is only available for the Jsp UI and has only been tested
with Postgres.

So what it all about ? Well if you want the full story then read the project 
documentation on the JISC website. The short version is, item A cites item B.
On being submitted and accepted into a DSpace archive item A sends a message to
the item B, wherever it lives, telling it that it has been cited. Item B
can record and present that information.

The software is split into two parts...

1. Add a new step to the submission process. The user cuts and pastes the
References section from the document into a text box. DSpace will then 
make a best efforts attempt to split the text into the individual references.
If a URL is included it will store the URL as a seperate field, otherwise the
user may enter a URL. The extracted references are displayed as part of the item 
display.

2. Trackback - Upon acceptance into the archive, DSpace will attempt to send 
messages to any referenced items that include a URL. In addition DSpace will
also listen for any incoming messages and update the list of rererences for 
that item to included 'cited by' references.   



Installation.
-------------

Place the jspui folder in the dspace/modules directory and rebuild
the war file.

Edit your existing dspace.cfg to add the new parameters. A cut down 
file has been provided with the new parameters. You may need to edit 
these parameters to conform with your own metadata schema. In 
addition, the whitelist of approved trackback 'partners' may require
editing. 

Edit your item-submission.xml files to add the new References step to 
the submission process. An example file has been provided.

Add the new tables 'reference' and 'metadatavalueref' to your database 
by running the provided sql scripts.


Licensing.
----------

All the code within the org.dspace package was developed at the 
University of Edinburgh and is available under the preexisting DSpace
licence arrangements.

All the code within the epub.content.citations package was developed at 
STFC Rutherford Appleton Laboratory under its own licensing scheme. The 
licence has been included in this folder.