Documentation

ReadMe

Current Release Information
System Requirements
Deployment of the Nimbudocs Editor server:
- Virtual Appliance
- Package
Integration Code & Resources
Current Limitations
Support

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 5.0.6422_Beta6 (released 2024-02-27)

Bug Fixes

#9165: The overlay is now correctly removed when restoring from disc hibernation with an opened modal dialog.

Changes

Third party library version updates.
Updated layout engine and built-in PDFreactor.

Additional Notes

Time Bomb

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

Release 5.0.6313_Beta5 (released 2024-02-27)

Features

#9137: Added a method to get a list of all users in the collaboration session.
#9127: Added configuration option the file name of the PDF download from the "Print" dialog.

Bug Fixes

#9117: Generated content that is used to display semantic elements is now isolated and mirrored.
#9118: Pressing enter twice in the last RTL list item now creates a new paragraph after the list.

Changes

Third party library version updates.
Updated layout engine and built-in PDFreactor.

Additional Notes

Time Bomb

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

Release 5.0.6235_Beta4 (released 2023-11-27)

Improvements

#9101: Custom fonts uploaded through Webmin now have a quoted font-family name.

Bug Fixes

#9113: Selecting in RTL content no longer causes an unresponsive editor session/browser tab.
#9116: Caret is no longer visually displayed on the next line when pressing backspace inside RTL section.
#9119: Arabic characters in subsequent lines are now completely visible when previous line has a background-color.
#9120: The "free color palette" pop-up is no longer covered by the color dialog when used in the header/footer editor.

Additional Notes

Time Bomb

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

Release 5.0.6176_Beta3 (released2023-10-23)

Features

#9092: BiDi user interface and actions can now be disabled by a configuration option (disableBiDiUI).

Improvements

Added new release artifact for easier deployment in third-party application servers. This consists of a new Nimbudocs Editor WAR file including all required libraries.

Bug fixes

#9072: Pasting a table (cell) from word no longer causes an invalid CSS rule.
#9073: Table cell borders no longer have an unexpected grey color (caused by an invalid CSS rule).

Changes

Third party library version updates.
Updated layout engine and built-in PDFreactor.

Additional Notes

Time Bomb

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

Release 5.0.6125_Beta2 (released 2023-09-21)

Features

#9036: It is now possible to set/modify the text direction of list elements.
#9040: It is now possible to set/modify the text direction inline
#9041: The caret can indicate (toggled by the toggle-text-direction-view action), if the caret is inside an element which has set RTL as direction attribute.

Changes

Third party library version updates.
Updated layout engine and built-in PDFreactor.

Additional Notes

Time Bomb

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

Release 5.0.6023_Beta1 (released 2023-07-26)

Features

#9092: BiDi user interface and actions can now be disabled by a configuration option (disableBiDiUI).

Improvements

Added new release artifact for easier deployment in third-party application servers. This consists of a new Nimbudocs Editor WAR file including all required libraries.

Bug fixes

#9072: Pasting a table (cell) from word no longer causes an invalid CSS rule.
#9073: Table cell borders no longer have an unexpected grey color (caused by an invalid CSS rule).

Changes

Third party library version updates.
Updated layout engine and built-in PDFreactor.

Additional Notes

Time Bomb

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

Release 5.0.6125_Beta2 (released 2023-09-21)

Features

#9036: It is now possible to set/modify the text direction of list elements.
#9040: It is now possible to set/modify the text direction inline
#9041: The caret can indicate (toggled by the toggle-text-direction-view action), if the caret is inside an element which has set RTL as direction attribute.

Changes

Third party library version updates.
Updated layout engine and built-in PDFreactor.

Additional Notes

Time Bomb

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

Release 5.0.6023_Beta1 (released 2023-07-26)

Features

#8942: It is now possible to disable copy & paste.
#8961: Add functionality to set the document text direction in the language dialog.
#8962: Added actions to set the paragraph level text direction. Also added the possibility to set the text direction for tables.

Bug fixes

#8943: RTL/Bidi: Numbers containing hyphens/dashes are now displayed in the correct direction.
#8945: RTL/Bidi: List markers now have the correct direction.
#8946: When pasting a table containing span elements between cells, no unexpected table structure is inserted.
#8949: RTL/Bidi: Content now has the correct direction in a list item with Bidi content.
#8992: Added "text-decoration-skip-ink: none" to our default style sheet. This causes underlines and overlines to be drawn across the full length of the text content, including parts that cross over glyph descenders and ascenders.
#8994: The text direction is now enforced on all parts of the document that have not explicitly set a direction.
#8995: Text alignment of RTL content pasted from Word is no longer wrong and can now be changed.
#8998: Extra characters are no longer inserted while pasting.
#9006: Caret no longer moves to the start of the document in split table cells.

Changes

Updated to Jetty 11.0.13
Third party library version updates.
Updated layout engine and built-in PDFreactor.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2023-10-31.

Release 4.6.5746_Beta1 (released 2023-03-21)

Features

#8875: The default font list can now be filtered (blacklist parameter excludedDefaultFonts).

Bug fixes

#8913: RTL/Bidi content is now correctly displayed when applying "justify" (and other formattings).

Changes

Updated to Java 17.0.6
Updated to Jetty 10.0.13
Third party library version updates.
Updated layout engine and built-in PDFreactor.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2023-08-31.

Release 4.5.5531_Beta3 (released 2022-10-28)

Bug fixes

