Versions Compared

Old Version 71

changes.mady.by.user Vibhaj Rajan

Saved on

compared with

New Version 72

changes.mady.by.user Vibhaj Rajan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

DSpace REST

Built on the DSpace REST API developed as GSoC project in 2009-10
https://wiki.duraspace.org/display/DSPACE/REST+API

FireSpark

Interface powered by FireSpark - JavaScript Service Computing Platform - which is an experimental platform currently
under my research.
https://github.com/tr4n2uil/firespark

RESTClient Extensions

Services and Workflows built for RESTClient using FireSpark for providing core UI functionality while interfacing the
RESTful API
https://github.com/tr4n2uil/restclient

jQuery Templates

Client side processing supported by flexible templates written in JavaScript thereby enabling easier evolution of the UI
http://api.jquery.com/category/plugins/templates/

CKEditor

HTML Rich Text Editor supported for easier text input during repository manipulation
http://ckeditor.com/

User Documentation

...

Source Structure

File / Directory / Subdirectory

Description

Files

index.html

initialization page for loading all necessary client scripts + basic document layout

 

README

 

 

ui/

top level folder containing interface resources

 

ui/css/

styles and themes directory

...


default theme is redmond

...


other themes provided are smoothness and ui-lightness

...


more themes may be downloaded from http://jqueryui.com/themeroller/

...

 

ui/css/default.css

...

global styles

...

 

ui/css/jquery.css

...

jquery styles

...

 

ui/css/restclient-styles.css

...

RESTClient styles unified from dev/

...


see dev/ structure description for information on unification during build

...

 

ui/img/

images directory

 

ui/js/

scripts directory

 

ui/js/jquery-1.6.1.min.js

...

jQuery

...


 

ui/js/jquery-ui-1.8.13.min.js

...

jQuery UI

...


 

ui/js/jquery.tmpl.min.js

...

jQuery Templates

...


 

ui/js/jquery-firespark.js

...

jQuery FireSpark

...


 

ui/js/ckeditor

...

CKEditor directory

...


 

ui/js/restclient-jquery.js

...

RESTClient Extensions unified from dev/

...

 

ui/js/restclient-templates.js

...

RESTClient Templates unified from dev/

...

 

dev/

top level folder containing developer resources

 

dev/styles/

individual styles directory

...


files will be unified to ui/css/restclient-styles.css during build

...

...

  • home.css

...

  • layout.css

...

  • all-communities.css

...

  • all-collections.css

...

  • all-items.css

...

  • all-users.css

...

  • all-groups.css

...

  • all-stats.css

...

  • community.css

...

  • collection.css

...

  • item.css

...

  • user.css

dev/templates/

individual

...

templatesdirectory
files will be unified to ui/js/restclient-templates.js during build

...

...

  • Account.js

...

  • Browse.js

...

  • Login.js

...

  • AllCommunities.js

...

  • AllCollections.js

...

  • AllItems.js

...

  • AllUsers.js

...

  • AllGroups.js

...

  • AllStats.js

...

  • Community.js

...

  • Collection.js

...

  • Item.js

...

  • User.js

...

  • Group.js

...

  • CommunityEdit.js

...

  • CollectionEdit.js

...

  • CommunityDelete.js

dev/build.bat (build.sh for linux)

Build script for unification

...


Unification is the merging of individual files to single file for client use

...

 

dev/init.js

RESTClient initialization

...


It will be unified to ui/js/restclient-jquery.js during build

...

 

dev/helpers/

individual helpers directory

...


files will be unified to ui/js/restclient-jquery.js during build

...

...

  • GetDate.js

...

  • ReadFileSize.js

dev/services/

individual services directory

...


files will be unified to ui/js/restclient-jquery.js during build

...

...

  • Resource.RESTURL.service.js

...

  • Session.RESTURL.service.js

...

  • Session.Write.service.js

dev/workflows/

individual

...

workflows directory
files will be unified to ui/js/restclient-jquery.js during build

...

...

  • Session.Begin.workflow.js

...

  • Session.End.workflow.js

...

  • Resource.Load.workflow.js

...

  • Resource.Edit.workflow.js

...

  • Resource.Delete.workflow.js

Customizations

Customization

Support

Description

Stylesheets (CSS)

Yes

Individual stylesheets in dev/styles/ control the styles for different pages
Additionally, ui/css/default.css is the global style sheet
(Note : Individual stylesheets override global styles)

Layout

Yes

Layout is configured in dev/styles/layout.css
Currently jQuery UI Tabpanel (which is the container supported in FireSpark) is used for viewing different
pages as it provides faster navigation (without breadcrumbs) although simple layout is also possible.
(Containers may be developed/changed easily though it shall require understanding of FireSpark whose documentation will be
completed by the end of the 2011)
Other UI containers are under development in FireSpark.

Themes

Yes

Themes are supported natively by jQuery UI
Themes may be downloaded from http://jqueryui.com/themeroller

Internationalization

No

Support for i18n is planned to be integrated into FireSpark soon using the i18n plugin
This will allow easy internationalization for RESTClient

...

  1. Enhancing the look and feel
  2. Look into and improve scope for customizations
  3. Improve the architecture of RESTClient and FireSpark
  4. Testing
  5. Complete Documentation
  6. Final Improvements

individual templates directory (will be unified to ui/js/restclient-templates.js during build)