Difference between revisions of "EdShare Reference Installation"

From EPrints Documentation
Jump to: navigation, search
(EPRINTS_ROOT/archives/ARCHIVEID/cfg/citations/eprint/default.xml)
m (add categories)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{EdShare}}
 
  
=Introduction=
+
EdShare on EPrints 3.2 is no longer available to download.
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==
+
'''The latest version of the fully supported EdShare, running on EPrints 3.3, is only available from EPrints Services.''' 
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==
+
Please visit http://www.eprints.org/uk/index.php/openeducation/ for further information or email K.Terrell@soton.ac.uk
  
The following conventions apply in this recipie;
+
[[Category:Obsolete]]
* ''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.
+
[[Category:EdShare]]
* ''ARCHIVEID'' - This is the id of the archive you set up that you want to carry out this recipie on.
+
[[Category:Eprints3.2]]
 
 
==Getting Started==
 
 
 
===EPrints===
 
You will need to have installed EPrints 3.1.3 before continuing. See the following pages for reference on how to do this;
 
 
 
* Ubuntu/Debian [[Installing EPrints 3 via apt (Debian/Ubuntu)]]
 
* Other Linux [[Installation|Installing from source]]
 
 
 
===Plugins===
 
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==
 
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
 
cd
 
 
 
You need to make sure this is the case before you attempt to install any of the extensions.
 
 
 
===EdShareCore===
 
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
 
tar -xzf edsharecore-VERSION.tgz
 
 
 
Next you need to update your database structure, regenerate your views and regenerate your static pages;
 
 
 
EPRINTS_ROOT/bin/epadmin update_database_structure ARCHIVEID
 
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.
 
 
 
===EdShareCollections===
 
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
 
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====
 
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' );
 
 
 
====EPRINTS_ROOT/archives/ARCHIVEID/cfg/cfg.d/eprint_warnings.pl====
 
Locate the following line;
 
 
 
if( @docs == 0 )
 
 
 
Replace it with the following;
 
 
 
if( $eprint->get_type ne 'collection' && @docs == 0 )
 
 
 
====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]]
 

Latest revision as of 00:25, 12 September 2018

EdShare on EPrints 3.2 is no longer available to download.


The latest version of the fully supported EdShare, running on EPrints 3.3, is only available from EPrints Services.


Please visit http://www.eprints.org/uk/index.php/openeducation/ for further information or email K.Terrell@soton.ac.uk