| Note | ||
|---|---|---|
| ||
This is the page describing GSoC 2010 project ended officially in August 2010. The REST API project is continued after official GSoC date. The new address of wiki page is located at https://wiki.duraspace.org/display/DSPACE/REST+API. Please bookmark this page as all further development will be described there. Current GSoC page stays here for historical/documentation purposes. |
DSpace REST API - Bojan Suzic
| Excerpt |
|---|
Integration, testing, documentation and further development of DSpace REST services for 1.x and 2.0 versions. - Bojan Suzic |
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Details
Project Title: | DSpace REST API |
Student: | Bojan Suzic, |
DSpace REST API - Bojan Suzic
| Excerpt |
|---|
Integration, testing, documentation and further development of DSpace REST services for 1.x and 2.0 versions. - Bojan Suzic |
| Info | ||
|---|---|---|
| ||
This page is not completed. The work on specifications is ongoing. Everyone is welcome to comment or contribute! |
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Details
Project Title: | DSpace REST API |
Student: | Bojan Suzic, University of Technology Graz |
Mentors: | Aaron Zeckoski, Mark Diggory |
Contacting author: | bojan AT student . tugraz DOT at .suzic AT gmail _DOT _com - using subject line DSpace |
SCM Location for Project: |
...
In the following sections main activities are elaborated in detail.
REST API
...
Changes in comparison to existing support are marked with red color. Please note that changes may appear as:
...
Endpoints
In the following section listed are supported endpoints on the application level. The items marked with dot (in C column) are in phase of implementation, while other items are considered already working.
Please note that additional tests should be made in order to ensure proper stability of the whole application.
The sorting of the fields / output results is currently partially supported. This part of the application is implemented independently of the endpoints and will be worked on after the most of endpoints are completed.
...
| Note | ||
|---|---|---|
| ||
DSpace 1.x and 2.x are treating the resources on different way. 2.x is more generalized, suggesting the use of RDF-like interrelation notations. |
Repository browsing
Earlier Implementation Description - GSoC09
...
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| | | Returns a list of all communities on the system or return just top level communities. | - | | | The list of communities containing DSPACE:respective fields . | | |||||||||||||||||||
| | | Return detailed information about | | | - | DSPACE:Fields describing community. | | |||||||||||||||||||
• | | | Return information about | | | - |
element): id - entity identifier, internal to the system name - entity name countItems - number of items under community handle - handle of the community (unique persistent resource identifier) id - entity identifier, internal to the system name - entity name type - entity entity type (object type in the system) collections - collections collections contained in the community, ordered by id ancestors - ancestors canedit - states user persmission on the community (editing) anchestor - anchestors of the community , ordered by id children - subcommunities, ordered by id admins administrators - group administrators, ordered by id metadata recent - community metadata administrators - default group of administrators recent items in the community shortDescription - short description copyrightText - copyright text sidebarText - sidebar text introductoryText - introductory text | | Respective field info | | |||||||||||||||||
• | |
| Return a list of all ancestor communities of the | | - | - | Contains community logo (bitstream) | | |||||||||||||||||||
| | | Return a list of all collections in the system. | - | The list of the collections containing DSPACE:respective fields. | | |||||||||||||||||||||
| | | Return detailed information about | | DSPACE:Fields of the collection entity. | | |||||||||||||||||||||
| | | Return a particular data field found in the collection
element): | | • | | | Returns a list of immediate sub-communities (children) of the | | | | | | Respective field info | | ||||||||||||
• | | | Return a list of collections the items in the | - | - | The list of the items containing DSPACE:related fields . |
|
| |||||||||||||||||||
| | | Return detailed information about an item. | | - | | DSPACE:Fields of the item entity. | | | 200, 204, 400, 500 | |||||||||||||||||
• | | | Return a list of recent submissions to a community. | | particular data field fould in the item
element): metadata - item metadata submitter - submitter group id - entity (item) identifier, internal to the system handle - handle of the item isArchived - archival status of the item isWithdrawn - withdrawal status of states if the item is withdrawn owningCollection - owning collection of the item lastModified - timestamp of last modification modified time metadata collections - collections the item metadata appears in name communities - communities the item appears is namesubmitter - submiter entity type - entity type (object type in the system, item in this case) - name of the item bitstreams - bitstreams related to the item handle - item handle (unique identified) bundles - bundles related to canedit - states can user edit the item collections id - collections related item appear in id communities - communities related item appear in Response details: 204 - if there are no recently submitted items type - element type bundles - bundles related to the item | | - | - | Respective field info | | 200, 204, 400, 500 | ||||||||||||||||
• | | | Return a community logo bitstream object - usually the library item file. | | - | - | Contains community logo (bitstream) | DSPACE:Fields of the bitstream entity. | | 200, 400, 401, 403, 404, 500 | |||||||||||||||||
• | | | Return a list of all collections in the systemparticular data field found in bitstream | - | Contains item count, identifiers, name and handle of collections, or 204 if | | |||||||||||||||||||||
• | | | Return information about | | | | |||||||||||||||||||||
Supported fields (for element): mimeType - mime type of file bundles - bundles the bitstream is a part of checkSum - checksum of the file checkSumAlgorithm - checksum algorithm used description - bitstream description formatDescription - file format description sequenceId - sequence id of the file size - size of the file source - source (typically filename with path information) storeNumber - asset store number where the bitstream is stored userFormatDescription - user's format description name - bitstream name handle - unique id of the bitstream id - internal id of the bitstream type - type of the entity (referring to bitstream) | | - | - | Respective field info | | 200, 400, 401, 403, 404, 500 | |||||||||||||||||||||
| | | Return bitstream | | - | - | Return bitstream | | 200, 400, 401, 403, 404, 500 | ||||||||||||||||||
| | | Return a list of the groups in the system | - | - | - | The list of the groups containing related DSPACE:fields . | | 200, 204, 400, 500 | ||||||||||||||||||
| | | Return a group object | | - | - | DSPACE:Fields of the group entity. | | • | | | Return a list of all ancestor communities a collection with | | | | 200, 204, 400, 500 | |||||||||||
• | | | Returns a list of all items from the collection Return a particular data field found in the group entity
Supported fields (for element): handle - unique id (external) id - internal id of the gruop isEmpty - is the group empty members - group members (as users) memberGroups - group members (as groups) name - group name type - entity type (referring to group) | | - | - | Respective field info | | 200, 204, 400, 500 | ||||||||||||||||||
| | | Return a list of the users in the system | - | - | - | The list of the users containing related DSPACE:fields . | | | | 200,204,400,500 | ||||||||||||||||
• | | | Return a collection logo user info | | - | - | Contains collection logo (bitstream) | |
Note: modifier idOnly is referred only to first layer of the results. For all other layers (e.g. nested results) only ids are returned in some cases, due to possible loops. Example: for community containing collections, on second level the response contains only ids for some elements where multiple loops may be created (community->has_collection->has_community....). Other data is modified according to idOnly flag.
Optional parameters
...
Parameter
...
Description
DSPACE:Fields of the user entity. | | 200,204,400,500 | |||||||||||||
| | | Return a particular data field found in the user
Supported fields (for element): email - user's email firstName - first name fullName - full name handle - handle (unique, external) id - internal id of the user language - preferred language lastName - last name name - name netId - network id requireCertificate - requires certificate to login selfRegistered - is user self registered type - type of the object | | - | - | Respective field info | | 200,204,400,500 |
Note: modifier idOnly is referred only to first layer of the results. For all other layers (e.g. nested results) only ids are returned in some cases, due to possible loops. Example: for community containing collections, on second level the response contains only ids for some elements where multiple loops may be created (community->has_collection->has_community....). Other data is modified according to idOnly flag.
Optional parameters
Parameter | Description | ||||||
|---|---|---|---|---|---|---|---|
topLevelOnly | returns only top level communities | ||||||
idOnly | if true return only the identifiers for the record | ||||||
immediateOnly | return only direct parent community | ||||||
isAuthorized | return only collections user has permission to work on | ||||||
inArchive | return archived items for respective collection |
Sorting fields:
| Info | ||
|---|---|---|
| ||
The sorting of the fields / output results is currently partially supported. This part of the application is implemented independently of the endpoints and will be worked on after the most of endpoints are completed. |
Parameter | Description | Ordering supported | ||||||
|---|---|---|---|---|---|---|---|---|
id | sort results by entity id | | ||||||
name | sort results by entity name |
...
returns only top level communities
...
if true return only the identifiers for the record
...
return only direct parent community
...
return only collections user has permission to work on
...
return archived items for respective collection
Sorting fields:
Parameter | Description | Ordering supported | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Anchor | sort_id | sort_id | sort results by entity id | | |||||||||||||||||||||||||
| Anchor | sort_name | sort_name | sort results by entity name | | |||||||||||||||||||||||||
| Anchor | sort_countitems | sort_countitems | sort results by number of items contained | | |||||||||||||||||||||||||
| Anchor | sort_lastmodified | sort_lastmodified | sort results by date of last item modification | | |||||||||||||||||||||||||
| Anchor | sort_submittername | sort_submittername | sort results by submitter name | |
| sort_submitterid | sort_submitterid | |
...
|
Parameter | Description | Default | Example |
|---|---|---|---|
| position of the first entity to return | 0 (first) | |
| page of data to display | 0 (first) | |
| number of results to show on each page | 0 (all) | |
| maximum number of entities to return | 0 (all) | |
|
| the sort order to return entities in | |
...
countitems | sort results by number of items contained | | ||||||
lastmodified | sort results by date of last item modification | | ||||||
submitterName | sort results by submitter name | | ||||||
submitterId | sort results by submitter id | |
Controlling results
Parameter | Description | Default | Example |
|---|---|---|---|
| position of the first entity to return | 0 (first) | |
| page of data to display | 0 (first) | |
| number of results to show on each page | 0 (all) | |
| maximum number of entities to return | 0 (all) | |
|
| the sort order to return entities in | |
| Anchor | ||||
|---|---|---|---|---|
|
Response codes
Code | Description |
|---|---|
200 |
...
Response codes
Code | Description |
|---|---|
200 | OK |
201 | Created |
204 | No content |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method not allowed |
500 | Internal server error |
503 | Service unavailable |
Repository manipulation
Authentication/Authorization
Currently only standard authentication is supported. The authentication data is provided in the request or header body.
Example:
/rest/communities.json?user=user@email.com&pass=userpassword
The same elements user and pass are used for header based authentication.
Authorization is done on underlying api level; in the case of error the proper message and error code are returned to the user.
Repository manipulation
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Response Data | Formats | Response codes | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| | | Action to be done under community | | - | | |||||||||||
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Response Data | Formats | Response codes | |||||||||
• | | | Change description of | | | Response code | | 200, 400, 401, 403, 500 | |||||||||
• | | | Add community to the system | | | |
| 200, 400, 401, 403, 500 | |||||||||
• | | /communities/{id} | Delete community from the system | /{element} | Update the field | | - | Response code | | 200, 400, 401, 403, 500 | |||||||
• | | | Remove the administrators group from the community Set the logo for community | | - | Response code | |
| binary | 200, 400, 401, 403, 500 | |||||||
• | | | Remove collection | | | Response code |
| | 200, 400, 401, 403, 500 | ||||||||
• | | | Remove subcommunity | | | | - | Response code | |
| • | ||||||
|
| Create a default administrators group if one does not already exists | | - | |
|
| ||||||||||
• | | | Create a new collection within community | | - | |
|
| |||||||||
| Action to be done under collection | | - | Id ow newly created element | | 200, 400, 401, 403, 500 | |||||||||||
|
| • | |
| Add an existing collection | | -- | Response code |
|
| |||||||
• | | | Create a new subcommunity within community | | - | |
|
| |||||||||
Update field | | - | Response code | | 200, 400, 401, 403, 500 | ||||||||||||
• | | | Delete collection from the system | - | • | | | Add an existing community | | - | Response code |
|
|
| | | 200, 400, 401, 403, 500 |
• | |
| Remove attribute/value | | | Response code | | 200,400,401,403,500 | |||||||||
• | |
| Set metadata value | | | Response code |
|
| • | |
| Set the logo for collection | |
| Response code | | 200,400,401,403,500 |
• | | | Action to be done under item | |
| Id of newly created collection element |
| 200,400,401,403,500 | |||||||||
• | | | Delete collection from the system | Update field | | - | Response code |
| 200,400,401,403,500 | ||||||||
• | | | Delete item | | | Response code |
|
|
| | 200,400,401,403,500 | ||||||
• | |
| Set the logo for collection | |
| Response code |
|
| |||||||||
| | | Create a default administrators group if one does not already exists | | - | Response code |
|
| |||||||||
| | | Remove the administrators group from the collection | | - | Response code |
|
| |||||||||
| | | Create a default submitters group if one does not already exists | | - | Response code |
|
| |||||||||
| | | Remove the submitters group | | - | Response code |
|
| |||||||||
| | | Create an empty template item for this collection | | - | Response code |
|
| |||||||||
| | | Remove the template item from the collection | | - | Response code |
|
| |||||||||
| | | Add an item to the collection | | | Response code |
|
| |||||||||
| | | Set metadata value | | | Response code |
|
| |||||||||
| | | Set collection licence | | | Response code |
|
| |||||||||
|
|
|
|
|
|
|
|
|
Content searching
| Delete element/attribute | | - | Response code | | 200,400,401,403,500 |
Content searching
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|---|
| | | Return a list of all objects found by searching criteria. | - | modifiers{{query= | | Item info with basic metadata for the search results. Additionally return only | | 200, 204, 400, 500 |
| | | Return a list of all objects that have been created, modified or withdrawn within specified time range. | - | | - | Contains item info including id, name, handle, metadata, bitstreams according to | | 200, 204, 400, 500 |
Statistical info
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|---|
| | | Return general statistics. | - | - | - | Cummulative list of statistics data for the system currently available. | | 200, 400, 500 |
Relationships interface
| Info | ||
|---|---|---|
| ||
This is considered as a experimental feature in the phase of being considered for compability with future versions of DSpace. Consider not important section; the status of the feature for upcoming release yet to be determined. |
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
• | GET | /search | Return a list of all objects found by searching criteria. | - | TBD modifiers{{query= | | Item info with basic metadata for the search results. Additionally return only | | resource/{handle}/relations | Return entities according to relation and parameters specified | | | - | ontains entities selected and sorted in conformance to request parameters. For more details see description of | |
Mandatory parameters
Parameter | Description | | Return a list of all objects that have been created, modified or withdrawn within specified time range. | - | | - | Contains item info including id, name, handle, metadata, bitstreams according to | | 200, 204, 400, 500 |
|---|
Item status and retrieval
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|---|
| | | Return detailed information about an item. | | - | | | | 200, 204, 400, 500 |
| | | Return status of user permissions on this item. | | - | - | Boolean variable, stating can user edit the listed item. | | 200, 400, 500 |
| | | Return communities this item is part of. | | idOnly=false | | | | 200, 400, 500 |
| | | Return collections this item is part of. | | idOnly=false | | | | 200, 400, 500 |
| | | Return bitstream object - usually the library item file. | | - | - | | | 200, 400, 401, 403, 404, 500 |
| | | Return bitstream | | - | - | Return bitstream | | 200, 400, 401, 403, 404, 500 |
Item manipulation
...
C
...
Verb
...
URL
...
Description
...
Mandatory parameters
...
Optional parameters
...
Response Data
...
Formats
...
Response codes
...
•
...
POST
...
/items/{id}/action
...
Change parameters of item id
...
id
...
addBundle
addMetadata
createBundle
createSingleBitstream
removeBundle
removeLicenses
setArchived
setOwningCollection
setSubmitter
withdraw
...
Response code
...
json
xml
...
200, 400, 401, 403, 500
...
...
PUT
...
/items/{id}/bundle/{{bid}}
...
Add an existing bundle bid to item id
...
id
bid
...
...
...
...
...
...
DELETE
...
/items/{id}/bundle/{{bid}}
...
Remove bundle bid from item id
...
id
bid
...
...
...
...
...
...
PUT
...
/items/{id}/metadata
...
Add a single metadata field
...
...
...
...
...
...
DELETE
...
/items/{id}metadata
...
Remove a single metadata field
...
schema
element
qualifier
lang
...
...
...
...
...
...
DELETE
...
/items/{id}/metadata
...
...
...
...
...
...
...
•
...
POST
...
/communities
...
Add community to the system
...
name
...
logo
parent
other metadata
...
Id of newly created community
...
json
xml
...
200, 400, 401, 403, 500
...
•
...
DELETE
...
/communities/{id}{}
...
Delete community from the system
...
id
...
-
...
Response code
...
json
xml
...
200, 400, 401, 403, 500
...
•
...
PUT
...
/collections/{id}{}
...
Change description of id collection
...
id
...
...
Response code
...
json
xml
...
200, 400, 401, 403, 500
...
•
...
POST
...
/collections
...
Add collection to the system
...
name
communityId
...
...
Id of newly created collection
...
json
xml
...
200, 400, 401, 403, 500
...
•
...
DELETE
...
/collections/{id}{}
...
Delete collection from the system
...
-
...
-
...
Response code
...
json
xml
...
User oriented functions
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|---|
| | | Return a list containing id, name and email of persons. | - | | | List with information on particular user. Additionaly only identifiers are sent if idOnly is true. | | 200, 204, 400, 500 |
Statistical info
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|---|
| | | Return general statistics. | - | - | - | Cummulative list of statistics data for the system currently available. | | 200, 400, 500 |
Administrative tasks
Workflow related tasks
Relationships interface
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|---|
• | GET | /communities/{id}/relations | Return entities according to relation and parameters specified | | | - | ontains entities selected and sorted in conformance to request parameters. For more details see description of | |
Mandatory parameters
...
Parameter
...
Description
...
Values
...
Example
...
Return entities satisfying requested property relation
...
property=ds:hasCommunity - return subcommunities of a community
property=ds:isPartOfCommunity - return communities current community is part of (children)
property=ds:hasCollection - return collections belonging to community
property=ds:hasItem - return Items belonging to community
Values | Example | ||||||||
|---|---|---|---|---|---|---|---|---|---|
property | Return entities satisfying requested property relation | Structural properties | | ||||||
rtype | restriction on type - only entity with specifed type(s) would be returned | | | ||||||
| restriction on fields - return only selected fields; by default all fields are returned | id | rfield=id,name - return only entity id and name in response |
Note: incomplete/orientative properties, for more info check [Vocabularies|http://code.google.com/p/dspace-sandbox/source/browse/#svn/modules/dspace-rdf/tags/dspace-rdf-1.5.1/src/main/java/org/dspace/adapters/rdf/vocabularies].
Visitors' suggestions or wishes
Here the visitors and stakeholders can insert their suggestions or describe the needs for their applications in detail.
Comment: In this case it is not clear how to treat recent part of endpoint. If we stick to semantic mapping, then it should look like /resource/id/mapping, but recent in this case obviously do not represent a mapping, but the property.
Comment #2: Semantic mapping presented in this case should be probably hardcoded for 1.x branch, but on abstraction level which enables easy replacement with some auto-discovery method prepared for 2.x and eventually backported to 1.x. This way we would be able to call something similar to /communities/id or communities/id/capabilities in order to get supported mappings (amongst other data).
Suggesting new options:
Instead of changing wiki contents visitors can enter their suggestions as a comments.
1) Kevin S. Clarke and Tim Donhue suggested adding of the new feature related to HTTP Basic Auth. Ok, I will investigate how it could be done and included here. More info comming.
Integration in the system
It is planned to consult two external subjects for cooperation and the assistance during integration process (LMS and national library internal automation process). More information coming soon - awaiting approval of other parties.
Documentation tasks
Although provided software module exposes basic documentation automatically to the end user, in order to make it easier for other developers and users the documentation in the following forms is additionaly to be provided:
- Confluence pages, current location
- integrated documentation in PDF form (manual)
- short slides containing technology overview, advocacy/facts, configuration and usage guideliens and examples
- code will be additionally commented
Example of usage
At the end of the current stage of this project as a bonus task (if time constraints allow) the examples of usage will be provided for several languages, the use-cases will be presented (example of integration in other software, e.g. LMS) and optionally simple client system demonstrating UI customization will be demonstrated (e.g. Flex or JavaFX like).
Information for developers
In this section the main sections of the software will be briefly explained in order to ease update or extension of the components.
The REST API for DSpace uses Aaron Zeckoski's EntityBus and DSpace standard libraries, as dspace-api.
There are two main packages: org.dspace.rest.providers and org.dspace.rest.entities. Providers are responsible for serving content/feeds to the users. They usually prepare entities or particular entity and/or handle update/delete/create functions. The main class there is AbstractBaseProvider, which is extended by other providers.
In the providers, at the constructor level created are mappings between particular endpoints (e.g. /rest/items/1/collections) and related functions in entities (org.dspace.entities.items.getCollections). Thus, for each GET, PUT, POST or DELETE function in the entity provider's constructor defined are such mappings between URL endpoints and functions. After the client makes specific call, the provider prepares answer and in this phase calls mapped function and prepare results for display.
So, if you want to extend currently available endpoints for already present providers and entities, it is necessary to define mapping at provider level and prepare corresponding function at the entity level (based on the template). The system then calls this function and provides necessary arguments for its successfully handling.
If you want to develop a new provider, it is usually necessary to create new provider class in org.dspace.rest.providers and then create related entity in org.dspace.rest.entities. The currently available providers are good example how to do that
...
restriction on type - only entity with specifed type(s) would be returned
...
ds:Bitstream
ds:Bundle
ds:Collection
ds:Community
ds:EPerson
ds:Group
ds:Item
ds:DSpaceObject
ds:Policy
ds:Site
ds:BitstreamFormat|
...
rtype=ds:Collection - return entities of Collection type
...
restriction on fields - return only selected fields; by default all fields are returned
...
id
name
countitems
metadata
subcommunities
ancestors
owner
other (depending on object type, will be documented later)
...
rfield=id,name - return only entity id and name in response
Note: incomplete/orientative properties, for more info check [Vocabularies|http://code.google.com/p/dspace-sandbox/source/browse/#svn/modules/dspace-rdf/tags/dspace-rdf-1.5.1/src/main/java/org/dspace/adapters/rdf/vocabularies].
Visitors' suggestions or wishes
...
Comment: In this case it is not clear how to treat recent part of endpoint. If we stick to semantic mapping, then it should look like /resource/id/mapping, but recent in this case obviously do not represent a mapping, but the property.
Comment #2: Semantic mapping presented in this case should be probably hardcoded for 1.x branch, but on abstraction level which enables easy replacement with some auto-discovery method prepared for 2.x and eventually backported to 1.x. This way we would be able to call something similar to /communities/id or communities/id/capabilities in order to get supported mappings (amongst other data).
Integration in the system
...
Documentation tasks
...
- Confluence pages, current location
- integrated documentation in PDF form (manual)
- short slides containing technology overview, advocacy/facts, configuration and usage guideliens and examples
- code will be additionally commented
Example of usage
At the end of the current stage of this project as a bonus task (if time constraints allow) the examples of usage will be provided for several languages, the use-cases will be presented (example of integration in other software, e.g. LMS) and optionally simple client system demonstrating UI customization will be demonstrated (e.g. Flex or JavaFX like).