Release 3.0.3929_Beta1

RealObjects Nimbudocs Editor Readme

Date 2017-11-17

Documentation

ReadMe

API Documentation & Guides

The API documentation contains information about the JavaScript API doc of Nimbudocs Editor and also includes integration guides.

This documentation is available on the installed Nimbudocs Editor server and can also be downloaded from there.

Release 3.0.3929_Beta1 (released 2017-11-17)

Features

Improvements

Bug Fixes

Changes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2018-03-30.

Release 2.5.3891_Beta5 (released 2017-09-20)

Changes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2018-01-31.

Release 2.5.3885_Beta5 (released 2017-09-14)

Features

Improvements

Bug Fixes

Changes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2018-01-31.

Release 2.5.3828_Beta4 (released 2017-05-31)

Features

Improvements

Bug Fixes

Changes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2018-01-31.

Release 2.5.3736_Beta3 (released 2017-01-12)

Features

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2017-06-01.

Release 2.5.3723_Beta2 (released 2016-12-21)

Features

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2017-06-01.

Release 2.5.3694_Beta1 (released 2016-12-01)

Improvements

Bug Fixes

Changes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2017-01-31.

Release 2.4.3630_Beta4 (released 2016-10-19)

Features

Improvements

Bug Fixes

Changes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2017-01-31.

Release 2.4.3597_Beta3 (released 2016-09-22)

Improvements

Bug Fixes

Changes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2017-01-31.

Release 2.4.3545_Beta2 (released 2016-08-29)

New Features

Improvements

Bug Fixes

Changes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2017-01-31.

Release 2.4.3486_Beta1 (released 2016-06-22)

New Features

Improvements

Bug Fixes

Changes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2016-09-01.

Release 2.3.3437_Beta5 (released 2016-04-20)

Bug Fixes

Changes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2016-09-01.

Release 2.3.3423_Beta4(released 2016-04-12)

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2016-09-01.

Release 2.3.3409_Beta3 (released 2016-04-04)

New Features

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2016-09-01.

Release 2.3.3405_Beta2 (released 2016-03-31)

New Features

Improvements

Bug Fixes

Changes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2016-09-01.

Release 2.3.3327_Beta1 (released 2015-12-17)

New Features

Improvements

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2016-03-31.

Release 2.2.3284_GM (released 2015-11-09)

Bug Fixes

Changes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2015-12-31.

Release 2.2.3273_GM (released 2015-10-21)

New Features

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2015-12-31.

Release 2.2.3243_Beta2 (released 2015-09-21)

New Features

Improvements

Changes

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2015-12-31.

Release 2.2.3217_Beta1 (released 2015-09-02)

New Features

Improvements

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2015-12-31.

Release 2.0.3107_RC1 (released 2015-04-17)

New Features

Improvements

Bug Fixes

Changes

Known Issues

Beta Release 2.0.3074_Beta1 (released 2015-04-07)

New Features

Improvements

Changes

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2015-05-31.

Beta Release 1.1.3036_Beta9 (released 2015-03-06)

New Features

Improvements

Changes

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2015-05-31.

Beta Release 1.1.2953_Beta8 (released 2015-01-15)

Improvements

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2015-03-31.

Beta Release 1.1.2934_Beta7 (released 2014-11-27)

Improvements

Changes

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2015-03-31.

Beta Release 1.1.2891_Beta6 (released 2014-10-02)

New Features

Changes

Bug Fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-11-30.

Beta Release 1.1.2882_Beta5 (released 2014-09-17)

New Features

Bug fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-11-30.

Beta Release 1.1.2879_Beta4 (released 2014-09-15)

New Features

Improvements

Changes

Bug fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-11-30.

Beta Release 1.1.2860_Beta3 (released 2014-08-20)

Changes

Bug fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-09-30.

Beta Release 1.1.2855_Beta2 (released 2014-08-13)

New Features

Changes

Bug fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-09-30.

Beta Release 1.1.2817_Beta1 (released 2014-07-10)

New Features

Bug fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-09-30.

Beta Release 1.1.2807_Beta0 (released 2014-07-07)

New Features

Improvements

Changes

Bug fixes

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-09-30.

Beta Release 0.9.1530 (released 2014-06-18)

New Features

Improvements

Changes

Bug fixes

Beta Disclaimer

This version of the Nimbudocs Editor is a non-public beta version and is not intended to be used on productive systems. Functionality and API are subject to change. You are not allowed to disclose any information or resources to third parties.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-08-30.

Known Issues

Beta Release 0.9.1487 (released 2014-06-06)

New Features

Improvements

Bug fixes

Beta Disclaimer

