Difference between revisions of "EdShare Reference Installation"

From EPrints Documentation
Jump to: navigation, search
(EPRINTS_ROOT/archives/ARCHIVEID/cfg/citations/eprint/default.xml)
Line 24: Line 24:
  
 
===EPrints===
 
===EPrints===
You will need to have installed EPrints 3.1.3 before continuing. See the following pages for reference on how to do this;
+
You will need to have installed EPrints 3.2 before continuing. See the following pages for reference on how to do this;
  
 
* Ubuntu/Debian [[Installing EPrints 3 via apt (Debian/Ubuntu)]]
 
* Ubuntu/Debian [[Installing EPrints 3 via apt (Debian/Ubuntu)]]
 
* Other Linux [[Installation|Installing from source]]
 
* Other Linux [[Installation|Installing from source]]
  
===Plugins===
+
Create a new repository with an ARCHIVEID of your choice.
You will need to obtain the following plugins in order to complete this recipie;
+
* [[EdShareCore]]
+
* [[EdShareCollections]] ([[EdShareCollectionsInstallation]])
+
* [[EdShareToolbox]]
+
* [[MePrints]] ([[MePrintsInstall]])
+
* [[Sneep]]
+
* [[PreviewPlus]]
+
Additionally consult these pages for individual installation instructions for these plugins.
+
  
==Extensions Installation==
+
===EdShare===
Before starting ensure that you are logged in as the ''eprints'' user and in your ''EPRINTS_ROOT''. Usually you can do this by running;
+
  
sudo su eprints
+
Download the EdShare bundle for EPrints 3.2 from http://files.eprints.org
cd
+
  
You need to make sure this is the case before you attempt to install any of the extensions.
+
Untar the file
  
===EdShareCore===
+
tar xvfz edshare_3-2.tgz
Firstly change into your archive directory and extract the edsharecore tarball there. The name of your tarball may be different depending on the version you downloaded;
+
  
cd EPRINTS_ROOT/archives/ARCHIVEID
+
The edshare_3-2 directory contains a trunk directory and a default directory. Copy the contents of the trunk directory into your EPRINTS_ROOT
tar -xzf edsharecore-VERSION.tgz
+
  
