Difference between revisions of "OneShare"

From EPrints Documentation
Jump to: navigation, search
Line 4: Line 4:
  
 
Please see conversations on:
 
Please see conversations on:
# Bug lists: cf. Mantis http://lslvm-mmr4.ecs.soton.ac.uk/
+
* Bug lists: cf. Mantis http://lslvm-mmr4.ecs.soton.ac.uk/
# [[OneShareWishList]]: discuss there new features which are not mentioned on this page already.
+
* [[OneShareWishList]]: discuss there new features which are not mentioned on this page already.
# [[OneSharePreviewTools]]: (TO COME)
+
* [[OneSharePreviewTools]]: (TO COME)
# [[OneShareBlackboard]]: (TO COME)
+
* [[OneShareBlackboard]]: (TO COME)
  
  
Line 16: Line 16:
 
Tasks
 
Tasks
  
# What is a bare minimum for metadata?
+
* What is a bare minimum for metadata?
# What do we do with Uni divisions/hierarchy? Part of extended schema? Part of core-data?
+
* What do we do with Uni divisions/hierarchy? Part of extended schema? Part of core-data?
# What do we do with the security model eg viewing/editing permissions? see below.
+
* What do we do with the security model eg viewing/editing permissions? see below.
# Do we include or provide different subjects hierarchies (eg JACS...)? As an optional feature?
+
* Do we include or provide different subjects hierarchies (eg JACS...)? As an optional feature?
# What is the name of a 'resource'? A 'Resource' or a 'Share'?  
+
* What is the name of a 'resource'? A 'Resource' or a 'Share'?  
# What are the basic data types?? On EdShare we have shares, collections, bookmarks, shoppbasket. On LBox we have resources, "resource_collection" -> need to harmonize.
+
* What are the basic data types?? On EdShare we have shares, collections, bookmarks, shoppbasket. On LBox we have resources, "resource_collection" -> need to harmonize.
  
 
  Also see sections on Collections, Bookmarks.
 
  Also see sections on Collections, Bookmarks.
Line 33: Line 33:
 
Define a user workflow i.e.:
 
Define a user workflow i.e.:
  
# How does the user interact with the repository?  
+
* How does the user interact with the repository?  
# What is their path through the site for creating, managing their resources? Is it consistent?
+
* What is their path through the site for creating, managing their resources? Is it consistent?
  
 
On Edshare, this needs loads of improvements :)
 
On Edshare, this needs loads of improvements :)
Line 49: Line 49:
 
This include: default citations for resources and files, site template, frontpage, <add more>.
 
This include: default citations for resources and files, site template, frontpage, <add more>.
  
# Also we could package the LBox & EdShare styles as optional themes?
+
* Also we could package the LBox & EdShare styles as optional themes?
  
 
  Priority: low
 
  Priority: low
Line 72: Line 72:
 
We could create a system of ACL (Access Control List) for each share/resource and add the appropriate hooks in the code:"can_user_edit", "can_user_view".
 
We could create a system of ACL (Access Control List) for each share/resource and add the appropriate hooks in the code:"can_user_edit", "can_user_view".
  
# The idea on EdShare Soton is good (share with school, uni, x/y) but need refactoring/rewriting.
+
* The idea on EdShare Soton is good (share with school, uni, x/y) but need refactoring/rewriting.
# How do we generalise this to EPrints and add the right hooks to the existing eprints code? Maybe ask TimB for advice.
+
* How do we generalise this to EPrints and add the right hooks to the existing eprints code? Maybe ask TimB for advice.
  
 
  Priority: low
 
  Priority: low
Line 80: Line 80:
 
====HTTPS====
 
====HTTPS====
  
# Make HTTPS compulsory? At least, make all the code COMPLIANT to HTTPS :)
+
* Make HTTPS compulsory? At least, make all the code COMPLIANT to HTTPS :)
  
 
===Defaults===
 
===Defaults===
Line 87: Line 87:
  
 
Concerns:
 
