Jump to: navigation, search

Difference between revisions of "Orion/Documentation/Developer Guide/Simple plugin example"

(remove 'line' attr from <source> because of WikiText not handling it)
(The finished plugin file)
Line 103: Line 103:
=== The finished plugin file ===
=== The finished plugin file ===
Make sure that your copy of <tt>reversePlugin.html</tt> looks like this:
Make sure that your copy of <tt>reversePlugin.html</tt> looks like this:
<source lang="javascript" enclose="div">
<source lang="javascript" enclose="div" line="GESHI_FANCY_LINE_NUMBERS">
<!DOCTYPE html>
<!DOCTYPE html>
Line 129: Line 129:
=== Testing the plugin ===
=== Testing the plugin ===
First we need to host our plugin somewhere.  
First we need to host our plugin somewhere.  

Revision as of 15:29, 31 October 2013

This section explains how to write a plugin for Orion. It is intended for developers who want to extend Orion's functionality.

What is a plugin?

  • A plugin is an HTML file containing some JavaScript that knows how to connect to the Orion client. Plugins can be hosted on any web server and installed into Orion using their URL.
  • In order to be useful, a plugin should provide one or more services. When Orion needs a service contributed by a plugin, it loads the plugin inside an IFrame.
  • Orion currently supports a set of extension points: service types that plugins can contribute to, in order to customize the client and add more functionality. These include things like:
    • Adding more commands to the editor toolbar
    • Adding more commands to the navigator view
    • Adding content assist for new file types
    • Adding syntax highlighting rules for new file types

For a full list of available services, see the Developer Guide.

What you need

Every plugin must include the following JavaScript library: plugin.js

You can copy-paste its contents into a <script> tag in your plugin, or load it externally like so:

<script src="plugin.js"></script>

The plugin.js file is also an AMD module, so you can alternatively load it through a module loader like RequireJS.

require(['plugin'], function(PluginProvider) {
    // ...

Writing the plugin

Let's make a plugin that adds a button to the toolbar of the Orion editor. When clicked, it will reverse the selected text in the editor. This is not a very useful feature, but it'll be a good introduction to the concepts involved.

Creating the HTML file

Create a new HTML file called reversePlugin.html with the following content:

<!DOCTYPE html>
<meta charset="UTF-8" />
   <title>Reverse Plugin</title>

Now we have a bare-bones HTML file. The next step is to include the API we need to talk to Orion. Grab the plugin.js file (see What you need) and put it in the same folder as reversePlugin.html. Then add this inside the <head> tags of the HTML file:

 <script src="plugin.js"></script>

Making it a plugin

Next, we'll add some code that connects our file to Orion. Add the following, again inside the <head> tags:

        var headers = { name: "My Plugin", version: "1.0", description: "My first Orion plugin." };
        var provider = new orion.PluginProvider(headers);

At this point, we've got an honest-to-goodness Orion plugin, albeit one that does nothing. Let's go over the various parts in detail.

var headers = ...
An optional object supplying metadata about the plugin's name, version and description. This is used to display information about the plugin on Orion's Settings page.
var provider = new orion.PluginProvider(headers)
Creates a new PluginProvider. The PluginProvider may provide one or more services, but right now ours doesn't provide any.
This is where the magic happens. When our plugin is activated from Orion, this call opens an asynchronous communication channel. Orion adds information about our plugin, and any service contributions it makes, to the Orion registry.

Registering the service

Now we're going to expose a service to Orion. We'll create and register a service with the orion.edit.command service type. Add the additional lines as shown:

        var headers = { name: "My Plugin", version: "1.0", description: "My first Orion plugin." };
        var provider = new orion.PluginProvider(headers);
        var serviceImpl = { };
        var serviceProperties = { };
        provider.registerService("orion.edit.command", serviceImpl, serviceProperties);

Let's review what was added:

var serviceImpl
This object gives the implementation of our service, the part that will do the actual work. When someone requests our service, our plugin is loaded into an IFrame, and the service's methods are made available. The function-typed properties of the serviceImpl object define the service methods.
var serviceProperties
Every service provider can supply properties, which is an object that holds metadata about the service provider. If you're familiar with Eclipse desktop, you can think of service properties as analogous to the extensions declared in a plugin.xml file.
provider.registerService("orion.edit.command", serviceImpl, serviceProperties);
This call registers our service implementation and properties with the service type "orion.edit.command". At this point, if we tried installing our plugin into Orion, we'd have enough to make the Orion editor see our contribution. However, our contribution still does nothing. Let's fix that.

Implementing the service

We'll fill in the serviceImpl and serviceProperties objects with the actual details of the service. Change the serviceImpl object to look like this:

        var serviceImpl = {
            run: function(text) {
                return text.split("").reverse().join("");

Note that the functions defined in the service will depend on what service type you're contributing to. In our case, we're contributing to "orion.edit.command", which expects a run() function. (See the Developer Guide for a list of extension points and their API.)

Change the serviceProperties object to look like this:

        var serviceProperties = {
            name: "Reverse Text",
            key: ["e", true, true] // Ctrl+Shift+e

The finished plugin file

Make sure that your copy of reversePlugin.html looks like this:

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4.   <meta charset="UTF-8" />
  5.   <title>Reverse Plugin</title>
  6.   <script src="plugin.js"></script>
  7.   <script>
  8.       var headers = { name: "My Plugin", version: "1.0", description: "My first Orion plugin." };
  9.       var provider = new orion.PluginProvider(headers);
  10.       var serviceImpl = {
  11.               run: function(text) {
  12.                   return text.split("").reverse().join("");
  13.               }
  14.       };
  15.       var serviceProperties = {
  16.               name: "Reverse Text",
  17.               key: ["e", true, true] // Ctrl+Shift+e
  18.       };
  19.       provider.registerService("orion.edit.command", serviceImpl, serviceProperties);
  20.       provider.connect();
  21. </script>
  22. </head>
  23. <body></body>
  24. </html>

Testing the plugin

First we need to host our plugin somewhere.

Now that you've got a URL for reversePlugin.html, install it into Orion:

Let's try it out.

  • In Orion, go to the navigator and create a new file called test.txt.
  • Click on test.txt to open the editor.
  • You'll see a new button on the editor toolbar (see screenshot below).
  • Select some text, click the button, and it should be reversed.



Here are some existing plugins we've written. View their source code to see how they work:

Contributes several sample actions to the Orion navigator by using the orion.navigate.command service type.
Contributes syntax highlighting support for HTML files by using the orion.edit.highlighter service type.
Contributes extended search completion in addition to recent searches by using the orion.search.proposal service type.
Contributes a "Beautify JS" button to the editor toolbar by using the orion.edit.command service type. Visit http://mamacdon.github.io for a directory of other available plugins, organized by Orion version.
Contributes an "Uglify JS" (minify, in other words) button to the editor toolbar by using the orion.edit.command service type.

See also