Difference between revisions of "OneShare"

From EPrints Documentation
Jump to: navigation, search
(add category out of date)
 
(37 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
[[Category:EdShare]]
 +
[[Category:Out of Date]]
 
This page provides information on what makes EdShare/Language Box/OneShare different from a standard EPrints installation.
 
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.
 
Add to this page any packages that are relevant to EdShare/LBox.
  
==Data Model==
+
Please see conversations on:
 +
* [[UserFeedback]]: feedback from Debra and Sue
 +
* Bug lists: cf. Mantis http://lslvm-mmr4.ecs.soton.ac.uk/
 +
* [[OneShareWishList]]: discuss there new features which are not mentioned on this page already.
 +
* [[OneSharePreviewTools]]: (TO COME)
 +
* [[OneShareBlackboard]]: (TO COME)
  
Simple metadata schema.
 
  
All eprints are of type 'resource' (also called 'share' on EdShare Soton).
+
==Core==
  
==Worflow==
+
===Data Model (seb)===
  
Improve screens:
+
Tasks
  
# "My Shares"/"My Resources": re-use default EPrints "Items.pm" screen, add features from edshare@soton such as 'selecting share', nicer citations etc.
+
* What is a bare minimum for metadata?
# "Edit" screen
+
* 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.
  
==Preview tools==
+
Also see sections on Collections, Bookmarks.
  
Generating previews for:
 
  
# Microsoft Office formats (+ newer OpenXML standards)
+
Priority: high, core feature!
# HTML pages
+
Time: dev < 1 week, politics < 1 month hopefully
# Multimedia files (video + audio)
+
# <add more>
+
  
Or use a dedicated server for the task?
+
Dev to make decisions
  
==Previews/Coverflow-like interface==
+
===User Xperience===
  
To allow to preview documents & multimedia files on the Summary page.
+
Define a user workflow i.e.:
  
Could be:
+
* How does the user interact with the repository?
 +
* What is their path through the site for creating, managing their resources? Is it consistent?
  
# Flash player
+
On Edshare, this needs loads of improvements :)
# A more simple HTML/JS interface (based on lightbox or else...)
+
# We still need to keep the basic 'list' interface for non-JS clients.
+
  
==MePrints Profiles==
+
Make links to all features (browsing, searching etc) intuitive/easy to find/consistent.
  
Any new Ed/LB/OneShare install should come with the MePrints package installed.
+
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 (seb)===
 +
 
 +
Please view [[OneSharePerms]].
 +
 
 +
====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 all the code COMPLIANT to HTTPS :)
 +
 
 +
===Defaults (seb)===
 +
 
 +
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 (pat+seb)===
 +
 
 +
Local Previews (pat)
 +
 
 +
* Any type of documents (doc, pdf, ppt, html...)
 +
* Any type of multimedia files (video, audio)
 +
 
 +
Remote Previews (seb)
 +
 
 +
* Develop an interface which allows OneShare to delegate the generation of previews to another server. Talk to DaveT, TimBrody.
 +
 
 +
Priority: med-high
 +
Time: 1-2 weeks
 +
 
 +
===Previews/Coverflow-like interface (pat)===
 +
 
 +
This will be a part of another thread.
 +
 
 +
* Decide of a nice "player"?!
 +
 
 +
Priority: super high
 +
Time: ? months?
 +
 
 +
* What about presentations of the links?
  
 
==Social Tools==
 
==Social Tools==
  
Add tools for commenting on resources. Maybe use SNEEP or Pat/Marcus' updated version.
+
===MePrints Profiles===
  
==Collections==
+
* Create a 'screencast' to present the feature
 +
* Unroll MePrints to the live servers (EdShare, LBox)
 +
* Possibly develop widgets for the Learning repos.
  
Add virtual collections to EPrints. A virtual collection contains links to other resources.
+
Priority: medium
 +
Time: <1 week
  
==Bookmarks==
+
===Commenting (SNEEP) (marcus+pat)===
  
A special virtual collection available for every user. Bookmarks are persistent and can be shared to other users.
+
Add tools for commenting resources.
  
AJAX Tools exist to easily populate bookmarks from search results, summary pages etc. (cf EdShare Soton).
+
* Test the new SNEEP (+make sure it works on https)
  
==Folder/Shopping Basket==
+
Priority: low
 +
Time: 1-2 days
  
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.
+
==Collections (marcus)==
  
