EPrints Documentation - User contributions [en-gb]

MePrintsInstall

2010-03-24T14:17:03Z

Mmr@ecs.soton.ac.uk: /* Apply MePrints patchs */

[[Category:MePrints]]
This page provides technical instructions for installing the MePrints extension. To find out what MePrints is, and for an overview of MePrints features, see [[MePrintsOverview]].

==Installation (EPrints 3.1+)==

Download the latest release to your '''local repository directory''' (eg. /opt/eprints3/archives/ARCHIVEID/).

Extract files:

tar xzvf meprints_xx.tgz

===Install bin scripts===

Edit the bin/generate_meprints file and check the include path on the first line. For example if you have installed EPrints in /var/lib/eprints3 change the line from:

#!/usr/bin/perl -w -I/opt/eprints3/perl_lib

to:

#!/usr/bin/perl -w -I/var/lib/eprints3/perl_lib

===Install cgi scripts===

Link the MePrints cgi scripts into the EPrints cgi directory:

ln -s /opt/eprints3/archives/ARCHIVEID/cgi/meprints/ /opt/eprints3/cgi/
ln -s /opt/eprints3/archives/ARCHIVEID/cgi/users/meprints/ /opt/eprints3/cgi/users/

===Update database===

Add the new MePrints user fields (defined in cfg/cfg.d/z_meprints.pl) to your repository database:

cd /opt/eprints3/
bin/epadmin update_database_structure ARCHIVEID --verbose

===Apply MePrints patches===

Apply the MePrints patch files:

cd /opt/eprints3
patch -R -p0 < archives/ARCHIVE_ID/meprints_1.0.patch

DO NOT APPLY THIS FOLLOWING PATCH ON EPrints 3.2, it is not required;

patch -R -p0 < archives/ARCHIVE_ID/meprints_dataset.patch #YOU DONT NEED THIS ON 3.2 trying it might break your install

These patches change two core EPrints modules:

# Update/Views.pm - allow view pages to be generated for any dataset (MePrints adds views over the public_profile_users dataset)
# DataSet.pm - add a new dataset called public_profile_users which is the set of all users who have opted to make their public profile page visible.

==Getting Started==

To activate MePrints, you will need to make some changes to your repository setup.

===cfg/cfg.d/plugins.pl===
You can skip this step on MePrints 1.3 and later.

Add the following lines to your cfg/cfg.d/plugins.pl configuration file: to use the MePrints homepage instead instead of the default EPrints "Profile" page:

$c->{plugins}->{"Screen::User::View"}->{appears}->{key_tools} = undef;
$c->{plugin_alias_map}->{"Screen::User::View"} = "Screen::User::Homepage";

===cfg/cfg.d/user_fields_automatic.pl===

Add the following lines to your cfg/cfg.d/user_fields_automatic.pl configuration file to update the MePrints public profile page automatically when a user changes his or her profile information,

<pre>
$c->{user_fields_automatic} = sub {

my $user = @_;

...

if( defined $user->{changed} )
{
$user->remove_static();
}

};
</pre>

===cfg/cfg.d/eprint_fields_automatic.pl===

Add the following line to your cfg/cfg.d/eprint_fields_automatic.pl configuration file so that the MePrints public profile page automatically changes when an EPrint they have deposited is updated.

$eprint->get_user->remove_static;

===cfg/apachevhost.conf===

