Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Orion/How Tos/How to write an Orion SDK plugin
Contents
Introduction
This how-to deals with creating a plugin that is part of the Orion SDK - one that is stored, built and used in the Orion client. For a how-to on creating a plugin in general, please see the Simple Plugin Example.
The remainder of this how-to assumes a few things:
- You have already created a plugin and that you want to hook all of the pieces up to make it part of the SDK. As an example the new
org.eclipse.orion.client.javascriptplugin will be referenced. - You have the Orion client repository checked out, and the projects imported in your workspace.
- You have some familiarity with Ant buildfiles and editing them.
Put the code in the client
Update the defaults
To have your plugin show up installed by default in Orion (see testing Orion plugins for more information) you will want to add an entry to the org.eclipse.orion.client.ui/web/defaults.pref file.
The entry is based off the root of where your plugin provides its packages (more on this in update the site information section) and specifies if the plugin should be started automatically. For example, the JavaScript plugin adds the entry: "javascript/plugins/javascriptPlugin.html":true. This entry points to the HTML file for the plugin and is based off the root you supply in the site configuration and also indicates that the plugin should be automatically started.
The path entered here added to the path from the site configuration must point directly to your pluings' HTML file. For example the JavaScript plugin has the org.eclipse.orion.client.javascript/web/ path in its site configuration, making the full path to the plugin HTML file: org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.html.