Export to Word - overview
CKEditor Cloud Services offers a fast and highly scalable service enabling the user to export documents to a Microsoft Word
.docx file. The feature is available as a service, making it possible to send an HTML string straight into the Cloud Services server for more advanced use or as a convenient CKEditor 5 WYSIWYG editor plugin for the ease of use in less demanding cases.
If this feature is used without authentication, the resulting document will be watermarked.
# Pagination feature
The complementary premium pagination feature for CKEditor 5 allows you to see where page breaks would be after the document is exported to Word. Thanks to the live preview, the user is able to fine-tune the structure of the output document when editing it. In addition to this, the pagination feature shows you the page count and allows to easily navigate between the document pages.
# How the Export to Word feature works
The HTML to DOCX converter provides an API for converting HTML documents to Microsoft Word
.docx files. The service generates a Word file and returns it to the user so they can save it in the
.docx format on their disk. To integrate the feature into your environment, first check the Quick start guide to start using it.
You can also test the feature using the export to Word demo page.
# The HTML to DOCX converter options
The following options are available, while using the converter service:
HTML compliant content can be sent to the converter.
The API only accepts documents with UTF-8 encoded content for conversion.
If you cannot use UTF-8 and would like to request support for other charsets, please contact us.
This option parses the CSS used to style the output content of the document. There is a set of supported styles that may be applied to certain HTML tags. To check out which of these are currently supported, please refer to the CSS section of the HTML to DOCX Converter API holding the most up-to-date list.
The global CSS selector (
*) is also supported, which allows applying styles for all supported elements.
The styles listed can be applied inline directly in the HTML but it is recommended to add these via the
options configuration allows adding headers and footers to the generated document and integrating collaboration features. It provides the following options:
header- Allows adding various headers to the generated Word document.
footer- Allows adding various footers to the generated Word document.
comments- Provides comments for the document.
suggestions- Provides suggestions for the document.
You can learn more about using options in the converter documentation.
# The Export to Word plugin
The Export to Word CKEditor plugin allows you to easily print the WYSIWYG editor content to a
.docx file. When enabled, this feature sends the content of your editor together with the styles that are used to display it to the CKEditor Cloud Services HTML to Word converter service. The service then generates a Word document that the user can download.
Thanks to this plugin, it takes exactly one button click to get a
.docx file with content formatted the same way as in the CKEditor 5 WYSIWYG editor. An easy solution for integrations, that does not demand editor data to be processed further once it is edited.
# Stored data
The Export to Word service is a service that generates
.docx files based on the data provided by the customer (HTML, CSS). To perform the conversion, it requires the data sent from the editor or a database, but the service itself is fully stateless.
The data (especially your sensitive data: HTML, CSS, comments, suggestions) is used only during the processing. However, we store some information needed for billing and maintaining our system. We try to reduce stored data to a required minimum and at this moment we store such information as the number and duration of exports, the final document size, the number of unique exports, statistical data (used features, IP addresses, editor versions).
All logs related to processing requests are saved only in case of unexpected situations and are stored for 14 days. The data in logs includes an error message, stack trace and information about the request.