#8823: Caret position is now determined correctly when typing in an RTL context inside parentheses.
#8824: Line break now occurs (again) at the end of a word when the line does not fit in its container.

Changes

Updated to Java 17.0.5
Updated to Jetty 10.0.12
Third party library version updates.
Updated layout engine and built-in PDFreactor.

Additional Notes

Time Bomb

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

4.5.5447_Beta2 (released 2022-09-01)

Features

#8722: Editing of documents containing RTL/BIDI sections is now possible.
#8757: Added management REST endpoint that only provides the editor count(s).

Bug fixes

#8730: Management service now works again with XML response type.

Changes

Third party library version updates.

Additional Notes

Time Bomb

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

Release 4.5.5290_Beta1 (released 2022-06-08)

Features

#8634: Display of documents containing RTL/BIDI sections is now possible.
Display of documents containing grid or flexible box layout sections is now possible.

Changes

Updated Jetty to version 10.0.9. Please note: The configuration files are now located in "/ro/jetty10/jetty-base/start.d/".
Updated layout engine and built-in PDFreactor.
Third party library version updates.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2022-10-31.

Release 4.4.5169_Beta4 (released 2022-04-04)

Features

#8617: It is now possible to add/remove a single API-key using the REST management API.

Changes

Updated layout engine and built-in PDFreactor.
Third party library version updates to mitigate CVE-2022-22965.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2022-08-31.

Release 4.4.4954_Beta3 (released 2021-12-10)

Changes

Updated layout engine and built-in PDFreactor to PDFreactor 11.4.2 release.

Additional Notes

Time Bomb

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

Release 4.4.4924_Beta2 (released 2021-11-19)

Features

#8529: Added callback which gets triggered on dialog open/close and passes information on dialog action (name of dialog, open, close including reason).
#8562: Added callbacks for mouse/keyboard interactivity (up/down/move, up/down), providing information on the specific event.

Bug fixes

#8541: Table rows can now be deleted if there is no valid caret position in certain cells.

Changes

Updated layout engine and built-in PDFreactor to PDFreactor 11.4.1 release.

Additional Notes

Time Bomb

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

Release 4.4.4845_Beta1 (released 2021-09-27)

Improvements

Improved debug logging output for specific scenarios.

Bug fixes

Resolved an issue which could occur when restoring an editor from disc hibernation and result in a non-removable editor session.

Changes

Updated layout engine and built-in PDFreactor to PDFreactor 11.4.0 release.
Updated Jetty to 9.4.43.v20210629.
Updated web service dependencies.

Additional Notes

Time Bomb

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

Release 4.3.4757_Beta1 (released 2021-08-10)

Bug fixes

#8459: Resolved an issue with loading specific documents.
#8460: Setting an admin key now requires an application server restart. This solves an issue with setting an admin key in a fresh installation.
#8477: Personal spellcheck dictionaries are now restored correctly from user preferences when waking an editor from disc hibernation.

Changes

Updated layout engine and built-in PDFreactor to PDFreactor 11.3.1 release.
Updated web service dependencies.

Additional Notes

Time Bomb

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

Release 4.2.4656_Beta2 (released 2021-05-31)

Changes

Updated layout engine and built-in PDFreactor to PDFreactor 11.2.2 release.
Updated Jetty to 9.4.41.v20210516.
Updated web service dependencies.

Additional Notes

Time Bomb

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

Release 4.2.4558_Beta1 (released 2021-03-30)

Features

#8157: Added new server parameter (customHeaders) which allows setting additional custom headers to be returned by the Nimbudocs server. The format is JSON: {"header1":"value1","header2":"value2", ...}.
#8336: It is now possible to specify different configurations for headers/footers and specific pages (default, first, left, right) for the header and footer editor instance.

Improvements

Improved logging output for internal editor lock/unlock.
Added system information log output (on level INFO, including CPU, garbage collection, Java internal heap, thread and opened editors information).

Bug fixes

#8128: Resolved an issue with inserting new rows in tables with incorrect column spans. This was already resolved in the 4.0 release but was not yet added to the change log.
#8192: Resolved an issue with formatting loss in specific line splitting scenarios (split after a <br/> surrounded by inline formatting).
#8330: The bookmark icon for empty link (<a>) elements with an id is now displayed again.
#8332: Resolved an issue that prevented the Retriever to work correctly.
Resolved memory issue caused by a rare condition with non-responding editors.

Changes

Updated layout engine and built-in PDFreactor to PDFreactor 11.2.1 release.
Updated Jetty to 9.4.38.v20210224.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2021-07-31.

Release 4.1.4509_Beta1 (released 2021-02-08)

Features

#8296: It is now possible to set the default paste mode by a configuration option.

Bug fixes

#8195: List numberings are no longer duplicated after pasting from Word.
#8196: Lists are no longer nested when pasting from Word
#8275: Fixed problem with custom font upload via the REST API/Webmin.
#8290: Setting the default language in the configuration options now works as expected.
#8292: Pasting from Chrome or Edge no longer inserts duplicate unstyled content.
#8295: Pasting from Word in Windows-Firefox no longer creates nested HTML structures.

Changes

#8291: Paste button behavior is now identical across all environments. The paste dialog will now also be shown in IE 11.
Updated layout engine and built-in PDFreactor to PDFreactor 11.1 release.
Updated Jetty to 9.4.36.v20210114.
Updated Java to 15.0.2.

Additional Notes

Time Bomb

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

Release 4.0.4487_beta2 (released 2020-12-16)

Changes

