Add an item

Develop a gadget for my.utwente.nl

Developer guidelines for third parties

Developer guidelines for third parties

In this document the guidelines to which gadgets developed by a third party have to satisfy are described.

General guidelines

  • Gadgets have to follow the code of conduct of ICT and internet use
    • Students can follow this link.
    • Employees can follow this link.
  • Gadgets have to be bilingual, Dutch and English.

Technical guidelines

  • In the element ModulePrefs in the gadget spec following attributes are obligatory:
    • title
    • description
    • author
    • author_email
    • thumbnail
  • Gadgets have to adjust dynamically to the browser window width.
  • Gadgets have to adjust dynamically to the height of the content in the gadget.
  • Links to new content has to open in a new window/tab page.
  • Gadgets have to be tested and working in often used browser like:
    • Firefox
    • Chrome
    • Internet Explorer
    • Safari
Quickstart 'How to make a gadget'

Below you find indications about how you, as being a software developer, can develop OpenSocial gadgets.

What are OpenSocial gadgets?

Look at www.opensocial.org for all information about OpenSocial.

OpenSocial at the University of Twente

The StudentPortal from the University of Twente is an OpenSocial gadget rendering server based on Apache Shindig. Apache Shindig consists of four parts from which two are supported within the StudentPortal.


Shindig part

Supported by StudentPortal

Gadget Container JavaScript: core JavaScript foundation for general gadget functionality (read more about gadget functionality). This JavaScript manages security, communication, UI layout, and feature extensions, such as the OpenSocial API.

Yes

Gadget Rendering Server: used to render the gadget XML into JavaScript and HTML for the container to expose via the container JavaScript.

Yes

OpenSocial Container JavaScript: JavaScript environment that sits on top of the Gadget Container JavaScript and provides OpenSocial specific functionality (profiles, friends, activities, datastore).

No

OpenSocial Data Server: an implementation of the server interface to container-specific information, including the OpenSocial REST APIs, with clear extension points so others can connect it to their own backends.

No

For more information about Apache Shindig, follow this link.

Development environment

The OpenSocial Development Environment is a programming environment (IDE) for the development of OpenSocial gadgets (also including a local Apache Shindig test server).

Here you can find a quick start guide for working with the OpenSocial Development Environment:

OpenSocial Developer Guides

The Developer Guide of Google gives a first introduction for developing OpenSocial gadgets.

JavaScript API: a complete description of the OpenSocial JavaScript API

Gadgets XML Reference: gives an overview of xml elements and attributes which can be used in gadget spec

The OpenSocial specification: at this moment the StudentPortal supports version 0.8 and 0.9 of the OpenSocial specifications

MyUtwente: problems and errors

You log on to MyUtwente via my.utwente.nl with your m- or s-number. If you are having problems logging in, then one of the following points can probably help:

  1. Sign in with your s-or m-number (seven digits) and password. Do not use the eighth digit, this is solely for reservations of books in the library.
  2. Have you lost your password to your m- or s-number-user account? Please contact the ICTS Service (www.utwente.nl/icts --> Servicedesk).

Do none of these points solve your problem? Please contact us via onlinemedia@utwente.nl.