Concerns:
# Views: browse by uni hierarchy? by tag? by course code? (+meprints views)
+
* Views: browse by uni hierarchy? by tag? by course code? (+meprints views)
# Searches: search our metadata fields
+
* Searches: search our metadata fields
# Documents namedsets: add multimedia mime types to EPrints
+
* Documents namedsets: add multimedia mime types to EPrints
# EPrints type: let's remove all the default types (article, book...)?
+
* EPrints type: let's remove all the default types (article, book...)?
# EPrints fields: let's remove all the default -unused- eprint fields? Maybe be careful of hard-coded fields in the code.
+
* EPrints fields: let's remove all the default -unused- eprint fields? Maybe be careful of hard-coded fields in the code.
# EPrint Worflow
+
* EPrint Worflow
# User Workflow
+
* User Workflow
# LDAP: most Uni will have a LDAP server
+
* LDAP: most Uni will have a LDAP server
# User roles
+
* User roles
 +
* more?
  
 
===EdShare's links===
 
===EdShare's links===
Line 101: Line 102:
 
EdShare Soton allows users to share files -or- links and even caches the shared links.
 
EdShare Soton allows users to share files -or- links and even caches the shared links.
  
# What do we do with this feature? Is this a customised EdShareSoton feature?
+
* What do we do with this feature? Is this a customised EdShareSoton feature?
  
 
==Preview==
 
==Preview==
Line 108: Line 109:
  
 
Generating previews for:
 
Generating previews for:
# Microsoft Office formats (+ newer OpenXML standards)
+
* Microsoft Office formats (+ newer OpenXML standards)
# HTML pages
+
* HTML pages
# Multimedia files (video + audio)
+
* Multimedia files (video + audio)
  
 
Or use a dedicated server for the task?
 
Or use a dedicated server for the task?
  
# Where do we store the previews on the filesystem? In the thumbnails dir? etc... Backport the EP3.2 model?
+
* Where do we store the previews on the filesystem? In the thumbnails dir? etc... Backport the EP3.2 model?
# Do we need to re-factor Pat's work on queuing (for audio/video)?
+
* Do we need to re-factor Pat's work on queuing (for audio/video)?
  
 
If local:
 
If local:
Line 126: Line 127:
 
This will be a part of another thread.
 
This will be a part of another thread.
  
# Decide of a nice "player"?!
+
* Decide of a nice "player"?!
  
 
  Priority: super high
 
  Priority: super high
Line 135: Line 136:
 
===MePrints Profiles===
 
===MePrints Profiles===
  
# Should we force OneShare to use MePrints?
+
* Should we force OneShare to use MePrints?
# Should we developed widgets specific to OneShare (would be nice)? Such as stats, comments, feeds...
+
* Should we developed widgets specific to OneShare (would be nice)? Such as stats, comments, feeds...
  
 
  Priority: N/A (project delivered)
 
  Priority: N/A (project delivered)
Line 143: Line 144:
 
===Commenting (SNEEP)===
 
===Commenting (SNEEP)===
  
Add tools for commenting on resources. Maybe use SNEEP or Pat/Marcus' updated version. Test on HTTPS :)
+
Add tools for commenting resources.
  
# Decide!
+
* Test/Use Pat/Marcus/Oli' SNEEP?
  
 
  Priority: low
 
  Priority: low
Line 163: Line 164:
 
AJAX Tools exist to easily populate bookmarks from search results, summary pages etc. (cf EdShare Soton).
 
AJAX Tools exist to easily populate bookmarks from search results, summary pages etc. (cf EdShare Soton).
  
# Using a separate dataobj for bookmarks? This would allow more powerful features eg. "who has bookmarks share X"? Also, this would hide My Bookmarks from my list of resources.
+
* Using a separate dataobj for bookmarks? This would allow more powerful features eg. "who has bookmarks share X"? Also, this would hide My Bookmarks from my list of resources.
  
 
  Priority: low, quite mature code
 
  Priority: low, quite mature code
Line 174: Line 175:
 
Emptied when user logs out. Cannot be shared with other users.
 
Emptied when user logs out. Cannot be shared with other users.
  
