Date: Thu, 28 Mar 2024 07:36:07 -0400 (EDT) Message-ID: <541592098.27503.1711625767662@lyrasis1-roc-mp1> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_27502_1170160677.1711625767661" ------=_Part_27502_1170160677.1711625767661 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Project |
DSpace ClientUI built on RESTful API |
Student |
|
Mentors |
|
Technologies |
DSpace REST |
Proposal |
|
Repository |
|
Demo |
|
Presentation |
= |
Notes |
= |
DSpace REST |
Built on the DSpace REST API developed as GSo=
C project in 2009-10 |
FireSpark |
Interface powered by FireSpark - JavaScript S=
ervice Computing Platform - which is an experimental platform currently |
RESTClient Extensions |
Services and Workflows built for RESTClient u=
sing FireSpark for providing core UI functionality while interfacing the
RESTful API |
jQuery Templates |
Client side processing supported by flexible =
templates written in JavaScript thereby enabling easier evolution of the UI=
|
CKEditor |
HTML Rich Text Editor supported for easier te=
xt input during repository manipulation |
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 resourc= es |
|
ui/css/ |
styles and themes directory |
|
ui/css/default.css |
global styles |
|
ui/css/jquery.css |
jquery styles |
|
ui/css/restclient-styles.css |
RESTClient styles unified from dev/ |
|
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/ = td> |
|
ui/js/restclient-templates.js |
RESTClient Templates unified from dev/ |
|
dev/ | top level folder containing developer resourc= es |
|
dev/styles/ |
individual styles directory |
|
dev/templates/ |
individual templatesdirectory |
|
dev/build.bat (build.sh for linux) |
Build script for unification |
|
dev/init.js |
RESTClient initialization |
|
dev/helpers/ |
individual helpers directory |
|
dev/services/ |
individual services directory |
|
dev/workflows/ |
individual workflows directory |
|
Customization |
Support |
Description |
---|---|---|
Stylesheets (CSS) |
Yes |
Individual stylesheets in dev/styles/ control=
the styles for different pages |
Layout | Yes |
Layout is configured in dev/styles/layout.css=
|
Themes | Yes |
Themes are supported natively by jQuery UI Themes may be downloaded from http://jqueryui.com/themeroller= a> |
Internationalization |
No |
Support for i18n is planned to be integrated =
into FireSpark soon using the i18n plugi=
n |
Name | Description |
Options (Parameters passed to service in Fire=
Spark) |
Return Values |
---|---|---|---|
SessionWrite |
Saves session information (email/password) fo=
r use in further requests |
|
None |
ResourceRESTURL |
Generates REST URL from resource information =
|
|
|
SessionRESTURL |
Appends Session information (email/password) =
to URL |
|
|
Name | Description |
Options (Parameters passed to service in Fire= Spark) |
Return Values |
---|---|---|---|
SessionBegin |
Stores login information into session, authen=
ticates and loads account template |
|
None |
SessionEnd |
Deletes session and loads account template |
|
None |
ResourceLoad |
Loads resource using GET and applies template=
into selected element |
|
None |
ResourceEdit |
Edits resource fields using PUT |
|
None |
ResourceDelete |
Deletes resource fields using DELETE |
|
None |
Name | Description |
Arguments |
Return Value |
---|---|---|---|
getDate |
Returns timestamp as properly formatted date =
string |
time : number : Timestamp |
date : string : Formatted Date |
readFileSize |
Returns size in bytes as properly formatted s=
tring |
size : number : Size in bytes |
size : string : Formatted Size |
Option | Description |
Default Value |
---|---|---|
RESTClient.urls |
URLs to be used |
{ |
RESTClient.jquery.constant.loadmsg |
HTML content to show while loading content |
'<p class=3D"loading">Loading ...</p=
>' |
RESTClient.jquery.constant.successimg |
HTML content to indicate successful execution=
|
'<img src=3D"ui/img/icons/ok.gif">' |
RESTClient.jquery.constant.errorimg |
HTML content to indicate erroneous execution =
|
'<img src=3D"ui/img/icons/error.gif">' =
|
Name | Available |
Description |
---|---|---|
FireSpark |
No |
Partially available in the heavily commented =
source code |
jQuery Templates |
Yes |
Available as jQuery plugin API documentation =
|
:tick: |
Ready |
:plus: |
Base done, Improvement phase |
:thumbs-up: |
In Progress |
Mark: I would like to see a bit more dialog with Bojan concerning the RE= ST API contracts and migration to Spring, mainly, are we happy with these A= PI contracts and using them for the students project, or do we need to cons= ider some possible changes int he API to adopt to using Spring REST instead= of Entity Broker. And if so, is there a timeline for providing those chang= es in scope of the 1.8 release?
Vibhaj: Confirmed that the possible migration shall not affect the REST = interface and hence RestClient project.