Emptied when user logs out. Cannot be shared with other users.
+
Add virtual collections to EPrints. A virtual collection contains links to other resources.
  
==Collections Organiser==
+
Priority: low, quite mature code
 +
Time: 1-2 days
  
The AJAX tool to easily create, edit and manage collections.
+
===Bookmarks (marcus)===
  
Must be improved significantly.
+
A special virtual collection available for every user. Bookmarks are persistent and can be shared to other users.
  
==Viewing Permissions==
+
AJAX Tools exist to easily populate bookmarks from search results, summary pages etc. (cf EdShare Soton).
  
Use EdShare Soton's advanced viewing permissions to share with selected users, schools etc.
+
* 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.
  
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.
+
Priority: low, quite mature code
 +
Time: 1-2 days
  
==Editing Permissions (TO DO)==
+
===Folder/Shopping Basket (unassigned)===
  
Cf. Viewing Permissions but for editing.
+
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.
  
Maybe merge viewing + editing perms into a more generic ACL system.
+
Emptied when user logs out. Cannot be shared with other users.
  
==ACLs for Viewing and Editing items==
+
* 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?
  
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".
+
===Collections Organiser (all)===
  
==UI Styling==
+
The AJAX tool to easily create, edit and manage collections.
  
Create a unique, generic style for OneShare. This should be eye-catching but generic enough (cf. a vanilla EPrints install).
+
* 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)?
  
This include: default citations for resources and files, site template, frontpage, <add more>.
+
Priority: need requirements
 +
Time: unknown
  
==Embedding content (TO DO)==
+
==Embedding content (marcus)==
  
 
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).
  
==Improved Manage Deposit/My Shares page==
+
* What do we expect from such a feature? Needs requirements.
  
Use funkier citations, add AJAX tools to easily edit resources (eg. adding tags).
+
Priority: low
 +
Time: <1 week
  
==Enforced HTTPS==
+
==IRStats (unassigned)==
  
Make HTTPS compulsory.
+
Improved integration of IRStats with EPrints/OneShare.
  
==Extra Tools==
+
Stats would be a popular feature?
  
# Anti-Virus Scanning: cf. use of Sophos on the EdShare Soton server.
+
==Extra Tools (as optional packages?)==
# IRStats: improved integration of IRStats with EPrints.
+
 
# Bulk Upload & related features
+
Possible optional packages:
# Tag cloud
+
 
# Presentation of latest additions on the frontpage
+
* Anti-Virus Scanning: cf. use of Sophos on the EdShare Soton server.
# <add more>
+
* 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)==
+
==Blackboard integration (unassigned)==
 +
 
 +
Single-deposit paradigm i.e. dissemination from BB to OneShare.
 +
 
 +
This will be part of a separate conversation.
 +
 
 +
Priority: high
 +
Time: unknown
  
Single-deposit paradigm i.e. dissemination from OneShare to BB.
+
==Packages==
 +
*[[OneShareCollections | Collections]]
 +
*[[OneShareBookmarks | Bookmarks]]

Latest revision as of 05:20, 30 August 2018

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 (seb)

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

Dev to make decisions

User Xperience

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 (seb)

Please view OneSharePerms.

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 all the code COMPLIANT to HTTPS :)

Defaults (seb)

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 (pat+seb)

Local Previews (pat)

  • Any type of documents (doc, pdf, ppt, html...)
  • Any type of multimedia files (video, audio)

Remote Previews (seb)

  • Develop an interface which allows OneShare to delegate the generation of previews to another server. Talk to DaveT, TimBrody.
Priority: med-high
Time: 1-2 weeks

Previews/Coverflow-like interface (pat)

This will be a part of another thread.

  • Decide of a nice "player"?!
Priority: super high
Time: ? months?
  • What about presentations of the links?

Social Tools

MePrints Profiles

  • Create a 'screencast' to present the feature
  • Unroll MePrints to the live servers (EdShare, LBox)
  • Possibly develop widgets for the Learning repos.
Priority: medium
Time: <1 week

Commenting (SNEEP) (marcus+pat)

Add tools for commenting resources.

  • Test the new SNEEP (+make sure it works on https)
Priority: low
Time: 1-2 days

Collections (marcus)

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

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

Bookmarks (marcus)

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 (unassigned)

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 (all)

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 (marcus)

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 (unassigned)

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 (unassigned)

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

This will be part of a separate conversation.

Priority: high
Time: unknown

Packages