# Using a separate dataobj for bookmarks? This would allow more powerful features eg. "who has bookmarks share X"? Also, this would hide My Bookmarks from my list of resources.
+
* Using a separate dataobj for bookmarks? This would allow more powerful features eg. "who has bookmarks share X"? Also, this would hide My Bookmarks from my list of resources.
# Do we need this?
+
* Do we need this?
  
 
===Collections Organiser===
 
===Collections Organiser===
Line 181: Line 182:
 
The AJAX tool to easily create, edit and manage collections.
 
The AJAX tool to easily create, edit and manage collections.
  
# Need storyboards from the management layer!
+
* Need storyboards!
# We know that we need a special tool to manage resources/collections but is this the appropriate one?
+
* We know that we need a special tool to manage resources/collections but is this the appropriate one?
# Could this replace the 'Manage Deposit' screen altogether (whether collections are enabled or not)?
+
* Could this replace the 'Manage Deposit' screen altogether (whether collections are enabled or not)?
  
 
  Priority: need requirements
 
  Priority: need requirements
Line 192: Line 193:
 
To allow embeddable objects that present a resource (maybe looking like the coverflow tool).
 
To allow embeddable objects that present a resource (maybe looking like the coverflow tool).
  
# What do we expect from such a feature? Needs requirements.
+
* What do we expect from such a feature? Needs requirements.
  
 
  Priority: low
 
  Priority: low
Line 207: Line 208:
 
Possible optional packages:
 
Possible optional packages:
  
# Anti-Virus Scanning: cf. use of Sophos on the EdShare Soton server.
+
* Anti-Virus Scanning: cf. use of Sophos on the EdShare Soton server.
# Bulk Upload & related features
+
* Bulk Upload & related features
# Tag cloud
+
* Tag cloud
# Presentation of latest additions on the frontpage
+
* Presentation of latest additions on the frontpage
# LBox's remixed resources (cf. cloning on EP).
+
* LBox's remixed resources (cf. cloning on EP).
# <add more>
+
* <add more>
 
   
 
   
 
==Blackboard integration (TO DO)==
 
==Blackboard integration (TO DO)==

Revision as of 18:43, 20 October 2009

This page provides information on what makes EdShare/Language Box/OneShare different from a standard EPrints installation.

Add to this page any packages that are relevant to EdShare/LBox.

Please see conversations on:


Core

Data Model

Tasks

  • What is a bare minimum for metadata?
  • What do we do with Uni divisions/hierarchy? Part of extended schema? Part of core-data?
  • What do we do with the security model eg viewing/editing permissions? see below.
  • Do we include or provide different subjects hierarchies (eg JACS...)? As an optional feature?
  • What is the name of a 'resource'? A 'Resource' or a 'Share'?
  • What are the basic data types?? On EdShare we have shares, collections, bookmarks, shoppbasket. On LBox we have resources, "resource_collection" -> need to harmonize.
Also see sections on Collections, Bookmarks.


Priority: high, core feature!
Time: dev < 1 week, politics < 1 month hopefully

(User) Worflow

Define a user workflow i.e.:

  • How does the user interact with the repository?
  • What is their path through the site for creating, managing their resources? Is it consistent?

On Edshare, this needs loads of improvements :)

Make links to all features (browsing, searching etc) intuitive/easy to find/consistent.

Priority: low
Time: 1-2 dev, 1 week politics

UI Styling

Create a unique, generic style for OneShare. This should be eye-catching but generic/neutral enough (cf. a vanilla EPrints install).

This include: default citations for resources and files, site template, frontpage, <add more>.

  • Also we could package the LBox & EdShare styles as optional themes?
Priority: low
Time: unknown?

Security

Viewing Permissions

Use EdShare Soton's advanced viewing permissions to share with selected users, schools etc.

Previews are also included into that model i.e. you cannot see previews for a resource if you're not allowed to view/download the resource.

Editing Permissions

Cf. Viewing Permissions but for editing.

Maybe merge viewing + editing perms into a more generic ACL system.

ACLs for Viewing and Editing items?