Updated layout engine and built-in PDFreactor to PDFreactor 11 release.

Additional Notes

Time Bomb

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

Release 4.0.4482_Beta1 (released 2020-11-17)

Bug fixes

#8212: Added a warning mechanism that the server will be restarted when uploading a license file.
#8237: Preventing an issue with the server startup in certain situations (e.g. no internet access).
#8247: Resolved issue with management interface not starting correctly when the management WAR file is loaded before the Nimbudocs Editor WAR.

Changes

Updated layout engine and built-in PDFreactor (upcoming version 11 release)
Updated Java to OpenJDK 15.0.1
Updated to Jetty 9.4.33.v20201020

Additional Notes

Time Bomb

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

Release 3.1.4460_Beta14 (released 2020-09-24)

Updated dependencies of the Nimbudocs Editor server to the latest versions to include various security updates. The updates include:

Updated Jetty from version 9.4.26 to 9.4.31.
Updated Apache CXF from version 3.2.6 to 3.4.0.
Updated Jackson from version 2.9.6 to 2.11.2.
Updated Spring from version 4.3.18 to 5.2.8.
Updated Java to OpenJDK 15.
Updated Nimbudocs Editor Docker base image dependency.

Bug fixes

#8106: The management interface is now available in the Docker image.
#8149: Resolved issue with the healthcheck endpoint in the management interface.

Additional Notes

Time Bomb

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

Release 3.1.4447_Beta13 (released 2020-07-14)

Bug fixes

#8129: Resolved permissions issue preventing the Nimbudocs Editor server from writing to Java temp directory when using the Release Appliance or the Beta Appliance. This solves issues with web fonts and images pasted from external sources.

Additional Notes

Time Bomb

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

Release 3.1.4445_Beta12 (released 2020-07-10)

Features

#8063: Added functionality that allows to transfer a server side session to a different browser/tab/window.
#8041: The handle UI interface now adapts to the zoom level.

Bug fixes

#8097: The appliance dictionaries (configured through the server parameter "applicationDictionaryDir") now use UTF-8 encoding. This resolves an issue were correction suggestions could be delivered to the client with incorrect encoding.
#8105: When the automatic spelling checker is enabled, spell check markers (wiggly lines) are now updated when learning or unlearning a word through the API.
#8082: Text lines no longer overlap under certain circumstances when typing rapidly in Chrome.
#8084: Resolved issue were the caret was moved to the end of the first line of a paragraph when inserting two consecutive spaces in Chrome.

Additional Notes

Time Bomb

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

Release 3.1.4427_Beta11 (released 2020-05-26)

Improvements

#8062: The Nimbudocs Editor main integration JavaScript file "nimbudocseditor.js" will now also set cache headers. This could require to set/increment a "cache killer" GET parameter for this file in integrations, when this file changes for newer versions of Nimbudocs Editor.

Bug Fixes

#8005: The state of toggle-show-semantic-elements is now preserved after hibernation.
#8006: Resolved issue which occurred when setting showSemanticElements to false.
#8031: URLs used in xhtml() function are now correctly resolved when using the Nimbudocs default document (template).
#8040: Shapes can be rotated again.
#8056: We now use a different java.io.tmpdir in our appliance to avoid JVM crashes.

Additional Notes

Time Bomb

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

Release 3.1.4388_Beta10 (released 2020-03-10)

Features

#7875: Added a page-mode-double-sided mode.

Improvements

#7943: It is now possible to display a Default entry in the font drop down.

Bug Fixes

#7988: The viewport of the header footer editor is now displayed correctly, if the main editor is in full screen mode.
#7990: Resolved issue which in rare case could lead to editors not being removed correctly.
#6999: Fixed error that could lead to an invalid editor when trying apply a paragraph format in a multi-column context.

Changes

#7965: Updated Jetty to 9.4.26

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2020-07-31.

Release 3.1.4341_Beta9 (released 2020-01-21)

Features

#7876: It is now possible to sort the font family list. Introduced new onfontfamilyupdate callback which receives an array containing a list of all available font families. This can be sorted and must be returned in the callback function.

Improvements

#7916: Improved overlay behavior when editor is restored from disc.
#7920: Improved reliability of the oncontentchange callback.

Bug Fixes

#7909: Resolved issue with scroll bars when using zoom below 100% in IE/Edge.
#7910: Resolved issue with unexpected width distribution in page margin boxes.
#7935: Improved detection when web fonts have to be proxied by Nimbudocs Editor.
#7936: Resolved issue with duplicate font proxying.
#7938: Resolved issue with justified text for certain font sizes.

Additional Notes

Time Bomb

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

Release 3.1.4325_Beta8 (released 2019-12-10)

Features

#6180: It is now possible to drag and drop content into the document from external sources. The Paste-Modes like plain-text, keep-fomatting and match-destination can be used for drag & drop as well. Please note: This feature is not supported in IE11 due to technical restrictions. Furthermore the following restriction applies on Windows:
- Drag & Drop from Chrome to Edge will insert a block of Chinese characters (all paste modes).
#7816: Added semantic elements actions. This allows to e.g. toggle strong, em and other semantic elements. Furthermore semantic elements will now be visualized/highlighted in the editor. This can be configured in the configuration options (showSemanticElements, defaults to true) or toggled by using the toggle-show-semantic-elements action.
#7895: Added a server configuration parameter (instanceName) whose value is set as custom response header for each request. Can be used to identify the node in a load balanced scenario.
#7890: Added configuration parameter externalAutoSaveConfigurationPath where the Nimbudocs Editor Server looks for the externalautosave.json file. This JSON file configures external auto save functionality, which is a feature that allows to save the document content to an external server at specific intervals (defined by the autoSaveInterval parameter), as well as when the user closes the editor. Please note: This is an experimental feature and subject to change.

