Difference between revisions of "MePrints"

From EPrints Documentation
Jump to: navigation, search
Line 1: Line 1:
 
For instructions on how to install MePrints, see [[MePrintsInstall]].
 
For instructions on how to install MePrints, see [[MePrintsInstall]].
  
==Introduction==
+
=Introduction=
MePrints is a plugin for EPrints 3.1+ that extends the user aspect of EPrints with user profiles and home pages. Profile pages are similar to existing EPrint abstract pages, they are public-facing page providing, admin-customisable, information ''about'' the user. Home pages replace the current EPrints "Profile" page and provide, user-customisable, information about the repository so that the user can get a quick overview of all the information in the repository that is relevant to them.
+
MePrints is a plugin for EPrints 3.1+ that extends the user aspect of EPrints with user profiles and homepages. Profile pages are similar to existing EPrint abstract pages, they are public-facing page providing, admin-customisable, information ''about'' the user. Homepages replace the current EPrints "Profile" page and provide, user-customisable, information about the repository so that the user can get a quick overview of all the information in the repository 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.
 
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==
+
=Features=
MePrints brings a number of additional features to EPrints.
+
MePrints brings a number of additional features to EPrints to improve the user experience.
  
===Additional User Metadata===
+
==Additional User Metadata==
 
A few extra default user data fields including;
 
A few extra default user data fields including;
 
* Biography - A small bit of information which is supplied by the user.
 
* Biography - A small bit of information which is supplied by the user.
Line 16: Line 16:
 
* Divisions - This uses the same hierarchy as eprint.divisions, the idea of this is to keep department/organisation for external users but divisions for internal users.
 
* Divisions - This uses the same hierarchy as eprint.divisions, the idea of this is to keep department/organisation for external users but divisions for internal users.
  
===Public User Search===
+
==Public User Profile Pages==
There is a new user search provided by MePrints, cgi/search_users, which allows you to search through users in the EPrints repository. This functionality is provided by a new plugin module EPrints::Plugin::Screen::Public::UserSearch. A user can remove themselves from the search results if they wish to by marking themselves as hidden.
+
Public user profile pages are similar to EPrints abstracts and provide a public static view of a user in the repository. The information that is displayed on these pages is configurable by the repository administrator. If a user does not want their profile page to be accessible to the outside world then they can set their 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 the user to easily share their EPrints profile with other people. This is achieved without making any changes to the core EPrints code.
  
===Public User Browsing===
+
==Internal User Homepage==
 +
This replaces the initial "Manage Deposits" view that a user sees 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 the repository user. A repository administrator can create [[#Widgets|widgets]], which are a special type of plugin that provide information from the repository that is relevant to the user. Also the administrator can create different layouts for the homepage so that [[#Widgets|widgets]] on the page will be laid out in different ways. The user can customise their homepage by changing the positions of the widgets and adding or removing other [[#Widgets|widgets]].
  
 +
==Widgets==
 +
Widgets are small specialised plugins that can be easily added to MePrints if a repository administrator wants to make any additional functionality available on the homepage.
  
 +
Widgets available with the a default install of MePrints include;
 +
* User Details - This shows the username, biography, expertise and other core data fields.
 +
* User Picture - This allows the user to upload an image of themselves for their profile.
 +
* User Actions - This widget adds a box containing all of the possible user actions.
 +
* Recently Published Items - This widget shows items that the user has recently published in the repository.
 +
* Item Issues - This widget shows any issues with items, owned by the user, that have been discovered by an issues audit.
 +
* Quick Upload -  This widget 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.
  
4) Public user profile pages
+
==Public User Search==
 
+
There is a new user search provided by MePrints, cgi/search_users, which allows you to search through users in the EPrints repository. This functionality is provided by a new plugin module EPrints::Plugin::Screen::Public::UserSearch. A user can remove themselves from the search results if they wish to by marking themselves as hidden.
New bin/generate_userprofiles script, generate_static() added to DataObj::User.
+
 
+
Repository admin can define which content (see Widgets - below) is displayed on the profile page - same for all user for consistency.
+
 
+
http://allaboutme.eprints.org/profile/mmr
+
http://allaboutme.eprints.org/profile/seb
+
 
+
Note change to Apache::Rewrite to allow nice profile URLs
+
 
+
5) Internal user homepage
+
 