We could create a system of ACL (Access Control List) for each share/resource and add the appropriate hooks in the code:"can_user_edit", "can_user_view".

  • The idea on EdShare Soton is good (share with school, uni, x/y) but need refactoring/rewriting.
  • How do we generalise this to EPrints and add the right hooks to the existing eprints code? Maybe ask TimB for advice.
Priority: low
Time: 3-4 days to refactor/generalise

HTTPS

  • Make HTTPS compulsory? At least, make all the code COMPLIANT to HTTPS :)

Defaults

We need to have default browse views, searches etc. which reflects our metadata schema and interests.

Concerns:

  • Views: browse by uni hierarchy? by tag? by course code? (+meprints views)
  • Searches: search our metadata fields
  • Documents namedsets: add multimedia mime types to EPrints
  • EPrints type: let's remove all the default types (article, book...)?
  • EPrints fields: let's remove all the default -unused- eprint fields? Maybe be careful of hard-coded fields in the code.
  • EPrint Worflow
  • User Workflow
  • LDAP: most Uni will have a LDAP server
  • User roles
  • more?

EdShare's links

EdShare Soton allows users to share files -or- links and even caches the shared links.

  • What do we do with this feature? Is this a customised EdShareSoton feature?

Preview

Generating previews

Generating previews for:

  • Microsoft Office formats (+ newer OpenXML standards)
  • HTML pages
  • Multimedia files (video + audio)

Or use a dedicated server for the task?

  • Where do we store the previews on the filesystem? In the thumbnails dir? etc... Backport the EP3.2 model?
  • Do we need to re-factor Pat's work on queuing (for audio/video)?

If local:

Priority: med-high
Time: < 1 week

Previews/Coverflow-like interface

This will be a part of another thread.

  • Decide of a nice "player"?!
Priority: super high
Time: ? months?

Social Tools

MePrints Profiles

  • Should we force OneShare to use MePrints?
  • Should we developed widgets specific to OneShare (would be nice)? Such as stats, comments, feeds...
Priority: N/A (project delivered)
Time: 0

Commenting (SNEEP)

Add tools for commenting resources.

  • Test/Use Pat/Marcus/Oli' SNEEP?
Priority: low
Time: 1-2 days

Collections

Add virtual collections to EPrints. A virtual collection contains links to other resources.

Priority: low, quite mature code
Time: 1-2 days

Bookmarks

A special virtual collection available for every user. Bookmarks are persistent and can be shared to other users.

AJAX Tools exist to easily populate bookmarks from search results, summary pages etc. (cf EdShare Soton).

  • Using a separate dataobj for bookmarks? This would allow more powerful features eg. "who has bookmarks share X"? Also, this would hide My Bookmarks from my list of resources.
Priority: low, quite mature code
Time: 1-2 days

Folder/Shopping Basket

A special virtual collection that allows people to aggregate shares during their current session. This allows easy creation of collections or download of several resources in one go.

Emptied when user logs out. Cannot be shared with other users.

  • Using a separate dataobj for bookmarks? This would allow more powerful features eg. "who has bookmarks share X"? Also, this would hide My Bookmarks from my list of resources.
  • Do we need this?

Collections Organiser

The AJAX tool to easily create, edit and manage collections.

  • Need storyboards!
  • We know that we need a special tool to manage resources/collections but is this the appropriate one?
  • Could this replace the 'Manage Deposit' screen altogether (whether collections are enabled or not)?
Priority: need requirements
Time: unknown

Embedding content (TO DO)

To allow embeddable objects that present a resource (maybe looking like the coverflow tool).

  • What do we expect from such a feature? Needs requirements.
Priority: low
Time: <1 week

IRStats

Improved integration of IRStats with EPrints/OneShare.

Stats would be a popular feature?

Extra Tools (as optional packages?)

Possible optional packages:

  • Anti-Virus Scanning: cf. use of Sophos on the EdShare Soton server.
  • Bulk Upload & related features
  • Tag cloud
  • Presentation of latest additions on the frontpage
  • LBox's remixed resources (cf. cloning on EP).
  • <add more>

Blackboard integration (TO DO)

Single-deposit paradigm i.e. dissemination from BB to OneShare.

This will be part of a separate conversation.

Priority: high
Time: unknown