From EPrints Documentation
Revision as of 16:17, 17 September 2009 by Tmb (talk | contribs) (cfg/apachevhost.conf)
Jump to: navigation, search

For an overview of MePrints features, see MePrintsFeatures.

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


#!/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/ to your repository database:

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


Apply the patchfile included with MePrints: TODO


MePrints introduces a new dataset containing all users with a public profile. To activate the new dataset:

Find the line:

my $INFO =

and replace with:

our $INFO =

Find the lines:

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

and replace with:

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


Add support for MePrints views:



Add support for MePrints profile URLs (eg.

Find the line:

$r->filename( $repository->get_conf( "htdocs_path" )."/".$lang.$localpath );

Replace it with:

        if( $uri =~ m! ^/profile\/([0-9a-z]+)(.*)$ !x )
                my $session = new EPrints::Session(2);
                my $user = EPrints::DataObj::User::user_with_username( $session, $1 );
                if( defined $user )
                        if( $user->get_value( 'profile_visibility' ) eq "public")
                                $r->filename( $repository->get_conf( "archiveroot" )."/user_profiles/".$user->get_id."/profile/index.html" );
                                return FORBIDDEN;
                $r->filename( $repository->get_conf( "htdocs_path" )."/".$lang.$localpath );

Getting Started

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


To use the MePrints homepage instead instead of the default EPrints page, add the following lines to your cfg/cfg.d/ configuration file:

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


To update the MePrints profile page automatically when a user changes his or her profile information, add the following lines to your cfg/cfg.d/ configuration file:



To activate the MePrints profile pages, add the following lines to your cfg/apachevhost.conf configuration file:

<Directory "/opt/meprints_test/archives/meprints/meprints">
  SetHandler perl-script
  PerlResponseHandler EPrints::Apache::Template::handler


To allow users to choose whether their profile is public or private add the following lines to your cfg/workflows/user/default.xml file:

 <stage name="default">

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

   <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"/>


To replace the default EPrints user citation with the MePrints thumbnail citation:

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 will want to examine both files and merge the MePrints changes into default.xml


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


Log into your repository and should see your MePrints Homepage.

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/ 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:

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/


Change profile information, check profile page gets updated.

MePrints Views


bin/generate_views ARCHIVEID --generate menus

Check - you should see 2 extra views. You may want to link these into your template.

MePrints search

Go to:


MePrints for admins

Hide Profile


  • change phrase "Homepage" to "MePrints Homepage"
  • QuickLinks widget should use render_action_list_bar to display available actions below the user details/picture (links currently have BAD URLs)
  • when an admin searches for a user account, they see their OWN homepage, not the user's (use $processor->{user} not $session->current_user
  • the widget control bar (add/remove/reset) should only be available if $processor->{user} = $session->current_user
  • add "user_section_meprints" phrase -> "MePrints"
  • phrase "Plugin/Screen/User/UploadPicture:upload_success missing
  • cgi/meprints/profile - return() line 9?
  • wrong URL in citations/user/default_with_thumbnail.xml
  • missing phrase "Plugin/Screen/Public/MePrintsSearch:title"
  • searching using cgi/meprints/search gives Internal Server Error