Difference between revisions of "Sneep"

From EPrints Documentation
Jump to: navigation, search
(Created page with '=Overview= The SNEEP (Social Networking Extensions to EPrints) project originally written at the ULCC provides a commenting functionality. This package includes a new implementa…')
 
(Installation)
Line 9: Line 9:
 
The preferred installation of this SNEEP system is on the EPrints 3.2 version. To check your version of EPrints, please visit http://yourrepository/cgi/counter.
 
The preferred installation of this SNEEP system is on the EPrints 3.2 version. To check your version of EPrints, please visit http://yourrepository/cgi/counter.
  
If you are installing this package on the older EPrints 3.1 version, some additional installation steps are required:
+
==Installing on EPrints 3.2==
  
==Extracting Sneep==
+
===Downloading===
* Extract the perl_lib folder from the downloaded file into the root of your eprints installation (usually /opt/eprints3 or /usr/share/eprints3)
+
Make sure that you download the file at the following link, Sneep for EPrints 3.2. The file should be called sneep-3.2-XXX.tar.gz, where XXX is the version of SNEEP you have downloaded.
* Extract the files from the archives/YOUR_REPOSITORY folder in the downloaded file into your archives/repository folder.
 
  
3. Extract the files from the cgi/sneep folder in the downloaded file into the cgi/ folder in your eprints root (usually /opt/eprints3 or /usr/share/eprints3).
+
===Link CGI Scripts===
 +
Next you need to link the CGI scripts. This is done with the following commands;
  
==Core Modifications==
+
ln -s /usr/share/eprints3/archives/ARCHIVEID/cgi/sneep /usr/share/eprints3/cgi/sneep
 +
ln -s /usr/share/eprints3/archives/ARCHVIEID/cgi/users/sneep /usr/share/eprints3/cgi/users/sneep
  
===perl_lib/EPrints/DataSet.pm===
+
===Extracting===
 +
 
 +
==Installing on EPrints 3.1==
 +
 
 +
===Downloading===
 +
Make sure that you download the file at the following link, Sneep for EPrints 3.1. The file should be called sneep-3.1-XXX.tar.gz, where XXX is the version of SNEEP you have downloaded.
 +
 
 +
===Extracting===
 +
* Extract the perl_lib folder from the downloaded file into the root of your eprints installation (usually /opt/eprints3 or /usr/share/eprints3).
 +
* Extract the files from the archives/ARCHIVEID folder in the downloaded file into your archives/ARCHIVEID folder, where ARCHIVEID is the name of your archive.
 +
 
 +
===Link CGI Scripts===
 +
Next you need to link the CGI scripts. This is done with the following commands;
 +
 
 +
ln -s /usr/share/eprints3/archives/ARCHIVEID/cgi/sneep /usr/share/eprints3/cgi/sneep
 +
ln -s /usr/share/eprints3/archives/ARCHVIEID/cgi/users/sneep /usr/share/eprints3/cgi/users/sneep
 +
 
 +
===Core Modifications===
 +
 
 +
====perl_lib/EPrints/DataSet.pm====
 
In this file locate the following section:
 
In this file locate the following section:
 
  request => {
 
  request => {
Line 50: Line 70:
 
  }
 
  }
  
==Sneep Counter==
+
===Sneep Counter===
 
To install the sneep counter in the execute the following SQL statement on your database;
 
To install the sneep counter in the execute the following SQL statement on your database;
  
 
  INSERT INTO counters SET countername='sneepid',counter=0;
 
  INSERT INTO counters SET countername='sneepid',counter=0;
  
==Final Steps==
+
===Final Steps===
 
Run the following commands to complete installation of the sneep extension;
 
Run the following commands to complete installation of the sneep extension;
  

Revision as of 14:40, 4 January 2010

Overview

The SNEEP (Social Networking Extensions to EPrints) project originally written at the ULCC provides a commenting functionality. This package includes a new implementation of the plugin which is compatible with both EPrints 3.1 and 3.2 in an easily installable and refactored package.

The original SNEEP project can be found at http://sneep.ulcc.ac.uk/wiki/index.php/Main_Page

Installation

The preferred installation of this SNEEP system is on the EPrints 3.2 version. To check your version of EPrints, please visit http://yourrepository/cgi/counter.

Installing on EPrints 3.2

Downloading

Make sure that you download the file at the following link, Sneep for EPrints 3.2. The file should be called sneep-3.2-XXX.tar.gz, where XXX is the version of SNEEP you have downloaded.

Link CGI Scripts

Next you need to link the CGI scripts. This is done with the following commands;

ln -s /usr/share/eprints3/archives/ARCHIVEID/cgi/sneep /usr/share/eprints3/cgi/sneep
ln -s /usr/share/eprints3/archives/ARCHVIEID/cgi/users/sneep /usr/share/eprints3/cgi/users/sneep

Extracting

Installing on EPrints 3.1

Downloading

Make sure that you download the file at the following link, Sneep for EPrints 3.1. The file should be called sneep-3.1-XXX.tar.gz, where XXX is the version of SNEEP you have downloaded.

Extracting

  • Extract the perl_lib folder from the downloaded file into the root of your eprints installation (usually /opt/eprints3 or /usr/share/eprints3).
  • Extract the files from the archives/ARCHIVEID folder in the downloaded file into your archives/ARCHIVEID folder, where ARCHIVEID is the name of your archive.

Link CGI Scripts

Next you need to link the CGI scripts. This is done with the following commands;

ln -s /usr/share/eprints3/archives/ARCHIVEID/cgi/sneep /usr/share/eprints3/cgi/sneep
ln -s /usr/share/eprints3/archives/ARCHVIEID/cgi/users/sneep /usr/share/eprints3/cgi/users/sneep

Core Modifications

perl_lib/EPrints/DataSet.pm

In this file locate the following section:

request => {
  sqlname => "request",
  class => "EPrints::DataObj::Request",
  import => 1,
  index => 1,
  datestamp => "datestamp",
},

Immediately after this block, add the following:

sneep => {
  sqlname => "sneep",
  class => "EPrints::DataObj::Sneep",
  index => 1,
},

Next find the following in the same file,

sub get_sql_dataset_ids
{
  return( qw/ import metafield cachemap message loginticket eprint user document saved_search subject history access request / );
}

At the end of the return line add sneep so that it resembles the following;

sub get_sql_dataset_ids
{
  return( qw/ import metafield cachemap message loginticket eprint user document saved_search subject history access request sneep / );
}

Sneep Counter

To install the sneep counter in the execute the following SQL statement on your database;

INSERT INTO counters SET countername='sneepid',counter=0;

Final Steps

Run the following commands to complete installation of the sneep extension;

bin/epadmin reload ARCHIVEID
bin/epadmin update_database_structure ARCHIVEID
bin/generate_static ARCHIVEID
bin/generate_abstracts ARCHIVEID

After doing this and restarting your webserver Sneep is now installed.