Improvements

#7849: The character encoding declaration is now consistent in the default template.
#7873: The RPM Repo update links in the Virtual Appliance now use HTTPS.
#7884: Added documentation for the configPath server parameter.
#7887: Shortened the web-font prefix to avoid font-family name length issues in IE11.
#7888: Corrected localization of some multi-column actions.
#7889: Changed documentation of color-related actions and options.
#7892: The TTF variants of the core fonts Arimo, Tinos and Cousine are now installable.

Bug Fixes

#7846: The caret no longer jumps when typing in a table cell that spans multiple pages.
#7851: Resolved issue with the defaultDocumentTemplateUrl configuration option.
#7861: Table actions are now enabled when the table is inside a container (div).
#7866: Resolved issue with multi-column display.
#7891: The image properties dialog now correctly previews image from relative URL.
#7897: Resolved issue with tool bar drop down menus in IE11.
#7899: Resolved width unit issue in image properties dialog.
#7902: Resolved issue which could occur when default fonts are disabled and the document is closed.
#7912: Fonts from style sheets which are loaded through @import are correctly resolved now.
#7917: REST Asset CSS files are now returned with mime-type text/css.

Changes

The font for the default theme is now Arimo instead of Verdana.

Additional Notes

Time Bomb

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

Release 3.1.4253_Beta7 (released 2019-09-19)

Features

#7191: The form extension now provides support for radio button elements.

Bug Fixes

#7757: Check boxes surrounded by inline elements can now be clicked in Form Fill Out Mode
#7760: If the retriever is enabled the editor now loads properly if the defaultDocumentTemplateUrl option is specified
#7764: User preferences can now be set properly.
#7765: Resolved issue with contentchange event being thrown with every response from the server.
#7774: The ondocumentloaded event is no longer thrown for document manipulating API method calls.
#7793: Document containing only empty block can now be loaded.
#7814: Resolved issue which prevented the header/footer editor to open correctly.
#7826: Resolved issue with typing in Chrome.
#7832: Inline SVGs are now displayed correctly again.
#7836: Resolved platform compatibility (Windows) issue with font-path.

Changes

Updated to Java 12.0.1
Restructured/Redesigned Documentation
Changed time bomb date to 2020-01-31

Additional Notes

Time Bomb

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

Release 3.1.4195_Beta6 (released 2019-06-12)

Features

#7650: Added server configuration parameter useSystemFonts to allow the usage of system fonts in Nimbudocs Editor. It is still necessary to specify font face rules (with src: local()) for all fonts that should be available in Nimbudocs Editor.
#7651: Added configuration option passdownStyles for the headerFooterEditorConfiguration object. If set to true, all styles from the main editor will be passed to the header/footer editor.

Bug Fixes

#7707: Fixed issue with font loading in a scenario where the editor is loaded from different integration URLs in the same browser session.

Changes

Updated underlying MARTHA rendering engine and PDFreactor version.

Additional Notes

Time Bomb

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

Release 3.1.4190_Beta5 (released 2019-05-24)

Improvements

#7619: The maximum number of concurrent editors is now available in the Application/Server info (REST-API).

Bug Fixes

#7673: Resolved an issue where the server was not always notified when a client session was closed (i.e. closing the tab or browser or when navigating away from the editor), resulting in a non-closed editor session on the server.
#7695: Tool bar icons are now correctly displayed when using browser zoom in Chrome.
#7706: Resolved memory issue which could occur under certain circumstances.

Changes

Security Improvements (CVE IDs are registered for PDFreactor but also apply to Nimbudocs Editor)
- Enhanced security to protect against potentially malicious 3rd party content or configurations, especially regarding file system access and server side request forgery. Nimbudocs Editor only allows loading resources from public, private and local IP addresses or hosts, using file URLs is not allowed.
  CVE-2019-12153: by Sean Melia of Aon’s Cyber Solutions.
- Loading of XML external entities and other XML parser resources is now disabled.
  CVE-2019-12154: by Sean Melia of Aon’s Cyber Solutions.

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2019-07-31.

Release 3.1.4157_Beta4 (released 2019-04-12)

Features

#7579: Added "suggestionFilterListPath" server configuration parameter. This specifies the path to a file "suggestionFilterList" which can contain linebreak separated words, which should be omitted from the suggestion list of misspelled words.

Improvements

#7613: Added metrical identical fonts Carlito (for Calibri) and Caladea (for Cambria) to the default fonts.

Bug Fixes

#7665: Fixed issue with removing hibernated sessions under specific circumstances.
#7658: Editor can now be restored from memory hibernation again.
#7656: Editor can not reliably be restored from disc hibernation under specific circumstances (scrolling while hibernated).
#7585, #7586, #7587: Fixed various issues with Auto Correct.

Changes

Changed time bomb date to 2019-07-31

Additional Notes

Time Bomb

This version of the Nimbudocs Editor Beta will cease to function on 2019-07-31.

Release 3.1.4149_Beta3 (released 2019-01-31)

Changes

Changed time bomb date to 2019-05-31

Additional Notes

Time Bomb

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

Release 3.1.3145_Beta2 (released 2018-12-19)

Bug Fixes

