Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
JavaScript Python CSS Other

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
collective
docs
.gitignore
MANIFEST.in
README.rst
bootstrap.py
buildout.cfg
setup.py

README.rst

Introduction

This addon is a ckeditor integration for Plone.

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

Development

After checking out sources, run the included buildout.

This installs copy_ckeditor_code script. This script 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/

You need to run bin/copy_ckeditor_code prior to run any Zope/Plone instance with your development collective.ckeditor. Anyway, if you forget, your instance will break with a ConfigurationError:

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

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

Something went wrong with that request. Please try again.