E4/OpenSocialGadgets

From Eclipsepedia

Jump to: navigation, search

Gadgets are web-based software components based on HTML, CSS, and JavaScript. They allow developers to easily write useful web applications that work anywhere on the web without modification. They are defined using a declarative XML syntax that is processed by a gadget server into a format that allows them to be embedded into various contexts: standalone web pages, web applications, even other gadgets. A context into which a gadget is embedded is called a gadget container. The container is responsible for managing the gadgets' layout and controls, as well as for supporting various functionality on behalf of the gadget. A gadget may be a simple widget, a reusable component, or a full-blown application, possibly utilizing or communicating with other gadgets. (from the OpenSocial Gadgets specification)

As part of the e4 project, we are working on making Eclipse an OpenSocial Gadgets container. Here is what we've got so far:

Gadgets-screenshot.png

Install into Eclipse

The following should work with Eclipse 3.5 or a newer 3.6 milestone build:

  1. In a web browser, go to [1] and click on the link to the latest integration build, e.g. I20091022-2100.
  2. Find online p2 repo link (at the bottom right) and copy the link location to the clipboard.
  3. In Eclipse, select Help > Install New Software, and paste the link into the work with field. Press Enter. (Note: the IBM-internal mirror for this content is currently broken. Replace download.eclipse.org/e4 with www.eclipse.org/external/e4 to get it to work from inside IBM.)
  4. After the list of installable features is loaded, expand E4 UI and select Eclipse e4 Web Gadget (Incubation).
  5. Click Next and follow the wizard to completion. This will install two small plug-ins.

To add a gadget, press Ctrl+3, enter 'Open Gadget', press Return, and enter the gadget URL into the dialog.

Here are some example gadgets to try:

Bugs

This is work in progress, so don't expect everything to just work. Please help us improve it by filing bugs against e4/UI.

How to Contribute

If you'd like to help, pick a gadget that doesn't work yet and try to make it work. To coordinate the work, File an enhancement request with details on what you'd like to do.

To get the source code, follow these steps:

  1. Start with Eclipse 3.5 (or a 3.6 milestone build) and an empty workspace.
  2. Open the CVS Repositories view (Ctrl+3 CVSR).
  3. Copy the following string :pserver:anonymous@dev.eclipse.org:/cvsroot/eclipse
  4. Right-click in the view and select Paste Connection.
  5. (Optional: Adjust user name, password and connection method if you are a committer.)
  6. Expand the repository, then HEAD, e4, org.eclipse.e4.ui, bundles
  7. Select 'org.eclipse.e4.ui.gadgets' and 'org.eclipse.e4.ui.web', and select 'Check Out' from the context menu.