Pagination - quick start
The aim of this article is to get you up and running with CKEditor 5 pagination in your CKEditor Premium Features free trial.
Follow the steps below:
- Subscribe to the CKEditor Premium Features 30-day free trial.
- Generate your license key in the CKEditor Ecosystem customer dashboard.
- Configure CKEditor 5.
# Subscribe to the CKEditor Premium Features free trial
Create an account by signing up to CKEditor Premium Features free trial. After signing up, you will receive access to the customer dashboard (CKEditor Ecosystem dashboard).
You will be asked to check the features you are most interested in.
Checking these features does not affect the trial bundle contents — all the features will be available regardless of the choice. We just want to know your needs better.
# Log in to the CKEditor Ecosystem dashboard
Log in to the CKEditor Ecosystem dashboard. You will receive a confirmation email and will be asked to create a password for your account. Keep it safe.
# Account dashboard
After logging in, click “CKEditor” under the “Your products” header on the left. You will see the subscription parameters overview together with the management area below.
# Generate the license key
Once you enter the management console for track changes, comments and pagination, you have access to the license key needed to run the features. Note that the same license key will be valid for all three features.
# Intergrating the pagination feature with CKEditor 5
To install the plugin into your WYSIWYG editor, use the online builder to generate a custom CKEditor 5 build with the plugin enabled. Alternatively, refer to the installation guide in the plugin documentation to do it on your own.
To set up the feature, you need to add the license key in your CKEditor 5 configuration as described in the installation guide.
Apart from setting the license key, the configuration of this feature in the editor is the key to allow pagination to measure where the page breaks would be and to produce a 1:1 result with the export to PDF or Word features. Refer to the configuration section of the Pagination feature guide for more information.
# Compatibility issues
Currently the pagination feature works best with the following web browsers:
- latest Edge
- latest Opera
Manual page breaks do not work in Firefox as of yet, and there are some glitches in Safari. For the time being, until the feature is fully ready for all browsers, it disables itself in the unsupported ones. We are planning to work on this soon — do not hesitate to contact us if you need this.
# Enabling pagination in unsupported browsers
If you want to enable the pagination feature on unsupported browsers anyway, you can set the
config.pagination.enableOnUnsupportedBrowsers configuration option to
true or enable it at the runtime by calling
editor.plugins.get( 'Pagination' ).clearForceDisabled( 'browserCheck' ).