Jump to: navigation, search

Difference between revisions of "Orion/How Tos/Installing A Plugin"

< Orion‎ | How Tos
(category sort)
Line 11: Line 11:
  
  
To remove an installed plugin:
+
=== Remove an installed plugin ===
 
*Select its URL in the tree.
 
*Select its URL in the tree.
 
*Click the '''Copy Location''' button to copy its URL into the text box.
 
*Click the '''Copy Location''' button to copy its URL into the text box.
Line 18: Line 18:
 
<!--  
 
<!--  
 
click on the red X.<br> &nbsp; [[Image:Orion-install-plugin.png]]<br>
 
click on the red X.<br> &nbsp; [[Image:Orion-install-plugin.png]]<br>
=== Install using add-extension page ===
 
In Orion M7,
 
  
You can link
+
 
 +
=== Install using add-extension page ===
 +
In Orion 0.2 M7 or higher, you can link to
 
http://yourOrionServer/add-extension.html#http://yourPluginServer
 
http://yourOrionServer/add-extension.html#http://yourPluginServer
 
For example, here is a link that will prompt you to add the Javascript-format plugin to your Orionhub account (if you have one):
 
For example, here is a link that will prompt you to add the Javascript-format plugin to your Orionhub account (if you have one):

Revision as of 16:10, 12 July 2011

This page explains how an end-user can install third-party functionality so that it is available to the Orion editor.

Install using Registry Page

Orion-plugin-list.png

  • Enter a plugin URL into the text field. For example, enter http://jsbeautifier.org/orion/0.2/jsbeautify.html to install JavaScript code formatting functionality. Click "Install".
  • You should see a success message, and the the tree will refresh. It should now contain the new plugin.
  • The plugins are currently installed using local storage, which means that they are only active in one browser.


Remove an installed plugin

  • Select its URL in the tree.
  • Click the Copy Location button to copy its URL into the text box.
  • Click Uninstall, then OK to the prompt.
  • The plugin should disappear from the list.

Using installed functionality

Installed plugins may contribute functionality to Orion in a number of different ways, not all of which are immediately visible in the UI.

Continuing from where the previous example left off:

  • From the Navigator page, create a new JavaScript file called test.js.
  • Click on test.js to open it in the Orion code editor.
  • Type or copy/paste some JavaScript code into the editor (preferably some code with messy formatting).
  • Look at the editor toolbar. You'll see a new command available called "Format JS". This command was contributed by the jsbeautify plugin we installed earlier. Commands can also define a key binding that activates the command. (You can see a list of available key bindings by pressing Ctrl+Shift+L while on the editor page, or "?" on any other page.) A contributed editor command has access to the selected text in the editor, the complete editor buffer, and information about the current selection. As a result of invoking a command, the command can replace the current selection with a new text, change the complete editor buffer, and/or change the selection.

Orion-plugin-action.png

  • Select your code, click "Format JS", and it will be formatted for you.

See the Developer Guide for a list of places where new functionality can be contributed to Orion. If you have ideas for an extension but need more or different API to implement it, please file a bug.