yboussard / collective.ckeditor Goto Github PK

This addon is a ckeditor integration for Plone.

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

Please use CKeditor for Plone > 3.

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

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

• Plone >= 3
• collective.plonefinder

Go to ZMi-->portal_setup-->Upgrades, choose "collective.ckeditor:default" profile and execute the upgrade steps.

Release 4.3.0 comes with the Enhanced Image plugin (image2). It is not enabled by default as it removes some of the advanced functionality provided by the default image plugin (image). However, the Enhanced Image plugin provides the ability to add a caption together with the image. It is also much more user-friendly.

To enable the plugin, you need to setup ckeditor_properties through generic setup propertiestool.xml:

<?xml version="1.0"?>
<object name="portal_properties" meta_type="Plone Properties Tool">
 <object name="ckeditor_properties" meta_type="Plone Property Sheet">
  <property name="removePlugins" type="lines">
   <element value="image"/>
  </property>
  <property name="plugins" type="lines">
   <element value="ajaxsave;/++resource++cke_ajaxsave/plugin.js"/>
   <element value="image2;/++resource++ckeditor/plugins/image2/plugin.js"/>
  </property>
 </object>
</object>

This disables the image (default) plugin and enables the image2 plugin.

The image2 plugin comes with two specific settings (configurable only through generic setup):

<?xml version="1.0"?>
<object name="portal_properties" meta_type="Plone Properties Tool">
 <object name="ckeditor_properties" meta_type="Plone Property Sheet">
  <property name="image2_captionedClass" type="string">image</property>
  <property name="image2_alignClasses" type="lines">
   <element value="image-left"/>
   <element value=""/>
   <element value="image-right"/>
  </property>
 </object>
</object>

The settings are image2_captionedClass and image2_alignClasses. The values above are the default values.

If you enable the plugin, you also need to setup Plone to accept the figcaption tag.

This is done by configuring HTML filtering with a setup handler like:

def enable_figcaption(p):
    """ Allow figcaption as valid tag in portal_transforms safe_html"""

    from Products.PortalTransforms.Transform import make_config_persistent

    pt = getToolByName(p, 'portal_transforms')
    tid = 'safe_html'
    if not tid in pt.objectIds():
        return
    trans = pt[tid]
    tconfig = trans._config

    validtags = tconfig['valid_tags']
    validtags.update({'figcaption': 1})

    make_config_persistent(tconfig)
    trans._p_changed = True
    trans.reload()
    log.info('added figcaption as valid tag')

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/

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.

Valid for CKEditor 4

1. Go to http://ckeditor.com/builder

2. Choose preset Full

3. Do not modify included plugins.

4. Select skin Moono color

5. Click Add all link beside Languages to choose label

6. Agree with the terms ;-)

7. Download CKEditor

8. Unzip archive

9. Replace all content of src/collective/ckeditor/_src/ckeditor directory with the contents of ckeditor 4 directory from the archive.

10. Download and install image2 plugin and its dependencies in src/collective/ckeditor/_src/ckeditor/plugins directory. In June 2014, they are found at:

    • http://ckeditor.com/addon/image2
    • http://ckeditor.com/addon/widget
    • http://ckeditor.com/addon/lineutils

11. Run bin/copy_ckeditor_code

12. Test

• Makina Corpus
• Ecreall
• BubbleNet
• Hexagonit

• Kai Lautaportti <[email protected]>
• Giacomo Spettoli <[email protected]>
• Godefroid Chapelle <[email protected]>
• Mathieu Le Marec - Pasquet <[email protected]>
• Jean-Mat Grimaldi <[email protected]>
• Michael Smith <[email protected]>
• Victor Fernandez de Alba <[email protected]>
• Kim Paulissen <[email protected]>
• Jean-Michel FRANCOIS aka toutpt <[email protected]>
• Gauthier Bastien <[email protected]>