#7532: When using a non-italic font, synthetic italic is applied again when converting a document to PDF.
#7531: Empty inline elements no longer prevent their parents from collapsing through.
#7110: The dimensions of multi-page collapsed tables with varying border widths are now determined correctly.

Release 3.1.4143_Beta1 (released 2018-12-13)

Changes

Updated layout engine and built-in PDFreactor to version 10.
Updated to Java 11.0.1
Deprecated support of Internet Explorer 11.

Release 3.0.4130_Beta8 (released 2018-11-22)

Features

#7439: It is now possible to restore an auto saved editor instance, when starting a new editor on the client. This is possible by using the REST API and the restoreAutosave option. With the REST API it is possible to move an auto save state from one server to the other, the restoreAutosave option allows to restore from the auto save state with a given document and user ID.

Improvements

#7460: The promise returned by calling invokeAction on a custom JavaScript action can now be resolved within the invokeListener of the custom action. See the example below:


                    var testAction = editor.getAction("test-action");
if (testAction !== null) {
    testAction.addInvokeListener(function(e) {
        
        var p1 = editor.fetchBodyFragment();
        var p2 = editor.fetchNumberOfCharacters();
        
        jQuery.when(p1,p2).then(function(valp1, valp2) {
            
            var str = "<html>"+valp1 + "<p>Original document contained "+valp2+ " characters</p></html>";
            editor.loadDocument(str).then(function(ld){
                e.deferred.resolve("Ready");
            });
        });
        e.preventDefault();
    });
}

Please note that it is necessary to call e.preventDefault() so that the promise e.deferred is available.

Bug Fixes

#7463: PDFs generated within Nimbudocs Editor now include the correct fonts again.
#7493: Resolved issue with restoring the editor from (disc) hibernation.
Resolved memory issue when consecutively hibernating(disc)/restoring the editor.

Changes

The following methods can now be used asynchronously (they return a promise which is resolved when the method is completed):
- setWidth
- setheight
- toggleMaximize
- toggleFullscreen
- toggleSidebar
- addDocumentStyleSheet
- addEditorStyleSheet
- addAuthorStyleSheet
- clearDocumentStyleSheets
- clearEditorStyleSheets
- clearAuthorStyleSheets
- removeDocumentStyleSheet
- removeEditorStyleSheet
- removeAuthorStyleSheet
- setDocumentBaseUrl
- setDocumentName
- setBlockElementAttributes
- setCurrentElementContent
- setElementAttributes
- setParentElementByNameAttributes
- setParentElementByNameContent
- setElementListAttributes
- setElementListStyles
- removeParentElementByNameAttributes
- insertContent
- insertContentFromUrl
- setHeadElementContent
- setIgnoreReadOnly
- loadDocumentFromUrl
- loadDocumentXsltFromUrl
- loadDocumentXsltFromContent
- loadDocument
- importLegacyDocumentFromUrl
- importLegacyDocument
- setBodyFragment
- moveCaretToDocumentEnd
- moveCaretToDocumentStart
- moveCaretToNextBlock
- moveCaretToNextPage
- moveCaretToPreviousBlock
- moveCaretToPreviousPage
- moveToBookmark
- moveToNextBookmark
- moveToPreviousBookmark
- removeCurrentTableColumnCellAttributes
- removeCurrentTableRowCellAttributes
- setContentChanged
- setCurrentTableColumnCellAttributes
- setCurrentTableRowCellAttributes
- setSelectedColumnsCellAttributes
- setSelectedRowsCellAttributes
- setSelectionColor
- lock
- unlock
- setHideOverlayFlag
- requestFocus
- setPasteHandler
- setPageProperties
- updateUIConfig
- endComparison
- spellChecker.learnWord
- spellChecker.unlearnWord
- spellChecker.setDictionary
- spellChecker.ignoreWord
- spellChecker.ignoreAllWords
- spellChecker.changeWord
- spellChecker.changeAllWords
- compareDocumentsFromUrl
- compareDocumentsFromContent
- compareDocumentFromContentToEditorContent
- isComparisonMode
- endComparison
spellChecker.getDictionary was renamed to spellChecker.fetchDictionary.

Release 3.0.4099_Beta7 (released 2018-10-11)

Bug Fixes

#7366: Refined resolution of issues which could occur when waking up the editor from hibernation through API calls.
#7438: IE 11: Dropdowns in a dialog are usable again when having a selection in a table.

Changes

The hibernateEditor method now returns a promise that will be resolved as soon as the server is hibernated.The promise will be rejected when calling hibernateEditor() while the editor is already hibernated or the editor is restoring from hibernation. It is not required to use the promise, as API calls invoked directly after "hibernateEditor()" (programmatically or by user interaction), will be queued to execute after hibernation has completed. Nevertheless it is recommended and good practice to use the promise, as instantly calling an API method will lead to the situation that the editor is restored as soon as the promise is resolved due to the queued API call.

Release 3.0.4086_Beta6 (released 2018-09-13)

Features

#7331: Words can now be stored persistently on the server if the applicationDictionaryDir server parameter is configured. Words need to be learned through learnWord with persistence level application or through the spellcheck-add-word-application action to be learned persistently. Also added appropriate new REST API methods for Management Interface.
#7360: It is now possible to define a document (defaultDocumentTemplate(Url)), which should be loaded by default when starting the editor or invoking the new-document action.

Bug Fixes