This version of the Nimbudocs Editor is a non-public beta version and is not intended to be used on productive systems. Functionality and API are subject to change. You are not allowed to disclose any information or resources to third parties.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-08-30.

Known Issues

Beta Release 0.9.1448 (released 2014-05-28)

New Features

Improvements

Changes

Bug fixes

Beta Disclaimer

This version of the Nimbudocs Editor is a non-public beta version and is not intended to be used on productive systems. Functionality and API are subject to change. You are not allowed to disclose any information or resources to third parties.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-08-30.

Known Issues

Beta Release 0.9.1420 (released 2014-04-30)

Bug fixes

Improvements

New Features

Changes

Beta Disclaimer

This version of the Nimbudocs Editor is a non-public beta version and is not intended to be used on productive systems. You are not allowed to disclose any information or resources to third parties.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-06-30.

Beta Release 0.9.1128 (released 2014-03-14)

Bug fixes

Improvements

New Features

Changes

Beta Disclaimer

This version of the Nimbudocs Editor is a non-public beta version and is not intended to be used on productive systems. You are not allowed to disclose any information or resources to third parties.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-06-30.

Beta Release 0.9.1109 (released 2014-02-17)

Changes

Beta Disclaimer

This version of the Nimbudocs Editor is a non-public beta version and is not intended to be used on productive systems. You are not allowed to disclose any information or resources to third parties.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-03-31.

Beta Release 0.9.1087 (released 2014-01-07)

Bug Fixes

Beta Disclaimer

This version of the Nimbudocs Editor is a non-public beta version and is not intended to be used on productive systems. You are not allowed to disclose any information or resources to third parties.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-03-31.

Beta Release 0.9.1082 (released 2013-12-20)

Bug Fixes

Changes

Beta Disclaimer

This version of the Nimbudocs Editor is a non-public beta version and is not intended to be used on productive systems. You are not allowed to disclose any information or resources to third parties.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2014-03-31.

Beta Release 0.9.1067 (released 2013-11-21)

Bug Fixes

Features

Improvements

API Changes

NimbudocsEditor

Options

Actions

Beta Disclaimer

This version of the Nimbudocs Editor is a non-public beta version and is not intended to be used on productive systems. You are not allowed to disclose any information or resources to third parties.

Known Issues

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2013-12-31.

Beta Release 0.9.1024 (released 2013-10-24)

Bug Fixes

Features

Improvements

API Changes

NimbudocsEditor

For more information please see the migration guide below.

Options

Actions

Beta Disclaimer

This version of the Nimbudocs Editor is a non-public beta version and is not intended to be used on productive systems. You are not allowed to disclose any information or resources to third parties.

Known Issues

Additional Notes

Migration Guide

Integration

With this beta release, we changed how instances of Nimbudocs Editor are created. In order to prevent conflicts with javascript libraries and CSS of the embedding page with the editor, we now place each editor inside an iframe.

Inside the iframe, the editor is independent from the libs and styles that the integrator used for his web site.

For the migration, some small adaptions of the integration code on the client are required:

The old integration code:

if(NimbudocsEditor.isSupported()) {

window.editor = new NimbudocsEditor(appContainer, serverUrl, options);

} else {

alert("This browser does not meet the requirements of Nimbudocs Editor.");

}

The new integration code:

var options = {

onready : function(editor) {window.editor = editor;}

onnotsupported : function() {alert("This browser does not meet the requirements of Nimbudocs Editor.");}

};

NimbudocsEditor.create(appContainer, serverUrl, options);

Note that the nimbudocseditor lib no longer includes jQuery and jQueryUI. If jQuery is used for the web site, it has to be imported seperately now.

For more information about the client integration, please see the Quick Integration Guide in the JavaScript API doc.

Action handling

Adding custom code to actions and overriding actions is now handled differently. Now, you can add custom code to any action by using the method addInvocationListener. These listeners are notified when the action is invoked and an ActionInvocationEvent is passed to each of them.

editor.getAction("bold").addInvocationListener(function(event) {

console.log("bold action triggered");

});

You can no longer override the invoke or invokeLocal methods. To prevent actions from executing their default functionality, call the preventDefault method on the event object.

editor.getAction("bold").addInvocationListener(function(event) {

console.log("preventing bold action");

event.preventDefault();

});

The getCurrentTarget method has been removed from the Action class. The DOM element which triggered the action (if any) is now stored in the trigger property of the invocation event.

Widgets

The options enableRuler, enableSidebar and searchbar are no longer applicable. Instead, there is the new widgets option. Furthermore, the options enableRuler, enableSidebar, alwaysOpenSidebar and enableCollabPanel have been removed or are now part of the widget. Any widget can now be disabled by setting it to false.

This option object contains the used widgets and their configuration:

Old option object:

var options = {

enableRuler : true,

enableCollabPanel : false,

enableSidebar : true,

alwaysOpenSidebar : false,

searchbar : {

position : "top-left"

simple : false

}

};

New option object:

var options = {

widgets : {

ruler : true,

collabPanel : false,

sidebar : {

alwaysOpen: false

},

searchbar : {

position : "top-left"

simple : false

}

}

};

You can also deactivate all widgets like this:

var options = {

widgets : false

};

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2013-12-31.

Beta Release 0.9.931 (released 2013-09-23)

Bug Fixes

Features

Improvements

Beta Disclaimer

This version of the Nimbudocs Editor is a non-public beta version and is not intended to be used on productive systems. You are not allowed to disclose any information or resources to third parties.

Known Issues

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2013-12-31.

Beta Release 0.9.849 (released 2013-08-14)

Beta Disclaimer

This version of the Nimbudocs Editor is a non-public beta version and is not intended to be used on productive systems. You are not allowed to disclose any information or resources to third parties.

Known Issues

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2013-12-31.

System Requirements

Browser Support

The following browsers are supported:

The create() provides functionalities to react to non-supported browsers. Please see the Quick Integration Guide in the JavaScript API doc for more information.

Please note that development previews of supported browsers may not be able to run Nimbudocs Editor, even if the requirements check in JavaScript reports otherwise.

Must-have Capabilities

The following features are must-have browser capabilities. Without them Nimbudocs Editor will not work as intended.

* CORS is not required when using a reverse proxy as described in the Quick Integration Guide at the JavaScript API doc.

Should-have Capabilities

The following features are should-have browser capabilities. Without them Nimbudocs Editor will still work in general, but some of its functionality will not.

Server Minimum Hardware Requirements

This chapter holds information for integrators who do not use Nimbudocs Editor as a Service.

In general, hardware requirements depend very much on the platform, the speed of the JVM implementation and the complexity of the documents which are edited.

Nimbudocs Editor as Virtual Appliance

Server Installation

The Virtual Appliance provides everything required to deploy a functional Nimbudocs Editor server as Virtual Machine.

Use the following URL for: VMWare vSphere, Oracle VM VirtualBox

http://repo.realobjects.com/download/beta/ovf/nimbudocs-va_OVF10.ovf

Additionally you need the vmdk file if you want to use VirtualBox:

http://repo.realobjects.com/download/beta/ovf/system.vmdk

If you want to use VMWare Workstation, Server or Player you can also download a compressed archive of VMX and VMDK files:

http://repo.realobjects.com/download/beta/ovf/nimbudocs-va.zip

Deployment of Nimbudocs Editor is supported on Oracle VM VirtualBox and VMware ESX. VMware ESX only requires the URL to the OVF file, VirtualBox requires both the ovf10 and vmdk file downloaded to the same folder.

Integration

Download the integration code & resources from the Nimbudocs Editor server and continue with the Integration Code & Resources chapter.

Nimbudocs Editor as Package

Contents

The archive release file contains this ReadMe and a pre-configured Jetty Application Server with the Nimbudocs Editor application.

Server Installation

The provided Jetty Application Server needs to be added to a host server.

To start, restart or stop the server on Unix-based systems run:

[JETTY_HOME]/bin/jetty.sh start

[JETTY_HOME]/bin/jetty.sh restart

[JETTY_HOME]/bin/jetty.sh stop

To start without the shell script, use start.jar:

[JETTY_HOME]/java -jar start.jar

System Requirements

Nimbudocs Editor provides a pre-configured Jetty Application Server. In addition Java is required. The following VMs are supported:

Integration

Download the integration code & resources from the Nimbudocs Editor server and continue with the Integration Code & Resources chapter.

Integration Code & Resources

The integration code & resources archive is available on the running Nimbudocs Editor server. It contains the following folders:

/doc/apidoc

This folder contains the JavaScript API documentation.

/samples/StandardSample

This folder contains the standard sample, including custom actions, localization and UI configuration.

The sample requires the URL to a Nimbudocs Editor server and will not run out-of-the-box. The sample will also not run from a file URL.

Current Limitations

Accessible Resources

External resources (e.g. images, CSS, ...) of documents to be loaded must be available to the server. The server must be able to reach their resolved URLs and download the data.

Mobile UI

Nimbudocs Editor currently provides no mobile user interface. It is intended to provide such an interface in the future.

Localization

It is currently not possible to set the locale file, it is only possible to add a locale extension.

Load Balancer

Using a load balancer and Collaboration is currently not supported.

Support

Additional Copyrights and other Important Notes

Copyright (c) 2014-2017, RealObjects GmbH.
All rights reserved.

support@realobjects.com
http://www.realobjects.com