Skip to content

Latest commit

 

History

History
102 lines (70 loc) · 3.06 KB

README.rst

File metadata and controls

102 lines (70 loc) · 3.06 KB
Raw

Introduction

This addon is a ckeditor integration for Plone.

Contents

How to install

You can install it as any Plone addon. Please follow official documentation.

Please use CKeditor for Plone > 4.

The code source can be found at https://github.com/collective/collective.ckeditor

Please report issues at https://github.com/collective/collective.ckeditor/issues

Dependencies

Upgrades

If you come from collective.ckeditor < 3.6.12, you will have to launch an upgrade step to 3612. Go to ZMi-->portal_setup-->Upgrades, choose "collective.ckeditor:default" profile and execute the upgrade step to 3612.

Development

Attention!

ConfigurationError

If you try to run a Zope/Plone instance with a collective.ckeditor checkout, your instance will break with a ConfigurationError:

Directory .../browser/ckeditor does not exist.

After checking out collective.ckeditor sources, run the included buildout.

This installs and runs the copy_ckeditor_code script. It takes care of copying ckeditor code in the appropriate browser/ckeditor directory.

The browser/ckeditor directory makes ckeditor javascript code available to the browser at:

http://yourplonesite/++resource++ckeditor/
https://secure.travis-ci.org/collective/collective.ckeditor.png

How to Release

Obviously, the ckeditor code also needs to be included in the released eggs.

collective.ckeditor registers an entry point for zest.releaser that (if called properly) takes care of copying the code when preparing the release.

However, in order to take advantage of the entry point, you have to use the bin/fullrelease locally installed by the development buildout instead of a globally installed fullrelease.

Only the local bin/fullrelease script can see the entry_point registered by collective.ckeditor.

Credits

Companies

Contributors