#6574: Refined solution for preventing superfluous line breaks when copying from IE.
#7314: Resolved CORS issue for fonts.
#7332: The dictionaryChange event now provides information about the word that was learned or unlearned.
#7366: Resolved issues which could occur when waking up the editor from hibernation through API calls.

Additional Notes

Time Bomb

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

Release 3.0.4062_Beta5 (released 2018-07-03)

Bug Fixes

#7271: Caret no longer jumps randomly when typing in a very long justified paragraph

Changes

The Nimbudocs Editor Management REST service now runs on a different port and (base) URL: http://yournimbudocsserver:9424/management/. As the Management Service is installed through a separate (yum) installation package, we recommend to redeploy the entire Virtual Appliance. In case you want to update your existing appliance, use the update mechanism as before, then login via SSH to the Nimbudocs Editor server and issue the following command: yum install nimbudocs-management-service. Without an installed Management Service, the Webmin administration interface will not function correctly.

Additional Notes

Time Bomb

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

Release 3.0.4001_Beta4 (released 2018-04-03)

Features

#7157: Added new tool bar UI element: Drop down icon.
#7205: Added API method to explicitly hibernate the editor (optional remove also from memory as soon as possible).

Improvements

#7131: Improved support for CMYK JPEG images.
#7172: It is now possible to configure the location of the cloud status icon.
#7204: It is now possible to configure a default language for the spell checker.
#7214: It can now be configured via CSS if typing between read-only elements is allowed. Two new CSS properties were implemented for this purpose: -ro-prevent-insertions-before and -ro-prevent-insertions-after. Please see the CSS Property Documentation for details.
#7239: It is now possible to load/specify a license key by URL (Configuration parameter licenseKeyUrl).

Bug Fixes

#7176: Shorthand properties for page size are now correctly applied to page properties dialog.
#7186: The focus is now correctly returned to the editor when calling paste-browser in a context in which it is prohibited.
#7203: It is now possible again to set the language to British Medical when auto spell check is active.
#7213: Fixed an issue where placing the caret and typing in a read-only section caused the caret to move to the left and insert content once it reached an editable element.
#7223: Improved reliability of typing preview, when using the arrow keys and typing very fast.

Changes

Updated Jetty to 9.4.8
Updated Java to 1.8.0_162

Additional Notes

Time Bomb

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

Release 3.0.3981_Beta3 (released 2018-01-16)

Features

#7144: It is now possible to enable or disable pre-loading of fonts with the new configuration option fontSettings.preloadFonts

Improvements

#7116: Improved indentation behavior for list elements when using the ruler.
#7135: Improved error handling/logging when trying to use a comparison API method without a comparison license.

Bug Fixes

#7118: Additional improvements for "Typing over fully or partially selected content with an inline format no longer removes this inline format".
#7137: The Auto Correct dialog can now be closed correctly.
#7139: Documentation improvement for the insertContent method, which was incorrectly documented as asynchronous.

Changes

