Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Orion/Documentation/User Guide/Reference/Settings page"

(Installing a plugin)
m (drop-down)
(15 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
= Settings page  =
 
= Settings page  =
  
The '''Settings''' page allows you to view and configure your Orion experience. Settings modified here affect only your single user account. Access this page by selecting '''Settings''' from the drop down menu next to your user name in the top right hand corner of the Orion application.
+
The '''Settings''' page allows you to view and configure your Orion experience. Settings modified here affect only your single user account. Access this page by selecting '''Settings''' from the Options drop-down menu on the right hand side of the page header.
  
[[Image:Orion-settings-menu.png]]
+
[[Image:Orion-settings-menu.png|Settings link in the user menu]]
  
 +
== UI Theme ==
 +
The '''UI Theme''' category on the '''Settings''' page allows you to customize the colors for common elements of the Orion user interface.
  
== Editor settings ==
+
[[Image:Orion-settings-ui-theme.png|UI theme builder]]
  
The '''JavaScript Editor''' category on the '''Settings''' page allows you to customize the fonts and colors used by Orion's built in code editor. Changes to these settings take effect immediately, even in editors that are currently open in other tabs.
+
To set the color of an element, click on it in the diagram. A color picker will appear, allowing you to set its color. You can also choose from several predefined themes using the drop-down menu.
  
[[Image:Orion-settings-editor.png]]
+
== Editor Theme ==
  
== Plugin settings ==
+
The '''Editor Theme''' category on the '''Settings''' page allows you to customize the colors used by Orion's built-in code editor. Changes to these settings take effect immediately, even in editors that are currently open in other tabs.
  
The '''Plugins''' category on the '''Settings''' page allows you to view and change the plugins that you have installed. Some plugins are already installed by default, and if you attempt to uninstall them they will be added back automatically. If you are a plugin developer, you can also use this page to browse through the services and properties of installed plugins.  
+
[[Image:Orion-settings-editor.png|Editor settings]]
  
<br>
+
To set the color for an editor element, click on it in the diagram and choose a color from the panel that appears.
  
[[Image:Pluginslist.png|500px]]  
+
You also can import an editor theme (it must be in the Eclipse Color Themes XML format). To do this, click the '''Import''' button, paste the theme's XML into the text entry field, then click Submit. The theme will be applied to your Orion editor. Consult the Eclipse Color Themes [http://eclipsecolorthemes.org/ website] for a large list of themes to choose from, and a description of the file format.
  
=== Installing a plugin ===
+
== Plugins ==
  
To install a plugin, click the&nbsp;'''Install '''link at the top left hand corner of the page, where a dialog will be presented to allow you to enter in the URL address of a plugin. Beside that link is a link to reload all the current plugins - sometimes useful for reestablishing default setups.  
+
The '''Plugins''' category on the '''Settings''' page allows you to view and change the plugins that you have installed. If you are a plugin developer, you can also use this page to browse through the services and properties of installed plugins.  
  
To find available plugins, you can click '''Get Plugins''' in the banner at the top of each Orion page. This will take you to an external catalog of available Orion plugins.  
+
[[Image:Pluginslist.png|Plugin list]]
  
[[Image:Orion-get-plugins.png]]
+
Each plugin entry can be individually reloaded by pressing the curved arrow icon beside the plugin information, and each can be individually removed using the "X" icon. A plugin can also be ''disabled'', which turns off its functionality but preserves its entry in the plugin list. Some plugins are already installed by default, and cannot be removed or disabled.
  
Selecting a plugin to install from that catalog will bring you back to the settings page, with the plugin URL already typed in for you. Confirm that this is the plugin you want to install, and click '''Submit'''.
+
[[Image:Orion-Pluginslist2.png|Plugin list with remove and disable buttons]]
  
[[Image:Orion-settings-install-external.png]]
+
=== Installing a plugin ===
 +
 
 +
To install a plugin, click the '''Install '''link at the top right-hand corner of the page, where a slide-out will appear to allow you to enter in the URL address of a plugin. Beside that link is a link to reload all the current plugins - sometimes useful for reestablishing default setups.
 +
 
 +
To find available plugins, you can click '''Get Plugins''' link beside the Install button at the top right-hand corner of the page. This will take you to an external catalog of available Orion plugins.
 +
 
 +
Selecting a plugin to install from that catalog will bring you back to the settings page, with the plugin URL already typed in for you. Confirm that this is the plugin you want to install, and click '''Submit'''.
  
Each plugin entry can be individually reloaded by pressing the curved arrow icon beside the plugin information, and each can be individually removed.
+
[[Image:Orion-settings-install-external.png|Plugin toolbar]]
  
 
=== Inspecting plugin services ===
 
=== Inspecting plugin services ===
Line 38: Line 46:
 
Beneath each plugin entry is a services link. Clicking on that link expands an area to reveal a carousel of service tables:  
 
Beneath each plugin entry is a services link. Clicking on that link expands an area to reveal a carousel of service tables:  
  
[[Image:Carousel.png|500px]]  
+
[[Image:Carousel.png|Plugin service carousel]]  
  
For plugins with multiple services, the carousel can be used to scroll through them from left to right of the screen. If you are debugging, and a service entry offers 'JavaScript Object' as a value for an item, clicking on that value will open the object up for further traversal in the console window of WebKit and Mozilla browsers.
+
For plugins with multiple services, the carousel can be used to scroll through them from left to right of the screen. If you are debugging, and a service entry offers 'JavaScript Object' as a value for an item, clicking on that value will send the object's value to the console window of your browser for further traversal.

Revision as of 16:34, 25 October 2013

Settings page

The Settings page allows you to view and configure your Orion experience. Settings modified here affect only your single user account. Access this page by selecting Settings from the Options drop-down menu on the right hand side of the page header.

Settings link in the user menu

UI Theme

The UI Theme category on the Settings page allows you to customize the colors for common elements of the Orion user interface.

UI theme builder

To set the color of an element, click on it in the diagram. A color picker will appear, allowing you to set its color. You can also choose from several predefined themes using the drop-down menu.

Editor Theme

The Editor Theme category on the Settings page allows you to customize the colors used by Orion's built-in code editor. Changes to these settings take effect immediately, even in editors that are currently open in other tabs.

Editor settings

To set the color for an editor element, click on it in the diagram and choose a color from the panel that appears.

You also can import an editor theme (it must be in the Eclipse Color Themes XML format). To do this, click the Import button, paste the theme's XML into the text entry field, then click Submit. The theme will be applied to your Orion editor. Consult the Eclipse Color Themes website for a large list of themes to choose from, and a description of the file format.

Plugins

The Plugins category on the Settings page allows you to view and change the plugins that you have installed. If you are a plugin developer, you can also use this page to browse through the services and properties of installed plugins.

Plugin list

Each plugin entry can be individually reloaded by pressing the curved arrow icon beside the plugin information, and each can be individually removed using the "X" icon. A plugin can also be disabled, which turns off its functionality but preserves its entry in the plugin list. Some plugins are already installed by default, and cannot be removed or disabled.

Plugin list with remove and disable buttons

Installing a plugin

To install a plugin, click the Install link at the top right-hand corner of the page, where a slide-out will appear to allow you to enter in the URL address of a plugin. Beside that link is a link to reload all the current plugins - sometimes useful for reestablishing default setups.

To find available plugins, you can click Get Plugins link beside the Install button at the top right-hand corner of the page. This will take you to an external catalog of available Orion plugins.

Selecting a plugin to install from that catalog will bring you back to the settings page, with the plugin URL already typed in for you. Confirm that this is the plugin you want to install, and click Submit.

Plugin toolbar

Inspecting plugin services

Beneath each plugin entry is a services link. Clicking on that link expands an area to reveal a carousel of service tables:

Plugin service carousel

For plugins with multiple services, the carousel can be used to scroll through them from left to right of the screen. If you are debugging, and a service entry offers 'JavaScript Object' as a value for an item, clicking on that value will send the object's value to the console window of your browser for further traversal.

Back to the top