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.
Difference between revisions of "Orion/API Changelog"
< Orion
(not doing bug 461530 anymore) |
(→Orion 9.0) |
||
(9 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | This page lists breaking changes that may impact consumers of Orion | + | This page lists breaking changes that may impact consumers of Orion. It is maintained on a best-effort basis, and should not be taken as an exhaustive list. |
== Orion 9.0 == | == Orion 9.0 == | ||
==== Editor ==== | ==== Editor ==== | ||
− | * {{bug|461222}}: The HTML and CSS content assist providers no longer ship compiled into <tt>built-editor.js</tt> and <tt>built-editor.min.js</tt>. The caller is now responsible for loading their desired content assist provider(s) and registering them with the editor. | + | * {{bug|461222}}: The HTML and CSS content assist providers no longer ship compiled into <tt>built-editor.js</tt> and <tt>built-editor.min.js</tt>. This was done to reduce download size. The caller is now responsible for loading their desired content assist provider(s) and registering them with the editor. |
+ | ** Consult [https://github.com/eclipse/orion.client/blob/master/bundles/org.eclipse.orion.client.editor/web/examples/editor/embeddededitor.js#L50-L55 embeddededitor.js] for an example of how to do this. | ||
+ | ==== Server ==== | ||
+ | * {{bug|461739}}: <tt>npm</tt> commands have been removed from the Orion Shell page. The <tt>org.eclipse.orion.server.npm</tt> bundle, which implemented the servlet that provided these commands, has been removed. | ||
+ | |||
+ | ==== Orion plugins ==== | ||
+ | * {{bug|462082}} The "Get Plugins" page has been moved to [https://orion-plugins.github.io/ orion-plugins.github.io]. Plugin URLs have changed accordingly. | ||
+ | ** Users should uninstall any plugins hosted at <tt>*.googlecode.com</tt>, as they will eventually be taken down. | ||
== Orion 8.0 == | == Orion 8.0 == | ||
Line 12: | Line 19: | ||
* Translation is no longer provided through the plugin registry. Message bundles cannot be installed at runtime by the user. | * Translation is no longer provided through the plugin registry. Message bundles cannot be installed at runtime by the user. | ||
* Any <tt>nls</tt> properties on services registered with a PluginProvider are ignored. Other NLS-related properties, such as <tt>nameKey</tt>, <tt>descriptionKey</tt>, etc, are also ignored. | * Any <tt>nls</tt> properties on services registered with a PluginProvider are ignored. Other NLS-related properties, such as <tt>nameKey</tt>, <tt>descriptionKey</tt>, etc, are also ignored. | ||
− | * Plugins are expected to perform translation themselves, using any appropriate strategy (such as | + | * The Orion UI framework will no longer load message bundles nor look up strings on behalf of a plugin. |
+ | * Plugins are expected to perform translation themselves, using any appropriate strategy (such as [http://requirejs.org/docs/api.html#i18n RequireJS's 18n plugin], for example). Any user-facing labels or strings returned by services (such as validation error messages, or command labels) are now expected to be translated into the user's locale if possible. | ||
+ | ** See [[Orion/Internationalization#Translating_a_plugin|Translating a plugin]] for more details. | ||
+ | |||
+ | ==== Node.js server ==== | ||
+ | * {{bug|427399}}: On the Orion Node.js server, the navigation menu no longer links to the Orion Shell page. Instead, a link is shown to the ''Terminal'' page, which provides access to a native PTY through a web shell. | ||
+ | ** The Terminal page is currently not supported for Node.js servers running on Windows. | ||
[[Category:Orion]] | [[Category:Orion]] |
Latest revision as of 16:02, 18 March 2015
This page lists breaking changes that may impact consumers of Orion. It is maintained on a best-effort basis, and should not be taken as an exhaustive list.
Contents
Orion 9.0
Editor
- bug 461222: The HTML and CSS content assist providers no longer ship compiled into built-editor.js and built-editor.min.js. This was done to reduce download size. The caller is now responsible for loading their desired content assist provider(s) and registering them with the editor.
- Consult embeddededitor.js for an example of how to do this.
Server
- bug 461739: npm commands have been removed from the Orion Shell page. The org.eclipse.orion.server.npm bundle, which implemented the servlet that provided these commands, has been removed.
Orion plugins
- bug 462082 The "Get Plugins" page has been moved to orion-plugins.github.io. Plugin URLs have changed accordingly.
- Users should uninstall any plugins hosted at *.googlecode.com, as they will eventually be taken down.
Orion 8.0
Internationalization (i18n)
- The orion.i18n.message service has been removed.
- Translation is no longer provided through the plugin registry. Message bundles cannot be installed at runtime by the user.
- Any nls properties on services registered with a PluginProvider are ignored. Other NLS-related properties, such as nameKey, descriptionKey, etc, are also ignored.
- The Orion UI framework will no longer load message bundles nor look up strings on behalf of a plugin.
- Plugins are expected to perform translation themselves, using any appropriate strategy (such as RequireJS's 18n plugin, for example). Any user-facing labels or strings returned by services (such as validation error messages, or command labels) are now expected to be translated into the user's locale if possible.
- See Translating a plugin for more details.
Node.js server
- bug 427399: On the Orion Node.js server, the navigation menu no longer links to the Orion Shell page. Instead, a link is shown to the Terminal page, which provides access to a native PTY through a web shell.
- The Terminal page is currently not supported for Node.js servers running on Windows.