Next you need to update your database structure, regenerate your views and regenerate your static pages;
+
cp -r trunk/* EPRINTS_ROOT
  
EPRINTS_ROOT/bin/epadmin update_database_structure ARCHIVEID
+
Next copy the contents of the trunk directory into your archive directory
EPRINTS_ROOT/bin/generate_views ARCHIVEID
+
EPRINTS_ROOT/bin/generate_static ARCHIVEID
+
  
Finally all you need to do is restart your web server to ensure that the settings are applied and you will now have EdShareCore installed.
+
cp -r default/* EPRINTS_ROOT/archives/ARCHIVEID/
  
===EdShareCollections===
+
Now update the database structure
If you re not in your archive directory then change into is and extract the edsharecollections tarball there. The name of your tarball may be different depending on the version you downloaded;
+
  
  cd EPRINTS_ROOT/archives/ARCHIVEID
+
  EPRINTS_ROOT/bin/epadmin update_database_structure ARCHIVEID
tar -xzf collections-VERSION.tgz
+
 
+
Next we need to link the cgi scripts;
+
 
+
ln -s EPRINTS_ROOT/archives/ARCHIVEID/cgi/users/collectionselect/ EPRINTS_ROOT/cgi/users
+
ln -s EPRINTS_ROOT/archives/ARCHIVEID/cgi/users/bookmarks/ EPRINTS_ROOT/cgi/users
+
 
+
Next assuming we are working from a vanilla installation of EPrints we need to patch the workflow so that it supports collections;
+
 
+
patch -p0 < default_collection_workflow.patch
+
 
+
If you have already changed the workflow before installing this extension then you will need to consult the [[EdShareCollectionsInstallation]] instructions.
+
 
+
There are now a few changes that need to be made to your repository configuration files.
+
 
+
====EPRINTS_ROOT/archives/ARCHIVEID/cfg/cfg.d/namedsets/eprint====
+
Add <code>collection</code> to the list of eprint types. Currently the only other type that should be in this list is resource.
+
  
====EPRINTS_ROOT/archives/ARCHIVEID/cfg/cfg.d/eprint_validate.pl====
+
To complete the install restart your webserver using your prefered method.
In the ''eprint_validate'' function look for the line <code>my @problems = ();</code> and add the following after it;
+
  
return( @problems ) if ( $eprint->get_type eq 'collection' );
+
If you have any difficulties with the above process or have any suggestions for improvements of EdShare please contact mcsweeney.patrick@gmail.com
  
====EPRINTS_ROOT/archives/ARCHIVEID/cfg/cfg.d/eprint_warnings.pl====
+
===EdShare on EPrints 3.3===
Locate the following line;
+
  
if( @docs == 0 )
+
The EdShare for EPrints 3.2 package is known not to work on EPrints 3.3. For this we are sorry.
  
Replace it with the following;
+
It is the OneShare team's ambition to make a version of EdShare for EPrints 3.3 but as yet we haven't had time to do it. The intention is that EdShare will become a set of EPrints Bazaar plugins. Which should make it easier to maintain and upgrade.
  
if( $eprint->get_type ne 'collection' && @docs == 0 )
+
If you want to encourage us please send enthusiastic emails to mcsweeney.patrick@gmail.com. Thank you for your patience.
  
====EPRINTS_ROOT/archives/ARCHIVEID/cfg/citations/eprint/default.xml====
 
You will want to change the citation that has been supplied by EdShare Core, the following section;
 
- <print expr="creators_name"/><br />
 
&lt;b>Keywords: &lt;/b><print expr="keywords"/>
 
  
Needs to be replaced with;
 
<choose>
 
  <when test="type = 'collection'">
 
    <print expr='userid'/>
 
  </when>
 
  <otherwise>
 
    - <print expr="creators_name"/><br />
 
    &lt;b>Keywords: &lt;/b><print expr="keywords"/>
 
  </otherwise>
 
</choose>
 
 
  
 
[[Category:EdShare_Recipies]]
 
[[Category:EdShare_Recipies]]

Revision as of 17:22, 8 March 2012

EdShare

Edshare logo.png

Supported EPrints Versions 3.2

Project Started 2009

Project Webpage http://edshare.org.uk


Created By ECS, University of Southampton

  • Recipies
    • EdShare Reference Installation

Introduction

The EdShare Reference Installation is the standard installation for EdShare and includes all of the functionality that is covered by the EdShare suite.

It is important to note that the EdShare Reference Installation assumes that you have a clean installation of EPrints 3.1.3.

Features

Once you have completed this recipie you will have a repository that has the following functionality;

  • A simplified workflow removing features that are not required in the context of a teaching and learning resources repository
  • Ability to create collections of resources
  • Users can bookmark resources and collections
  • There will be previews of documents on abstract pages

Installation

Conventions

The following conventions apply in this recipie;

  • EPRINTS_ROOT - This is where you installed eprints. Usually this is /usr/share/eprints3 on Debian/Ubuntu or /opt/eprints3 following a source code install. Obviously change this if you installed EPrints elsewhere.
  • ARCHIVEID - This is the id of the archive you set up that you want to carry out this recipie on.

Getting Started

EPrints

You will need to have installed EPrints 3.2 before continuing. See the following pages for reference on how to do this;

Create a new repository with an ARCHIVEID of your choice.

EdShare

Download the EdShare bundle for EPrints 3.2 from http://files.eprints.org

Untar the file

tar xvfz edshare_3-2.tgz

The edshare_3-2 directory contains a trunk directory and a default directory. Copy the contents of the trunk directory into your EPRINTS_ROOT

cp -r trunk/* EPRINTS_ROOT

Next copy the contents of the trunk directory into your archive directory

cp -r default/* EPRINTS_ROOT/archives/ARCHIVEID/

Now update the database structure

EPRINTS_ROOT/bin/epadmin update_database_structure ARCHIVEID

To complete the install restart your webserver using your prefered method.

If you have any difficulties with the above process or have any suggestions for improvements of EdShare please contact mcsweeney.patrick@gmail.com

EdShare on EPrints 3.3

The EdShare for EPrints 3.2 package is known not to work on EPrints 3.3. For this we are sorry.

It is the OneShare team's ambition to make a version of EdShare for EPrints 3.3 but as yet we haven't had time to do it. The intention is that EdShare will become a set of EPrints Bazaar plugins. Which should make it easier to maintain and upgrade.

If you want to encourage us please send enthusiastic emails to mcsweeney.patrick@gmail.com. Thank you for your patience.