Deprecated the disableDefaultFonts configuration option. Instead we have a new fontSettings configuration option object, with disableDefaultFonts and preloadFonts (see feature #7144) as child configuration options.
The onrecover callback now receives an array of recoverObjects as argument instead of a single recoverObject.

Additional Notes

Time Bomb

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

Release 3.0.3966_Beta2 (released 2017-12-19)

Improvements

#7126: The PDF/Print dialog now has additional configuration options.
#7120: The callbacks which are customizable by the integrator (e.g. onready, onsessionlimitreached) now have improved error handling.

Bug Fixes

#7103: It is possible to enable/disable the maintenance mode again.
#7118: Typing over fully or partially selected content with an inline format no longer removes this inline format.
#7119: It is now possible to use data URIs as background image.
#7133: When an image cache is configured on Windows, URLs serialized for background images no longer include back slashes.
#7123: New pages are now correctly displayed when content overflows a named page.

Additional Notes

Time Bomb

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

Release 3.0.3929_Beta1 (released 2017-11-17)

Features

#7010: It is now possible to configure which options are available in the search & replace dialog.
#7046: It is now possible to specify style sheets and a document to be loaded as part of the option object.

Improvements

#7022: Added a server health check method to the REST service.

Bug Fixes

#7040: Server parameter 'customFontContextPath' now also works on Windows.
#7087: Fixed typing issue when quickly typing after deleting selection.

Changes

Internet Explorer 10 is no longer supported.
Removed deprecated options and methods:
Options:
- hideSingleTabs
- hideToolbarPanelDescription
Methods:
- addUserAgentStyles
- addUserAgentStylesFromUrl
- addUserStyles
- addUserStylesFromUrl
- addEmbeddedStyles
- removeEmbeddedStyles
- setEmbeddedStyles
- clearUserStyles
- clearUserAgentStyles
- removeUserAgentStyleSheet
- removeUserStyleSheet
- hasContentChanged
- fetchEmbeddedStyles
Removed server parameters: customFontContextPath, fontCacheContextPath and imageCacheContextPath. All those resources are now delivered by the Nimbudocs Editor REST API. It is still required to configure the customFontFilePath if you want to use custom fonts.
Custom fonts which should be installed on the server can now only be added through the new REST API. Uploading/Managing them through Webmin is no longer possible. Please note that custom fonts can also easily be added to your Nimbudocs Editor integration by creating a CSS containing font face rules for your existing web fonts. This style sheet just has to be loaded by one of the style sheet API methods and the fonts will automatically be available in the editor.
Changed the REST "base" URL from "/service/" to "/rest/", so the end points are now: /rest/assets/ (which is now again compatible with previous versions) and /rest/manage/.

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

Changes apply only to the Nimbudocs Editor appliance:
- Removed RealObjects internal network configuration settings.
- Changed the keyboard layout from German to US.
- The boot menu is no longer displayed.

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

#5586: Added support for thead / tfoot (repeating headers / footers) in the "Insert Table" and "Table Properties" dialog.
#6604: The CSS property word-spacing is now supported.
#6661: It is now supported to resize table columns defined with "col" elements.
#6926: It is now possible to leave the comparison mode through the API. The accept/reject-all-diff actions now terminate the comparison mode. Added endComparisonMode API method which accepts all differences and ends the comparison mode by default. The method has an optional boolean argument which rejects all differences instead when the argument is set to true.
#6950: Improved Cut / Copy / Paste buttons in IE, Edge and Chrome. The behavior is now as follows:
- IE11: cut, copy and paste fully supported.
- Chrome: cut and copy supported, paste will trigger paste dialog.
- Edge: cut and copy supported, paste will trigger paste dialog.
- Firefox: cut, copy and paste still trigger dialogs.
Added actions and UI to enable multi column editing (experimental).

Improvements

#6970: A list of default shortcuts is now part of the action reference tutorial.
Web Fonts with absolute http(s) URLs, which do not set appropriate CORS header will now be cached and delivered by the Nimbudocs Server. This improves web font handling in general.
#6997: Added metrically compatible fonts for Arial, Times New Roman and Courier New to the font drop down in Nimbudocs Editor. Those fonts were already included as base/core fonts and originate from the "Croscore fonts collection", which is also the base for the "Liberation" font package. The fonts added are the following:
- Arimo (corresponds to Arial and Liberation Sans)
- Tinos (corresponds to Times New Roman and Liberation Serif)
- Cousine (corresponds to Courier New and Liberation Mono)

Bug Fixes

#6907: Styles set as user agent styles with -ro-priority: -1 are now correctly applied in page margin boxes using the xhtml() function.
#6915: Resolved typing issue after style selection in context menu in IE and Edge.
#6931: It is now possible to select a column spanning multiple rows.
#6957: Editor can now be hibernated/removed correctly if there is an exception while retrieving caret information.

Changes

IMPORTANT: The Virtual Appliance is now based on CentOS 7. Existing Nimbudocs Editor appliances based on CentOS 5 can't be upgraded to the new appliance version, you need to redeploy and configure the new CentOS 7 appliance. Nimbudocs Editor packages and their dependencies can still be updated on CentOS 5 based appliances, but we strongly recommend that you reinstall the CentOS 7 appliance, since CentOS 5 has been EOL since the end of March 2017.
The server configuration parameter allowedCrossOriginHosts has been renamed to allowedCrossOrigins. A comma separated list of allowed cross origin locations (host including protocol, e.g.: http://my.integration.host) has to be specified.
Updated Java to 1.8.0_144.

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

#6862: Improved display of Korean text by using a better fall back font for CJK.
#6832: It is now possible to configure the domains allowed for CORS requests. Added new "allowedCrossOriginHosts" configuration parameter which allows the user to specify a comma separated list of allowed cross origin hosts.
#6739: Added method that returns if the document has tracked changes.

Improvements

#6737: Added documentation for Track Changes functionality.
#6704: When the Retriever is used, an authentication dialog is now displayed when trying to access resources protected by Basic authentication for the first time.
#6629: Improved CSS property documentation.
Added a "HealthChecker" mechanism which periodically checks for "hanging editors" and terminates those editors if necessary. If an editor is terminated, important diagnostic information is written to a file on disc (if possible, otherwise it is logged in the server log file).
Improved server side logging.

Bug Fixes

#6899: Certain character sequences in style attributes no longer cause exceptions.
#6882: Now preventing endless loop in layout process.
#6878: The line connecting deleted content with the appropriate bubble is now correctly displayed in table cells.
#6873: The caret no longer jumps when typing in the first cell (which spans multiple pages) of a table.
#6844: Table handles for tables split across two (or more) pages are now correctly displayed.
#6843: It is now possible to search for two consecutive blank spaces using the "Find / Replace" dialog.
#6779: The "service/assets/main.css" resource now includes the page counter styles from the header/footer editor.
#6774: Check boxes can now be checked again.
#6744: Selection no longer jumps to the start of the document in certain cases.
#6731: Inserting a page break while the caret is in (before) a page break now works correctly.
#6718: Tool tip bubbles displayed for annotations or tracked changes no longer display control characters.
#6684: The page no longer scrolls to the caret position after checking a check box.
#6776: The clearUserAgentStyles method no longer removes track changes bubble styles.
#6574: Copied editor content from Internet Explorer is no longer surrounded by line breaks.

Changes

#6697: The new blue Webmin theme is now supported and the default theme.
The "Administrative GET requests" were removed and replaced by an official REST management API (see REST tutorial).
The fetchAnnotationCount() and fetchChangesCount() methods now return an integer instead of a string (as it was already correctly described in the documentation before).
The page properties mirror property is now a boolean instead of a string.
The fetchCurrentTableColumnCellAttributes/setCurrentTableColumnCellAttributes and fetchCurrentTableRowCellAttributessetCurrentTableRowCellAttributes now return/expect an array of attribute objects.
Updated Java to 1.8.0_131.
Updated Jetty to 9.4.5; the logging module has been renamed to console-capture. If you have modified/customized your start.ini you have to adapt all occurrences in this file, e.g.: --module=logging jetty.logging.append=true has to be replaced with --module=console-capture jetty.console-capture.append=true

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

#6692: The clear-formatting action now removes font tags.

Bug Fixes

#6683: Locale extensions are now correctly loaded and displayed
#6690: Resolved issue with the start at input in the list properties dialog.
#6691: Resolved issue when typing over a selection.
#6694: Implemented workaround for an issue in Internet Explorer that could cause a JavaScript error when trying to set a selection range.

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

#6646: It is now possible to use non-numerical characters in the list properties dialog, when setting the "start at" value of ordered lists. When changing the list type, the start value in the text field will be automatically converted to the new list type format.

Bug Fixes

#6644: The "Compare View" buttons are now correctly toggled.
#6647: Actions specified in an action map extension are no longer overwritten by actions loaded from modules.
#6648: The remove() API method now works as intended.
#6649: Scrolling by clicking into the scrollbar now functions properly in Internet Explorer.
#6655: Fixed JavaScript error when clicking the "Paste" button in Internet Explorer.
#6670: Resolved visual discrepancy between the outputs in the editor, preview images and PDFs, when using CSS "letter-spacing".

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

#6526: Added support for the CSS property transform-origin.
#6596: Improved error handling/logging when empty/undefined/null arguments (of API methods or actions) are sent to the server.

Bug Fixes

#6574: Copied editor content from Internet Explorer is no longer surrounded by line breaks.
#6611: Fixed issue with pasting plain text in Windows Chrome / Firefox
#6618: Fixed issue with list context inside td elements.
#6632: The apiKey set in the editor's config object is now also passed through to the header/footer editor.
#6634: It is now possible again to edit the right page footer.
#6639: Editor no longer causes high CPU load due to endless iterations under specific circumstances.
#6641: Tooltips no longer are permanently displayed in certain situations.

Changes

Changed default icon set. The previous icon set can be used by setting iconRepositoryUrl to http://$SERVERURL/client/nimbuEditor/images/editoricons-legacy/ or spriteIconCssUrl to http://$SERVERURL/client/nimbuEditor/images/editoricons-legacy/sprite/spriteicons.css.
When no license key is set the server now runs in an evaluation mode which allows 3 concurrent sessions and displays evaluation notices in the editor.
Server configuration should no longer be made in the nimbueditor.xml (/ro/jetty9/webapps) context file, but in the nimbudocseditorserver.config configuration file in /ro/nimbudocs/config. See also the Server Configuration guide. If you have a nimbueditor.xml.rpmnew after the update, please make sure to transfer the configuration settings from your modified nimbueditor.xml to the new configuration file and replace your old nimbueditor.xml file with the .rpmnew file afterwards.
Updated Java to 1.8.0_112
Updated Jetty to 9.3.14

Additional Notes

Time Bomb

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

System Requirements

Browser Support

The following browsers are supported:

Edge
Chrome 70+
Firefox 63+
Safari (OS X only) 12+
IE 11+^*

^* Support for IE 11 is deprecated and it is not recommended to use Nimbudocs Editor in IE 11 as there might be issues with Nimbudocs Editor which only occur in IE 11.

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*
Cookies
CSS 3
- @font-face
- rgba()
- calc()

* 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.

CSS 3 2D Transforms (for zoom functionality)
HTML5 APIs
- File
- Local Storage
- Fullscreen

Server Minimum Hardware Requirements

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

2 GHz Single Core or 1.5 GHz Dual Core CPU
4 GB RAM

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.

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

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:

Latest Oracle JRE 7 or 8 (JRE 8 is required if the pre-configured Jetty Application Server is used).

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

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

RealObjects Nimbudocs Editor Readme

Documentation

ReadMe

API Documentation & Guides

Release 5.0.6422_Beta6 (released 2024-02-27)

Bug Fixes

Changes

Additional Notes

Time Bomb

Release 5.0.6313_Beta5 (released 2024-02-27)

Features

Bug Fixes

Changes

Additional Notes

Time Bomb

Release 5.0.6235_Beta4 (released 2023-11-27)

Improvements

Bug Fixes

Additional Notes

Time Bomb

Release 5.0.6176_Beta3 (released2023-10-23)

Features

Improvements

Bug fixes

Changes

Additional Notes

Time Bomb

Release 5.0.6125_Beta2 (released 2023-09-21)

Features

Changes

Additional Notes

Time Bomb

Release 5.0.6023_Beta1 (released 2023-07-26)

Features

Improvements

Bug fixes

Changes

Additional Notes

Time Bomb

Release 5.0.6125_Beta2 (released 2023-09-21)

Features

Changes

Additional Notes

Time Bomb

Release 5.0.6023_Beta1 (released 2023-07-26)

Features

Bug fixes

Changes

Additional Notes

Time Bomb

Release 4.6.5746_Beta1 (released 2023-03-21)

Features

Bug fixes

Changes

Additional Notes

Time Bomb

Release 4.5.5531_Beta3 (released 2022-10-28)

Bug fixes

Changes

Additional Notes

Time Bomb

4.5.5447_Beta2 (released 2022-09-01)

Features

Bug fixes

Changes

Additional Notes

Time Bomb

Release 4.5.5290_Beta1 (released 2022-06-08)

Features

Changes

Additional Notes

Time Bomb

Release 4.4.5169_Beta4 (released 2022-04-04)

Features

Changes

Additional Notes

Time Bomb

Release 4.4.4954_Beta3 (released 2021-12-10)

Changes

Additional Notes