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

From Eclipsepedia

< Orion‎ | How Tos
Jump to: navigation, search
(Install using Registry Page)
(Install using Registry Page: fix up links, instructions for 0.2)
Line 3: Line 3:
 
=== Install using Registry Page  ===
 
=== Install using Registry Page  ===
  
*If your server runs on orionhub.org, go to [http://orionhub.org/view-registry.html http://orionhub.org/view-registry.html].  
+
*If your server runs on orionhub.org, go to [http://www.orionhub.org/plugin/list.html http://www.orionhub.org/plugin/list.html].  
*If your server runs on localhost, go to [http://localhost:8080/view-registry.html http://localhost:8080/view-registry.html].  
+
*If your server runs on localhost, go to [http://localhost:8080/plugin/list.html http://localhost:8080/plugin/list.html].  
*This page shows all installed plugins. JSLint may show up, this is a plug-in that the Orion code installs for you when opening the editor.  
+
*This page shows all installed plugins. You'll see several plugins in the list already. These contribute some basic Orion functionality (for example, file support, Git, and JSLint).
*Enter a plugin URL into the text field in the upper right corner. For example, enter [http://bokowski.github.com/format-js.html http://bokowski.github.com/format-js.html] to install JavaScript code formatting functionality. Click "Install".  
+
*Enter a plugin URL into the text field. For example, enter [http://jsbeautifier.org/orion/0.2/jsbeautify.html http://jsbeautifier.org/orion/0.2/jsbeautify.html] to install JavaScript code formatting functionality. Click "Install".  
*The tree on the left should update, and should now contain the new plugin.  
+
*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. If you would like to remove the installed plugins, click on the red X.<br> &nbsp; [[Image:Orion-install-plugin.png]]<br>
+
*The plugins are currently installed using local storage, which means that they are only active in one browser. If you would like to remove an installed plugin:
 +
**Select it in the tree
 +
**Click the '''Copy Location''' button to put its URL into the text box
 +
**Click '''Uninstall''', then OK to the prompt.
 +
**The plugin should disappear from the list.
 
<!--  
 
<!--  
 +
click on the red X.<br> &nbsp; [[Image:Orion-install-plugin.png]]<br>
 
=== Install using add-extension page ===
 
=== Install using add-extension page ===
 
In Orion M7,  
 
In Orion M7,  

Revision as of 17:18, 17 June 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

  • If your server runs on orionhub.org, go to http://www.orionhub.org/plugin/list.html.
  • If your server runs on localhost, go to http://localhost:8080/plugin/list.html.
  • This page shows all installed plugins. You'll see several plugins in the list already. These contribute some basic Orion functionality (for example, file support, Git, and JSLint).
  • 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. If you would like to remove an installed plugin:
    • Select it in the tree
    • Click the Copy Location button to put its URL into the text box
    • Click Uninstall, then OK to the prompt.
    • The plugin should disappear from the list.

Use installed functionality

  • Installed plugins currently show up as actions in the editor toolbar.
  • Click on the toolbar item to invoke the action. Some actions may have defined a key binding (which we don't display in the UI yet).
  • Actions have access to the selected text in the editor, the complete editor buffer, and the current selection. As a result of invoking an action, the action can replace the current selection with a new text, change the complete editor buffer, and/or change the selection.
  • If you have ideas for actions but need more or different API to implement it, please file a bug.
      Orion-plugin-action.png