Add the following directives to your cfg/apachevhost.conf configuration file to enable canonical profile URLs (for example http://myrepository.com/profile/jsmith):

<pre>
<Location "/profile">
SetHandler perl-script
PerlResponseHandler EPrints::Plugin::MePrints::MePrintsHandler
</Location>
</pre>

===cfg/cfg.d/urls.pl===

To activate the canonical profile URLs, add "/profile/" to the rewrite_exceptions list in your cfg/cfg.d/urls.pl configuration file:

<pre>
$c->{rewrite_exceptions} = [ '/cgi/', '/archive/', '/profile/' ];
</pre>

===cfg/workflows/user/default.xml===

Add the following lines to your cfg/workflows/user/default.xml configuration file:

<stage name="default">
...

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
...
</component>

<component type="Field::Multi">
<title><epc:phrase ref="user_section_meprints" /></title>
<field ref="profile_visibility" required="yes"/>
<field ref="jobtitle"/>
<field ref="expertise"/>
<field ref="biography"/>
<field ref="qualifications"/>
</component>

===cfg/citations/user/default.xml===

Replace the default EPrints user citation with the MePrints citation (which includes a thumbnail of the user's profile picture) run:

cd /opt/eprints3/archives/ARCHIVEID
cp cfg/citations/user/default_with_thumbnail.xml cfg/citations/user/default.xml

'''Note: if you have already made changes to the default citation, you should examine both files and merge the MePrints changes into default.xml

===Authorship in MePrints===
Meprints 1.1 and later change the definition of ownership in the respository. This means that users who have the same email address as that listed in an items creators field belong to that user once the item enters the archive. This allows users to see statistics about papers they have authored without have to upload their own copy of the paper. You can return this to the eprints default by removing the cfg/cfg.d/authorship_meprints.pl file

===Confirm Permissions===
The last thing to do before using MePrints is to ensure that the permissions are correct on the ''meprints'' directory. To do this run the following commands, there probably will not be any output from running this command;
cd archives/ARCHIVEID
chmod g+wx meprints

If the permissions are not correct then you may encounter errors when using MePrints.

==Testing==

After applying all the changes above, restart Apache to activate MePrints.

===Homepage===

Log into your repository and should see your MePrints Homepage with default widget layout and profile picture.

====Update profile====

Click the Modify Profile button and add some information to the new MePrints fields (Job Title, Expertise, Biography, Qualifications). Set your Profile Visibility to '''Public'''. Click the Save button to return to your Homepage where the information you entered should now be displayed.

====Upload photo====

Click the Profile Picture button, choose a file and click Upload. You will be returned to your Homepage where your picture will now be displayed.

====MePrints Widgets====

By default your homepage displays several widgets (see user_homepage_defaults setting in cfg/cfg.d/z_meprints.pl). Try adding and removing widgets using the widget controls at the bottom of the screen. You can also rearrange widgets by dragging them up/down or between columns. To reset to the default widget layout click the Reset button in the widget control bar.

===Public Profile===

Enter the following URL to view your public profile page:

http://myrepository.com/profile/USERNAME

where USERNAME is your EPrints username. The layout of the MePrints widgets on your profile page is controlled by the user_profile_defaults setting in cfg/cfg.d/z_meprints.pl.

Go back to your MePrints homepage and click Modify Profile. Change some of your profile information (eg. Job Title, Expertise, Biography, Qualifications) and click Save. Return to your public profile page and check that your profile information has been updated.

===MePrints Views===

Run:

bin/generate_views ARCHIVEID --generate menus

Check http://myrepository.com/view/ - you should see 2 new views (you may want to link these into your site template).

Explore the view pages and check that you are listed. Make sure that you can click through from the browse listing to your public profile page.

===MePrints search===

Go to: http://myrepository.com/cgi/meprints/search

Check that you can find your profile using keywords from your user profile information (eg. expertise, qualifications).

Make sure that you can click through from the search result list to your public profile page.

===MePrints Embeddable===

If you want to use the default minimal style supplied for MePrints Embeddable then add the following code to the ''<head>'' section of your page:
<link rel="stylesheet" type="text/css" href="http://myrepository.com/style/meprints_embed.css"/>

====MePrints Embeddable Widgets====
It is possible to embed individual widgets that are viewable on your public profile on your own page. If you go to the public profile page you will see an embed links on the widgets that can be embedded. Click the link and instructions will appear telling you how to embed the widget on your page.

====MePrints Embeddable Profile====
Edit an HTML page and add the following code to the ''<head>'' section of the page:

<script type="text/javascript" src="http://myrepository.com/cgi/meprints/embed_js?username=USERNAME"></script>

Where ''USERNAME'' is your username on the repository.

Then inside the ''<body>'' section of the page you need to add the following code:

<div id="meprints_profile"></div>

This will be the location where your embeddable profile will go on your page.

===MePrints for admins===

Using an administrator account go to the Admin screen and choose '''Search users'''. Enter a username or other criteria to find at least one user account (not the account you are logged in with).

Make sure that you can click through from the results list to the user's homepage.

You should be able to modify the user's profile information by clicking Administer Account.

The widget layout should reflect the user's own preference, and you should not be able to make changes to their widget layout.

====Hide Profile====

Change the user's profile visibility to '''private'''.

Log out, and make sure that:

# the profile is no longer visible at /profile/USERNAME
# the profile no longer appears in search results
# the profile no longer appears in view pages
# the embeddable widget no longer displays the profile

You can also change the default visibility of MePrints profiles in cfg/cfg.d/z_meprints.pl
by default profiles are public unless a user specifically makes there profile private. change
$c->{default_profile_behavior} = 1;
to
$c->{default_profile_behavior} = 0;
to make the default private profiles

==Troubleshooting==

===Database errors===

When dragging and dropping Widgets around, MePrints shows database errors in the error log:

DBD::mysql::st execute failed: Duplicate entry '1-0' for key 1 at /opt/eprints3/perl_lib/EPrints/Database.pm line 1192.
at /opt/eprints3/perl_lib/EPrints/Database.pm line 1192
EPrints::Database::insert('EPrints::Database::mysql=HASH(0x2b593e11ebd0)', 'user_items_fields', 'ARRAY(0x2b593bd00510)', ...

This is a known problem which does not seem to affect widget layout.

===generate_views errors===

====Warnings====

Use of uninitialized value $id in hash element at /usr/share/eprints3/perl_lib/EPrints/Database.pm line 2979.

See http://trac.eprints.org/trac/ticket/3537

====EPrint citations====

After hiding all previously public profiles, eprint citations were rendered in the view list instead of users'. (need to work out how to reproduce this)

====Empty views====

After hiding all previously public profiles and regenerating views, view pages still show expertise/department values.

MePrintsInstall

2010-03-10T10:12:45Z

Mmr@ecs.soton.ac.uk: /* cfg/cfg.d/eprint_fields_automatic.pl */

[[Category:MePrints]]
This page provides technical instructions for installing the MePrints extension. To find out what MePrints is, and for an overview of MePrints features, see [[MePrintsOverview]].

==Installation (EPrints 3.1+)==

Download the latest release to your '''local repository directory''' (eg. /opt/eprints3/archives/ARCHIVEID/).

Extract files:

tar xzvf meprints_xx.tgz

===Install bin scripts===

Edit the bin/generate_meprints file and check the include path on the first line. For example if you have installed EPrints in /var/lib/eprints3 change the line from:

#!/usr/bin/perl -w -I/opt/eprints3/perl_lib

to:

#!/usr/bin/perl -w -I/var/lib/eprints3/perl_lib

===Install cgi scripts===

Link the MePrints cgi scripts into the EPrints cgi directory:

ln -s /opt/eprints3/archives/ARCHIVEID/cgi/meprints/ /opt/eprints3/cgi/
ln -s /opt/eprints3/archives/ARCHIVEID/cgi/users/meprints/ /opt/eprints3/cgi/users/

===Update database===

Add the new MePrints user fields (defined in cfg/cfg.d/z_meprints.pl) to your repository database:

cd /opt/eprints3/
bin/epadmin update_database_structure ARCHIVEID --verbose

===Apply MePrints patch===

Apply the MePrints patch file:

<pre>
cd /opt/eprints3
patch -R -p0 < archives/ARCHIVE_ID/meprints_1.0.patch
</pre>

This patch changes two core EPrints modules:

# DataSet.pm - add a new dataset called public_profile_users which is the set of all users who have opted to make their public profile page visible.
# Update/Views.pm - allow view pages to be generated for any dataset (MePrints adds views over the public_profile_users dataset)

==Getting Started==

To activate MePrints, you will need to make some changes to your repository setup.

===cfg/cfg.d/plugins.pl===

Add the following lines to your cfg/cfg.d/plugins.pl configuration file: to use the MePrints homepage instead instead of the default EPrints "Profile" page:

$c->{plugins}->{"Screen::User::View"}->{appears}->{key_tools} = undef;
$c->{plugin_alias_map}->{"Screen::User::View"} = "Screen::User::Homepage";

===cfg/cfg.d/user_fields_automatic.pl===

Add the following lines to your cfg/cfg.d/user_fields_automatic.pl configuration file to update the MePrints public profile page automatically when a user changes his or her profile information,

<pre>
$c->{user_fields_automatic} = sub {

my $user = @_;

...

if( defined $user->{changed} )
{
$user->remove_static();
}

};
</pre>

===cfg/cfg.d/eprint_fields_automatic.pl===

Add the following line to your cfg/cfg.d/eprint_fields_automatic.pl configuration file so that the MePrints public profile page automatically changes when an EPrint they have deposited is updated.

$eprint->get_user->remove_static;

===cfg/apachevhost.conf===

Add the following directives to your cfg/apachevhost.conf configuration file to enable canonical profile URLs (for example http://myrepository.com/profile/jsmith):

<pre>
<Location "/profile">
SetHandler perl-script
PerlResponseHandler EPrints::Plugin::MePrints::MePrintsHandler
</Location>
</pre>

===cfg/cfg.d/urls.pl===

To activate the canonical profile URLs, add "/profile/" to the rewrite_exceptions list in your cfg/cfg.d/urls.pl configuration file:

<pre>
$c->{rewrite_exceptions} = [ '/cgi/', '/archive/', '/profile/' ];
</pre>

===cfg/workflows/user/default.xml===

Add the following lines to your cfg/workflows/user/default.xml configuration file:

<stage name="default">
...

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
...
</component>

<component type="Field::Multi">
<title><epc:phrase ref="user_section_meprints" /></title>
<field ref="profile_visibility" required="yes"/>
<field ref="jobtitle"/>
<field ref="expertise"/>
<field ref="biography"/>
<field ref="qualifications"/>
</component>

===cfg/citations/user/default.xml===

Replace the default EPrints user citation with the MePrints citation (which includes a thumbnail of the user's profile picture) run:

cd /opt/eprints3/archives/ARCHIVEID
cp cfg/citations/user/default_with_thumbnail.xml cfg/citations/user/default.xml

'''Note: if you have already made changes to the default citation, you should examine both files and merge the MePrints changes into default.xml

===Authorship in MePrints===
Meprints 1.1 and later change the definition of ownership in the respository. This means that users who have the same email address as that listed in an items creators field belong to that user once the item enters the archive. This allows users to see statistics about papers they have authored without have to upload their own copy of the paper. You can return this to the eprints default by removing the cfg/cfg.d/authorship_meprints.pl file

===Confirm Permissions===
The last thing to do before using MePrints is to ensure that the permissions are correct on the ''meprints'' directory. To do this run the following commands, there probably will not be any output from running this command;
cd archives/ARCHIVEID
chmod g+wx meprints

If the permissions are not correct then you may encounter errors when using MePrints.

==Testing==

After applying all the changes above, restart Apache to activate MePrints.

===Homepage===

Log into your repository and should see your MePrints Homepage with default widget layout and profile picture.

====Update profile====

Click the Modify Profile button and add some information to the new MePrints fields (Job Title, Expertise, Biography, Qualifications). Set your Profile Visibility to '''Public'''. Click the Save button to return to your Homepage where the information you entered should now be displayed.

====Upload photo====

Click the Profile Picture button, choose a file and click Upload. You will be returned to your Homepage where your picture will now be displayed.

====MePrints Widgets====

By default your homepage displays several widgets (see user_homepage_defaults setting in cfg/cfg.d/z_meprints.pl). Try adding and removing widgets using the widget controls at the bottom of the screen. You can also rearrange widgets by dragging them up/down or between columns. To reset to the default widget layout click the Reset button in the widget control bar.

===Public Profile===

Enter the following URL to view your public profile page:

http://myrepository.com/profile/USERNAME

where USERNAME is your EPrints username. The layout of the MePrints widgets on your profile page is controlled by the user_profile_defaults setting in cfg/cfg.d/z_meprints.pl.

Go back to your MePrints homepage and click Modify Profile. Change some of your profile information (eg. Job Title, Expertise, Biography, Qualifications) and click Save. Return to your public profile page and check that your profile information has been updated.

===MePrints Views===

Run:

bin/generate_views ARCHIVEID --generate menus

Check http://myrepository.com/view/ - you should see 2 new views (you may want to link these into your site template).

Explore the view pages and check that you are listed. Make sure that you can click through from the browse listing to your public profile page.

===MePrints search===

Go to: http://myrepository.com/cgi/meprints/search

Check that you can find your profile using keywords from your user profile information (eg. expertise, qualifications).

Make sure that you can click through from the search result list to your public profile page.

===MePrints Embeddable===

If you want to use the default minimal style supplied for MePrints Embeddable then add the following code to the ''<head>'' section of your page:
<link rel="stylesheet" type="text/css" href="http://myrepository.com/style/meprints_embed.css"/>

====MePrints Embeddable Widgets====
It is possible to embed individual widgets that are viewable on your public profile on your own page. If you go to the public profile page you will see an embed links on the widgets that can be embedded. Click the link and instructions will appear telling you how to embed the widget on your page.

====MePrints Embeddable Profile====
Edit an HTML page and add the following code to the ''<head>'' section of the page:

<script type="text/javascript" src="http://myrepository.com/cgi/meprints/embed_js?username=USERNAME"></script>

Where ''USERNAME'' is your username on the repository.

Then inside the ''<body>'' section of the page you need to add the following code:

<div id="meprints_profile"></div>

This will be the location where your embeddable profile will go on your page.

===MePrints for admins===

Using an administrator account go to the Admin screen and choose '''Search users'''. Enter a username or other criteria to find at least one user account (not the account you are logged in with).

Make sure that you can click through from the results list to the user's homepage.

You should be able to modify the user's profile information by clicking Administer Account.

The widget layout should reflect the user's own preference, and you should not be able to make changes to their widget layout.

====Hide Profile====

Change the user's profile visibility to '''private'''.

Log out, and make sure that:

# the profile is no longer visible at /profile/USERNAME
# the profile no longer appears in search results
# the profile no longer appears in view pages
# the embeddable widget no longer displays the profile

You can also change the default visibility of MePrints profiles in cfg/cfg.d/z_meprints.pl
by default profiles are public unless a user specifically makes there profile private. change
$c->{default_profile_behavior} = 1;
to
$c->{default_profile_behavior} = 0;
to make the default private profiles

==Troubleshooting==

===Database errors===

When dragging and dropping Widgets around, MePrints shows database errors in the error log:

DBD::mysql::st execute failed: Duplicate entry '1-0' for key 1 at /opt/eprints3/perl_lib/EPrints/Database.pm line 1192.
at /opt/eprints3/perl_lib/EPrints/Database.pm line 1192
EPrints::Database::insert('EPrints::Database::mysql=HASH(0x2b593e11ebd0)', 'user_items_fields', 'ARRAY(0x2b593bd00510)', ...

This is a known problem which does not seem to affect widget layout.

===generate_views errors===

====Warnings====

Use of uninitialized value $id in hash element at /usr/share/eprints3/perl_lib/EPrints/Database.pm line 2979.

See http://trac.eprints.org/trac/ticket/3537

====EPrint citations====

After hiding all previously public profiles, eprint citations were rendered in the view list instead of users'. (need to work out how to reproduce this)

====Empty views====

After hiding all previously public profiles and regenerating views, view pages still show expertise/department values.

MePrintsInstall

2010-03-10T10:12:36Z

Mmr@ecs.soton.ac.uk: /* Getting Started */

[[Category:MePrints]]
This page provides technical instructions for installing the MePrints extension. To find out what MePrints is, and for an overview of MePrints features, see [[MePrintsOverview]].

==Installation (EPrints 3.1+)==

Download the latest release to your '''local repository directory''' (eg. /opt/eprints3/archives/ARCHIVEID/).

Extract files:

tar xzvf meprints_xx.tgz

===Install bin scripts===

Edit the bin/generate_meprints file and check the include path on the first line. For example if you have installed EPrints in /var/lib/eprints3 change the line from:

#!/usr/bin/perl -w -I/opt/eprints3/perl_lib

to:

#!/usr/bin/perl -w -I/var/lib/eprints3/perl_lib

===Install cgi scripts===

Link the MePrints cgi scripts into the EPrints cgi directory:

ln -s /opt/eprints3/archives/ARCHIVEID/cgi/meprints/ /opt/eprints3/cgi/
ln -s /opt/eprints3/archives/ARCHIVEID/cgi/users/meprints/ /opt/eprints3/cgi/users/

===Update database===

Add the new MePrints user fields (defined in cfg/cfg.d/z_meprints.pl) to your repository database:

cd /opt/eprints3/
bin/epadmin update_database_structure ARCHIVEID --verbose

===Apply MePrints patch===

Apply the MePrints patch file:

<pre>
cd /opt/eprints3
patch -R -p0 < archives/ARCHIVE_ID/meprints_1.0.patch
</pre>

This patch changes two core EPrints modules:

# DataSet.pm - add a new dataset called public_profile_users which is the set of all users who have opted to make their public profile page visible.
# Update/Views.pm - allow view pages to be generated for any dataset (MePrints adds views over the public_profile_users dataset)

==Getting Started==

To activate MePrints, you will need to make some changes to your repository setup.

===cfg/cfg.d/plugins.pl===

Add the following lines to your cfg/cfg.d/plugins.pl configuration file: to use the MePrints homepage instead instead of the default EPrints "Profile" page:

$c->{plugins}->{"Screen::User::View"}->{appears}->{key_tools} = undef;
$c->{plugin_alias_map}->{"Screen::User::View"} = "Screen::User::Homepage";

===cfg/cfg.d/user_fields_automatic.pl===

Add the following lines to your cfg/cfg.d/user_fields_automatic.pl configuration file to update the MePrints public profile page automatically when a user changes his or her profile information,

<pre>
$c->{user_fields_automatic} = sub {

my $user = @_;

...

if( defined $user->{changed} )
{
$user->remove_static();
}

};
</pre>

===cfg/cfg.d/eprint_fields_automatic.pl===

Add the following line to your cfg/cfg.d/eprint_fields_automatic.pl configuration file so that the MePrints public profile page automatically changes when an EPrint they have deposited is updated.

$eprint->get_user->remove_static;

===cfg/apachevhost.conf===

Add the following directives to your cfg/apachevhost.conf configuration file to enable canonical profile URLs (for example http://myrepository.com/profile/jsmith):

<pre>
<Location "/profile">
SetHandler perl-script
PerlResponseHandler EPrints::Plugin::MePrints::MePrintsHandler
</Location>
</pre>

===cfg/cfg.d/urls.pl===

To activate the canonical profile URLs, add "/profile/" to the rewrite_exceptions list in your cfg/cfg.d/urls.pl configuration file:

<pre>
$c->{rewrite_exceptions} = [ '/cgi/', '/archive/', '/profile/' ];
</pre>

===cfg/workflows/user/default.xml===

Add the following lines to your cfg/workflows/user/default.xml configuration file:

<stage name="default">
...

<component type="Field::Multi">
<title><epc:phrase ref="user_section_personal" /></title>
...
</component>

<component type="Field::Multi">
<title><epc:phrase ref="user_section_meprints" /></title>
<field ref="profile_visibility" required="yes"/>
<field ref="jobtitle"/>
<field ref="expertise"/>
<field ref="biography"/>
<field ref="qualifications"/>
</component>

===cfg/citations/user/default.xml===

Replace the default EPrints user citation with the MePrints citation (which includes a thumbnail of the user's profile picture) run:

cd /opt/eprints3/archives/ARCHIVEID
cp cfg/citations/user/default_with_thumbnail.xml cfg/citations/user/default.xml

'''Note: if you have already made changes to the default citation, you should examine both files and merge the MePrints changes into default.xml

===Authorship in MePrints===
Meprints 1.1 and later change the definition of ownership in the respository. This means that users who have the same email address as that listed in an items creators field belong to that user once the item enters the archive. This allows users to see statistics about papers they have authored without have to upload their own copy of the paper. You can return this to the eprints default by removing the cfg/cfg.d/authorship_meprints.pl file

===Confirm Permissions===
The last thing to do before using MePrints is to ensure that the permissions are correct on the ''meprints'' directory. To do this run the following commands, there probably will not be any output from running this command;
cd archives/ARCHIVEID
chmod g+wx meprints

If the permissions are not correct then you may encounter errors when using MePrints.

==Testing==

After applying all the changes above, restart Apache to activate MePrints.

===Homepage===

Log into your repository and should see your MePrints Homepage with default widget layout and profile picture.

====Update profile====

Click the Modify Profile button and add some information to the new MePrints fields (Job Title, Expertise, Biography, Qualifications). Set your Profile Visibility to '''Public'''. Click the Save button to return to your Homepage where the information you entered should now be displayed.

====Upload photo====

Click the Profile Picture button, choose a file and click Upload. You will be returned to your Homepage where your picture will now be displayed.

====MePrints Widgets====

By default your homepage displays several widgets (see user_homepage_defaults setting in cfg/cfg.d/z_meprints.pl). Try adding and removing widgets using the widget controls at the bottom of the screen. You can also rearrange widgets by dragging them up/down or between columns. To reset to the default widget layout click the Reset button in the widget control bar.

===Public Profile===

Enter the following URL to view your public profile page:

http://myrepository.com/profile/USERNAME

where USERNAME is your EPrints username. The layout of the MePrints widgets on your profile page is controlled by the user_profile_defaults setting in cfg/cfg.d/z_meprints.pl.

Go back to your MePrints homepage and click Modify Profile. Change some of your profile information (eg. Job Title, Expertise, Biography, Qualifications) and click Save. Return to your public profile page and check that your profile information has been updated.

===MePrints Views===

Run:

bin/generate_views ARCHIVEID --generate menus

Check http://myrepository.com/view/ - you should see 2 new views (you may want to link these into your site template).

Explore the view pages and check that you are listed. Make sure that you can click through from the browse listing to your public profile page.

===MePrints search===

Go to: http://myrepository.com/cgi/meprints/search

Check that you can find your profile using keywords from your user profile information (eg. expertise, qualifications).

Make sure that you can click through from the search result list to your public profile page.

===MePrints Embeddable===

If you want to use the default minimal style supplied for MePrints Embeddable then add the following code to the ''<head>'' section of your page:
<link rel="stylesheet" type="text/css" href="http://myrepository.com/style/meprints_embed.css"/>

====MePrints Embeddable Widgets====
It is possible to embed individual widgets that are viewable on your public profile on your own page. If you go to the public profile page you will see an embed links on the widgets that can be embedded. Click the link and instructions will appear telling you how to embed the widget on your page.

====MePrints Embeddable Profile====
Edit an HTML page and add the following code to the ''<head>'' section of the page:

<script type="text/javascript" src="http://myrepository.com/cgi/meprints/embed_js?username=USERNAME"></script>

Where ''USERNAME'' is your username on the repository.

Then inside the ''<body>'' section of the page you need to add the following code:

<div id="meprints_profile"></div>

This will be the location where your embeddable profile will go on your page.

===MePrints for admins===

Using an administrator account go to the Admin screen and choose '''Search users'''. Enter a username or other criteria to find at least one user account (not the account you are logged in with).

Make sure that you can click through from the results list to the user's homepage.

You should be able to modify the user's profile information by clicking Administer Account.

The widget layout should reflect the user's own preference, and you should not be able to make changes to their widget layout.

====Hide Profile====

Change the user's profile visibility to '''private'''.

Log out, and make sure that:

# the profile is no longer visible at /profile/USERNAME
# the profile no longer appears in search results
# the profile no longer appears in view pages
# the embeddable widget no longer displays the profile

You can also change the default visibility of MePrints profiles in cfg/cfg.d/z_meprints.pl
by default profiles are public unless a user specifically makes there profile private. change
$c->{default_profile_behavior} = 1;
to
$c->{default_profile_behavior} = 0;
to make the default private profiles

==Troubleshooting==

===Database errors===

When dragging and dropping Widgets around, MePrints shows database errors in the error log:

DBD::mysql::st execute failed: Duplicate entry '1-0' for key 1 at /opt/eprints3/perl_lib/EPrints/Database.pm line 1192.
at /opt/eprints3/perl_lib/EPrints/Database.pm line 1192
EPrints::Database::insert('EPrints::Database::mysql=HASH(0x2b593e11ebd0)', 'user_items_fields', 'ARRAY(0x2b593bd00510)', ...

This is a known problem which does not seem to affect widget layout.

===generate_views errors===

====Warnings====

Use of uninitialized value $id in hash element at /usr/share/eprints3/perl_lib/EPrints/Database.pm line 2979.

See http://trac.eprints.org/trac/ticket/3537

====EPrint citations====

After hiding all previously public profiles, eprint citations were rendered in the view list instead of users'. (need to work out how to reproduce this)

====Empty views====

After hiding all previously public profiles and regenerating views, view pages still show expertise/department values.

EdShare Reference Installation

2010-02-12T11:12:21Z

Mmr@ecs.soton.ac.uk: /* EPRINTS_ROOT/archives/ARCHIVEID/cfg/citations/eprint/default.xml */

{{EdShare}}

=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.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 />
<b>Keywords: </b><print expr="keywords"/>

Needs to be replaced with;
<choose>
<when test="type = 'collection'">
<print expr='userid'/>
</when>
<otherwise>
- <print expr="creators_name"/><br />
<b>Keywords: </b><print expr="keywords"/>
</otherwise>
</choose>

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-12T11:06:39Z

Mmr@ecs.soton.ac.uk: /* EPRINTS_ROOT/archives/ARCHIVEID/cfg/citations/eprint/default.xml */

{{EdShare}}

=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.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;
<nowiki>
- <print expr="creators_name"/><br />
<b>Keywords: </b><print expr="keywords"/>
</nowiki>
Needs to be replaced with;
<choose>
<when test="type = 'collection'">
<print expr='userid'/>
</when>
<otherwise>
- <print expr="creators_name"/><br />
<b>Keywords: </b><print expr="keywords"/>
</otherwise>
</choose>

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-12T11:06:02Z

Mmr@ecs.soton.ac.uk: /* EPRINTS_ROOT/archives/ARCHIVEID/cfg/citations/eprint/default.xml */

EdShare Reference Installation

2010-02-11T13:46:59Z

Mmr@ecs.soton.ac.uk: /* EdShareCollections */

{{EdShare}}

=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.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====
Assuming you haven't modified the default citation you want to look for the first <choose> block at the top of the citation. And add the following;
<choose>

<when test="type = 'collection'">
<print expr="userid"/>
</when>

</choose>

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-11T13:37:56Z

Mmr@ecs.soton.ac.uk: /* EdShareCollections */

EdShare Reference Installation

2010-02-11T11:56:51Z

Mmr@ecs.soton.ac.uk: /* EdShareCollections */

{{EdShare}}

=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.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 [[EdShareCollectionInstallation]] instructions.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-11T11:10:47Z

Mmr@ecs.soton.ac.uk: /* EPrints */

EdShare Reference Installation

2010-02-11T11:10:26Z

Mmr@ecs.soton.ac.uk: /* Introduction */

EdShare Reference Installation

2010-02-11T11:09:19Z

Mmr@ecs.soton.ac.uk: /* Plugin Installation */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=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 at least EPrints 3.1 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

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-11T11:04:24Z

Mmr@ecs.soton.ac.uk: /* Plugin Installation */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=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 at least EPrints 3.1 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.

==Plugin Installation==

===EdShareCore===
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

Next 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 archives/ARCHIVEID
tar -xzf edsharecore-x.tar.gz

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.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-11T11:04:00Z

Mmr@ecs.soton.ac.uk: /* Plugin Installation */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=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 at least EPrints 3.1 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.

==Plugin Installation==

===EdShareCore===
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

Next 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 archives/ARCHIVEID
tar -xzf edsharecore-x.tar.gz

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 are then done.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T16:50:21Z

Mmr@ecs.soton.ac.uk: /* EdShareCore */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=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 at least EPrints 3.1 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.

==Plugin Installation==

===EdShareCore===
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

Next 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 archives/ARCHIVEID
tar -xzf edsharecore-x.tar.gz

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T16:48:15Z

Mmr@ecs.soton.ac.uk: /* EdShareCore */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=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 at least EPrints 3.1 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.

==Plugin Installation==

===EdShareCore===
Before starting ensure that you are logged in as the ''eprints'' user and in your ''EPRINTS_HOME''.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T16:47:02Z

Mmr@ecs.soton.ac.uk: /* Plugins */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=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 at least EPrints 3.1 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.

==Plugin Installation==

===EdShareCore===

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T16:46:20Z

Mmr@ecs.soton.ac.uk: /* Installation */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=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 at least EPrints 3.1 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]]
* [[Sneep]]
* [[PreviewPlus]]
Additionally consult these pages for individual installation instructions for these plugins.

==Plugin Installation==

===EdShareCore===

[[Category:EdShare_Recipies]]

Sneep

2010-02-10T16:41:14Z

Mmr@ecs.soton.ac.uk: moved EdShareSneep to Sneep

[[Category:EdShare]]
=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-VERSION.tar.gz, where ''VERSION'' is the version of SNEEP you have downloaded.

===Extracting===
The package should be extracted in the appropriate archive directory of your EPrints installation. Run the following commands replacing ''ARCHIVEID'' with the name of the archive you want the collections on, and replace ''VERSION'' with the appropriate version number based on the package you have downloaded;

cd /opt/eprints3/archives/ARCHIVEID
tar -xzf sneep-3.2-VERSION.tar.gz

These commands assume that you installed EPrints to ''/opt/eprints3'' substitute this for something else if you installed it elsewhere. Users of the Ubuntu version of EPrints will find that it is installed by default at ''/usr/share/eprints3''.

===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

You will need to replace <code>/usr/share/eprints3</code> with your appropriate EPrints directory and change ARCHIVEID to the name of your archive.

===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.

==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-VERSION.tar.gz, where ''VERSION'' 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

You will need to replace <code>/usr/share/eprints3</code> with your appropriate EPrints directory and change ARCHIVEID to the name of your archive.

===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.

EdShareSneep

2010-02-10T16:41:14Z

Mmr@ecs.soton.ac.uk: moved EdShareSneep to Sneep

#REDIRECT [[Sneep]]

MePrints

2010-02-10T16:40:45Z

Mmr@ecs.soton.ac.uk: moved MePrintsOverview to MePrints

[[Category:MePrints]]
All About MEPrints is a JISC rapid innovations project to build a user profile system for EPrints. The aim is that every repository user will have a page which promotes their work and identity within the repository and beyond. It is hoped this will improve user-to-repository relations and also provide useful information for user-to-user interactions.

The extension we have developed is called MePrints. This page gives an overview of the features of the MePrints extension.

For technical instructions on how to install MePrints, see [[MePrintsInstall]].

=Introduction=

MePrints is a plugin for EPrints 3.1+ that extends the user aspect of EPrints with user profiles and homepages. Profile pages are public-facing pages providing, admin-customisable, information ''about'' the user. Homepages replace the current EPrints "Profile" page and provide, admin and user-customisable, information from the repository so that the user can get a quick overview of anything that is relevant to them.

The hope is that MePrints functionality will find it's way into the EPrints 3.2 trunk so that it is available to use with a new install of EPrints.

=Features=

MePrints brings a number of additional features to EPrints to improve your user experience with EPrints.

==Profile Pages==
[[Image:MePrints User Profile Thumb.png|frame|right|||An example MePrints User Profile||This image shows an example MePrints User Profile.]]

Public user profile pages provide a static view of data that describes you as a repository user. The information that is displayed on these pages is configurable by the repository administrator. If you do not want your profile page to be accessible to the outside world then you can set your profile to be hidden so that it is not visible to anyone. Profiles also have a search engine friendly URL assigned to them as well in the form <nowiki>http://repository.org/profile/username</nowiki>. This allows you to easily share their EPrints profile with other people.

Profile pages include the following information;
* Name
* Expertise
* Qualifications
* Divisions
* Biography
* User Image

<div style="clear: both;"></div>

==Homepages==
[[Image:MePrints Homepage Thumb.png|frame|right|||An example MePrints User Homepage||This image shows a screenshot of an example MePrints User Homepage.]]

This replaces the initial "Manage Deposits" view that you see when they first login. The "Manage Deposits" view is still available although it is now accessible through the link at the top of the page.

This page is highly customisable for both the repository administrator and you. A repository administrator can create [[#Widgets|widgets]], which are a special type of plugin that provide information from the repository that is relevant to you. Also the administrator can create different layouts for the homepage so that [[#Widgets|widgets]] on the page will be laid out in different ways. You can then choose the layout that you prefer from a number of available layouts if your repository administrator has made several available for use.

You can further customise your homepage by changing the positions of the widgets and adding or removing [[#Widgets|widgets]] that the repository administrator has installed.

<div style="clear: both;"></div>

==Widgets==
Widgets appear both on your profile and your homepage. The widgets that appear on your profile are managed by the repository administrator while on your homepage you have a degree of control over what widgets appear, from the collection of available widgets, and where on the page they appear.

Widgets available by default with MePrints include;
* User Details - Shows the username, biography, expertise and other core data fields.
* User Picture - Allows the user to upload an image of themselves for their profile.
* User Actions - Adds a box containing all of the possible user actions.
* Recently Published Items - Shows items that the user has recently published in the repository.
* Item Issues - Shows any issues with items, owned by the user, that have been discovered by an issues audit.
* Quick Upload - Allows the user to upload a file and attach it to a new record in their inbox, ready for publication on the repository later.
* Most Popular Items - Looks at the number of times a users items have been accessed and displays a rundown of the most popular.
* IRStats Mini Dashboard - If the repository has IRStats installed this widget can display data from it and allow the user to look at a number of different statistics regarding their publications.

This list may differ for you if your repository administrator has disabled or added any widgets.

==Searching For Users==
MePrints makes it possible for you to search through all of the users who have made their profiles public. If you make your profile private and don't allow anyone to see it then it will not be included in any search results as well as not allowing anyone to view it.

===Browsing For Users By Expertise===
A new browse view has been added with MePrints that allows you to browse for users by expertise.

===User Search Page===
There is a new user search provided by MePrints, cgi/search_users, which allows you to search through users in the EPrints repository.

=Installation=
Installation of MePrints on an existing EPrints 3.1 repository has been designed to be a simple as possible. Full instructions for installation can be found at [[MePrintsInstall]].

MePrintsOverview

2010-02-10T16:40:45Z

Mmr@ecs.soton.ac.uk: moved MePrintsOverview to MePrints

#REDIRECT [[MePrints]]

EdShare Reference Installation

2010-02-10T16:40:13Z

Mmr@ecs.soton.ac.uk: /* Plugins */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=Installation=

==Getting Started==

===EPrints===
You will need to have installed at least EPrints 3.1 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]]
* [[Sneep]]
* [[PreviewPlus]]
Additionally consult these pages for individual installation instructions for these plugins.

==Plugin Installation==

===EdShareCore===

[[Category:EdShare_Recipies]]

EdShareCollections

2010-02-10T16:39:41Z

Mmr@ecs.soton.ac.uk: /* Introduction */

[[Category:EdShare]]
{{EdShare}}

=Introduction=
The collections plugin is part of [[EdShare]] suite. It is based on code developed in EdShare and LanguageBox. The goal of this project is to produce a package that allows the easy installation of the collections functionality on a vanilla EPrints installation.

'''For installation instructions head to [[EdShareCollectionsInstallation]].'''

==Current Version==
The latest version of EdShareCollections is 1.0.2 and can be found at the download site.

==Download==
The plugin is available for download from http://files.eprints.org.

==Authors==
The original collections code was developed by Sebastien Francois and Patrick McSweeny. The EdShare package was created by Marcus Ramsden based upon the original collections code by Sebastien and Patrick.

==Copyright==
EdShare Collections, University of Southampton ©2009

This plugin is released under the terms of the GNU General Public License v3. Details of this license can be found [http://www.gnu.org/licenses/gpl.txt here].

=Features=

==Collections==
* Allows a user to remix a number of resources into a new resource.

==Collection Workflow==
* A new workflow has been introduced with this plugin.
* This workflow integrates seamlessly into your installation of EPrints adding an additional button to the ''Manage Items'' screen for the user. It also adds an appropriate editor screen. The workflow does not interfere with the original EPrint workflow.

==Collection Abstract View==
* A different abstract view is rendered for collections. The collection workflow is modified in a similar way to eprint abstracts.

==Bookmarks==
* Allows a user to create bookmarks of resources that are currently stored within your repository.

EdShare Reference Installation

2010-02-10T16:38:34Z

Mmr@ecs.soton.ac.uk: /* EdShare Core */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=Installation=

==Getting Started==

===EPrints===
You will need to have installed at least EPrints 3.1 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]]
* [[EdShareToolbox]]
* [[MePrints]]
* [[Sneep]]
* [[PreviewPlus]]
Additionally consult these pages for individual installation instructions for these plugins.

==Plugin Installation==

===EdShareCore===

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T16:38:28Z

Mmr@ecs.soton.ac.uk: /* Installation */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=Installation=

==Getting Started==

===EPrints===
You will need to have installed at least EPrints 3.1 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]]
* [[EdShareToolbox]]
* [[MePrints]]
* [[Sneep]]
* [[PreviewPlus]]
Additionally consult these pages for individual installation instructions for these plugins.

==Plugin Installation==

===EdShare Core===

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T16:16:34Z

Mmr@ecs.soton.ac.uk: /* Plugins */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=Installation=

==Getting Started==

===EPrints===
You will need to have installed at least EPrints 3.1 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]]
* [[EdShareToolbox]]
* [[MePrints]]
* [[Sneep]]
* [[PreviewPlus]]
Additionally consult these pages for individual installation instructions for these plugins.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T16:15:53Z

Mmr@ecs.soton.ac.uk: /* Plugins */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=Installation=

==Getting Started==

===EPrints===
You will need to have installed at least EPrints 3.1 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]]
* [[EdShareToolbox]]
* [[MePrints]]
* [[Sneep]]
* [[PreviewPlus]]

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T16:14:13Z

Mmr@ecs.soton.ac.uk: /* Getting Started */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=Installation=

==Getting Started==

===EPrints===
You will need to have installed at least EPrints 3.1 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.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T16:13:22Z

Mmr@ecs.soton.ac.uk: /* Getting Started */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=Installation=

==Getting Started==

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

<table border="1">
<tr><td>Ubuntu/Debian</td><td>[[Installing EPrints 3 via apt (Debian/Ubuntu)]]</td></tr>
<tr><td>Other Linux</td><td>[[Installation|Installing from source]]</td></tr>
</table>

===Plugins===
You will need to obtain the following plugins in order to complete this recipie.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T15:39:15Z

Mmr@ecs.soton.ac.uk:

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=Installation=

==Getting Started==

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

<table>
<tr><td>Ubuntu/Debian</td><td>[[Installing EPrints 3 via apt (Debian/Ubuntu)]]</td></tr>
<tr><td>Other Linux</td><td>[[Installation|Installing from source]]</td></tr>
</table>

===Plugins===
You will need to obtain the following plugins in order to complete this recipie.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T15:33:46Z

Mmr@ecs.soton.ac.uk: /* Getting Started */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=Installation=

==Getting Started==

===EPrints===
You will need to have installed at least EPrints 3.1 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.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T15:29:22Z

Mmr@ecs.soton.ac.uk: /* Time Required */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins. Additionally you should be comfortable working on a Linux command line.

=Installation=

==Getting Started==
You will need to obtain the following plugins in order to complete this recipie.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T15:28:44Z

Mmr@ecs.soton.ac.uk: /* Introduction */

{{EdShare}}

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

==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

==Time Required==
'''2 hours'''

This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins.

=Installation=

==Getting Started==
You will need to obtain the following plugins in order to complete this recipie.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T15:27:46Z

Mmr@ecs.soton.ac.uk: /* Introduction */

{{EdShare}}

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

Estimated time for completion '''2 hours'''. This time is purely an estimate, it may take you longer if you are not well versed in the customisation of EPrints through plugins.

==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=

==Getting Started==
You will need to obtain the following plugins in order to complete this recipie.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T15:26:18Z

Mmr@ecs.soton.ac.uk:

{{EdShare}}

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

==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=

==Getting Started==
You will need to obtain the following plugins in order to complete this recipie.

[[Category:EdShare_Recipies]]

EdShare Reference Installation

2010-02-10T15:25:26Z

Mmr@ecs.soton.ac.uk:

{{EdShare}}

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

==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

[[Category:EdShare_Recipies]]

Category:EdShare

2010-02-10T14:47:15Z

Mmr@ecs.soton.ac.uk:

{{EdShare}}

=Introduction=

EdShare is a suite of plugins for EPrints 3 that allows you to quickly create a repository that is to be used to learning and teaching resources. The goal of the suite is that each plugin is capable or operating independently of the suite so that you can pick and choose the functionality you require.

The EdShare suite is also designed to function in conjunction with a number of other plugins to create the [[EdShare Reference Installation]]. These additional plugins include [[MePrints]], [[Sneep]] and [[PreviewPlus]].

The EdShare suite was created by the OneShare project at the University of Southampton.

=Plugins=

=Recipies=

[[Category:EPrints 3 Plugins]]

Category:EdShare

2010-02-10T14:46:44Z

Mmr@ecs.soton.ac.uk:

{{Stub}}
{{EdShare}}

=Introduction=

EdShare is a suite of plugins for EPrints 3 that allows you to quickly create a repository that is to be used to learning and teaching resources. The goal of the suite is that each plugin is capable or operating independently of the suite so that you can pick and choose the functionality you require.

The EdShare suite is also designed to function in conjunction with a number of other plugins to create the [[EdShare Reference Installation]]. These additional plugins include [[MePrints]], [[Sneep]] and [[PreviewPlus]].

The EdShare suite was created by the OneShare project at the University of Southampton.

[[Category:EPrints 3 Plugins]]

EdShareToolbox

2010-02-10T14:44:27Z

Mmr@ecs.soton.ac.uk:

[[Category:EdShare]]
{{EdShare}}
=Introduction=
The EdShareToolbox is a very simple plugin that allows a repository administrator to easily add links to carry out actions on EPrint items.

==Authors==
The EdShareToolbox was created by Marcus Ramsden.

==Copyright==
EdShare Toolbox, Copyright © 2009 University of Southampton

This plugin is released under the terms of the GNU General Public License v3. Details of this license can be found [http://www.gnu.org/licenses/gpl.txt here].

=Installation=
Installation should be relatively simple and similar to the installation of other plugins from the EdShare family.

==Extract Package==
The package should be extracted in the appropriate archive directory of your EPrints installation. Run the following commands replacing ''ARCHIVEID'' with the name of the archive you want the collections on, and replace ''VERSION'' with the appropriate version number based on the package you have downloaded;

cd /opt/eprints3/archives/ARCHIVEID
tar -xzf toolbox-VERSION.tar.gz

These commands assume that you installed EPrints to ''/opt/eprints3'' substitute this for something else if you installed it elsewhere. Users of the Ubuntu version of EPrints will find that it is installed by default at ''/usr/share/eprints3''.

==Install CGI Scripts==
Link the toolbox CGI script to the EPrints CGI directory;

ln -s /opt/eprints3/archives/ARCHIVEID/cgi/edsharetoolbox/ /opt/eprints3/cgi/

==Modify Plugins==
Having your plugin register an action on the toolbox is very simple. All you need to do is add a <code>render_toolbox_item</code> function to your plugin. This function is expected to return a DOM node that will be appended to a list element in the toolbox. You then just need to add the name of the plugin to the ''archives/ARCHIVEID/cfg/cfg.d/edsharetoolbox.pl'' file.

Here is an example for EPrints::Plugin::Foo.

First in EPrints::Plugin::Foo we add the following <code>render_toolbox_item</code> function;

sub render_toolbox_item
{
my( $session, $processor, $dynamic ) = @_;

my $frag = $session->make_doc_fragment;

if( $dynamic )
{
my $link = $session->make_element( "a", href=>"#", onclick=>"ep_foo_action(); return false;" );
$link->appendChild( $session->make_text( "This is an ajax action" ) );
$frag->appendChild( $link );
}
else
{
my $link = $session->make_element( "a", href=>"/cgi/user/home?screen=Foo" );
$link->appendChild( $session->make_text( "This is a standard link" ) );
$frag->appendChild( $link );
}

return $frag;
}

In this function we have an example of a link which has both a default static function and an AJAX function call when you click on it in the event of <code>$dynamic</code> being true. Note that in the <code>ep_foo_action()</code> that a call to <code>ep_refresh_edshare_toolbox</code> should be made at the end of the function. This is needed to update the list as a result of your action being executed.

Finally you need to add the name of the plugin, ''EPrints::Plugin::Foo'', to both the ''toolbox_static_plugins'' and ''toolbox_dynamic_plugins'' array. If you don't add it to ''toolbox_dynamic_plugins'' then it will not be re-rendered at the page load falling back to just the static render case.

Now you just need to run;

bin/generate_abstracts *archiveid*

If this is the first install of the plugin then you will also need to run;

bin/generate_static *archiveid*

Finally restart your web server and you should have the toolbox on your abstract pages.

EdShareCollections

2010-02-10T14:44:07Z

Mmr@ecs.soton.ac.uk:

[[Category:EdShare]]
{{EdShare}}

=Introduction=
The collections plugin is part of [[EdShare]] suite. It is based on code developed in EdShare and LanguageBox. The goal of this project is to produce a package that allows the easy installation of the collections functionality on a vanilla EPrints installation.

'''For installation instructions head to [[EdShareCollectionsInstallation]].'''

==Download==
The plugin is available for download from http://files.eprints.org.

==Authors==
The original collections code was developed by Sebastien Francois and Patrick McSweeny. The EdShare package was created by Marcus Ramsden based upon the original collections code by Sebastien and Patrick.

==Copyright==
EdShare Collections, University of Southampton ©2009

This plugin is released under the terms of the GNU General Public License v3. Details of this license can be found [http://www.gnu.org/licenses/gpl.txt here].

=Features=

==Collections==
* Allows a user to remix a number of resources into a new resource.

==Collection Workflow==
* A new workflow has been introduced with this plugin.
* This workflow integrates seamlessly into your installation of EPrints adding an additional button to the ''Manage Items'' screen for the user. It also adds an appropriate editor screen. The workflow does not interfere with the original EPrint workflow.

==Collection Abstract View==
* A different abstract view is rendered for collections. The collection workflow is modified in a similar way to eprint abstracts.

==Bookmarks==
* Allows a user to create bookmarks of resources that are currently stored within your repository.

EdShare Reference Installation

2010-02-10T14:42:42Z

Mmr@ecs.soton.ac.uk: Created page with '{{EdShare}} Category:EdShare_Recipies'

{{EdShare}}

[[Category:EdShare_Recipies]]

Template:EdShare

2010-02-10T14:39:06Z

Mmr@ecs.soton.ac.uk:

{{box|title=EdShare|content=
[[Image:Edshare_logo.png]]

'''Supported EPrints Versions'''
3.1.3, 3.2+

'''Project Started'''
2009

'''Created By'''
[http://ecs.soton.ac.uk ECS], [http://www.southampton.ac.uk University of Southampton]

* Plugins
** [[EdShareCore]]
** [[EdShareCollections]]
** [[EdShareToolbox]]
* External Plugins
** [[MePrints]]
** [[Sneep]]
** [[PreviewPlus]]
* Recipies
** [[EdShare Reference Installation]]
}}

Category:EdShare

2010-02-10T14:35:16Z

Mmr@ecs.soton.ac.uk:

Template:EdShare

2010-02-10T14:34:31Z

Mmr@ecs.soton.ac.uk:

Category:EdShare

2010-02-10T14:32:43Z

Mmr@ecs.soton.ac.uk:

{{EdShare}}

EdShare is a suite of plugins for EPrints 3 that allows you to quickly create a repository that is to be used to learning and teaching resources. The goal of the suite is that each plugin is capable or operating independently of the suite so that you can pick and choose the functionality you require.

The EdShare suite is also designed to function in conjunction with a number of other plugins to create the [[EdShare Reference Installation]]. These additional plugins include [[MePrints]], [[Sneep]] and [[PreviewPlus]].

The EdShare suite was created by the OneShare project at the University of Southampton.

[[Category:EPrints 3 Plugins]]

Template:EdShare

2010-02-10T14:31:08Z

Mmr@ecs.soton.ac.uk:

Template:EdShare

2010-02-10T14:27:17Z

Mmr@ecs.soton.ac.uk: Created page with '{{box|title=EdShare|content= Image:Edshare_logo.png '''Supported EPrints Versions''' 3.1.3, 3.2+ '''Project Started''' 2009 '''Created By''' [http://ecs.soton.ac.uk ECS], …'

File:Edshare logo.png

2010-02-10T14:02:34Z

Mmr@ecs.soton.ac.uk: This is the logo for the EdShare suite of plugins.

This is the logo for the EdShare suite of plugins.

Category:EdShare

2010-02-10T14:01:12Z

Mmr@ecs.soton.ac.uk:

EdShare is a suite of plugins for EPrints 3 that allows you to quickly create a repository that is to be used to learning and teaching resources. The goal of the suite is that each plugin is capable or operating independently of the suite so that you can pick and choose the functionality you require.

The EdShare suite was created by the OneShare project at the University of Southampton.

[[Category:EPrints 3 Plugins]]