+
Replaces Screen::User::View.
+
 
+
This screen lays out a number of content "widgets" (currently simple 2 column layout).
+
 
+
Users will see a list of available widgets and add them to their homepage (like items_fields and review_fields, there will be a user metadata field for storing the user's layout preferences). Users will also be able to move the widgets around on the screen and remove widgets.
+
 
+
6) Profile content "widgets"
+
 
+
Stored in EPrints/Plugin/Widget/
+
 
+
Currently widgets just have a render_content method and get rendered using a Box-like surround.
+
 
+
Current widgets include:
+
 
+
* User details **
+
* Available user actions **
+
* User picture
+
* Latest Items in archive
+
* Issues with items owned by this user
+
* Quick Upload (creates new record in inbox)
+
* Most popular items (queries access dataset)
+
 
+
Planned widgets include:
+
 
+
* Latest comments (SNEEP integration)
+
* IRStats mini-dashboard
+
* Latest activity eg. recently edited items, rejected items
+
* .. suggestions?
+
  
** these 2 widgets constitute the minimal information display of the current EPrints. We plan that these will always appear in a fixed position (alongside the user photo) on the Homepage and not be removable.
+
==Public User Browsing==
 +
A new browse view has been added with MePrints that allows you to browse users by expertise.
  
 
=Installation=
 
=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]].

Revision as of 11:05, 22 September 2009

For 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 similar to existing EPrint abstract pages, they are public-facing page providing, admin-customisable, information about the user. Homepages replace the current EPrints "Profile" page and provide, user-customisable, information about the repository so that the user can get a quick overview of all the information in the repository 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 the user experience.

Additional User Metadata

A few extra default user data fields including;

  • Biography - A small bit of information which is supplied by the user.
  • Expertise - A list of keywords describing the user's areas of expertise.
  • Qualifications
  • Divisions - This uses the same hierarchy as eprint.divisions, the idea of this is to keep department/organisation for external users but divisions for internal users.

Public User Profile Pages

Public user profile pages are similar to EPrints abstracts and provide a public static view of a user in the repository. The information that is displayed on these pages is configurable by the repository administrator. If a user does not want their profile page to be accessible to the outside world then they can set their 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 http://repository.org/profile/username. This allows the user to easily share their EPrints profile with other people. This is achieved without making any changes to the core EPrints code.

Internal User Homepage

This replaces the initial "Manage Deposits" view that a user sees 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 the repository user. A repository administrator can create widgets, which are a special type of plugin that provide information from the repository that is relevant to the user. Also the administrator can create different layouts for the homepage so that widgets on the page will be laid out in different ways. The user can customise their homepage by changing the positions of the widgets and adding or removing other widgets.

Widgets

Widgets are small specialised plugins that can be easily added to MePrints if a repository administrator wants to make any additional functionality available on the homepage.

Widgets available with the a default install of MePrints include;

  • User Details - This shows the username, biography, expertise and other core data fields.
  • User Picture - This allows the user to upload an image of themselves for their profile.
  • User Actions - This widget adds a box containing all of the possible user actions.
  • Recently Published Items - This widget shows items that the user has recently published in the repository.
  • Item Issues - This widget shows any issues with items, owned by the user, that have been discovered by an issues audit.
  • Quick Upload - This widget 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.

Public User Search

There is a new user search provided by MePrints, cgi/search_users, which allows you to search through users in the EPrints repository. This functionality is provided by a new plugin module EPrints::Plugin::Screen::Public::UserSearch. A user can remove themselves from the search results if they wish to by marking themselves as hidden.

Public User Browsing

A new browse view has been added with MePrints that allows you to browse users by expertise.

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.