Ckeditor 4.1 ACF

There's a new 'settings form callback' property in the editor definition which can be used to customize the profile form from within the module implementing the editor integration (Wysiwyg itself in this case). It works just like hook_form_alter() and is already in use to customize some of the CKEditor-specific things on the profile form.

It should be fairly easy to extend the profile form when CKEditor 4 is detected so this setting can be cuztomized (both allowing the "TRUE" value and a list of tags/attributes), if anyone feels up to it.

Is there no way for the user to specify CKEDITOR.config.allowedContent = true via the UI, like the custom flags the ckeditor allows the admin to add?

@marktheshark Currently, no. That's what I hope will come out of this issue.

For the record, I followed approach #1. The module code in the original post did not prevent classes from getting stripped from my p tags, for some reason.

Seems to be related to #1951964: Media Button in WYSIWYG CKEditor 4.1+ broken

I have the same issue marktheshark does. CKEditor still doesn't like the classes in my <p> tags.

I just created a module with this code (in case it helps):

function ckeditor_acf_wysiwyg_editor_settings_alter(&$settings, &$context) {
  if($context['profile']->editor == 'ckeditor') {
    $settings['allowedContent'] = true;
  }
}

Critical feature request?

Marking critical since it was stated as release blocker in #1953106: Roll 7.x-2.3 release of Wysiwyg.

Here's a patch that follows the instructions in summary. I've tested and it works to my understanding of how ACF works. I'd like feedback on the help text that should go on the new form elements.

I added two fields to the Cleanup and output section. The allowed content field is only shown when Automatic or Custom are selected.

+++ b/editors/ckeditor.incundefined
@@ -138,6 +142,24 @@ function wysiwyg_ckeditor_settings_form(&$form, &$form_state) {
+    $form['output']['acf_mode']['#title'] = t('Advanced Content Filter');

ucfirst only.

+++ b/editors/ckeditor.incundefined
@@ -138,6 +142,24 @@ function wysiwyg_ckeditor_settings_form(&$form, &$form_state) {
+    $form['output']['acf_mode']['#options'] = array(CKEDITOR_ACF_AUTOMATIC => 'Automatic', CKEDITOR_ACF_CUSTOM => 'Custom', CKEDITOR_ACF_DISABLED => 'Disabled');

Strings are not translatable. Not Drupal code style.

+++ b/editors/ckeditor.incundefined
@@ -138,6 +142,24 @@ function wysiwyg_ckeditor_settings_form(&$form, &$form_state) {
+    $form['output']['acf_allowed_content']['#title'] = t('Allowed Content');

"Content" lowercase

+++ b/editors/ckeditor.incundefined
@@ -162,6 +184,15 @@ function wysiwyg_ckeditor_settings_form(&$form, &$form_state) {
+    form_error($element, t('Allowed Content is not valid JSON'));

Write "Content" lowercase. End sentences with periods.

Thanks! I've made those changes. Still needs form field descriptions.

#1968318: Support for TinyMCE 4.x and #2018439: Move editor-specific options out of the default profile UI. make some big changes, will be easier to rewrite my patch after those go in.

Awesome @rocketeerbkw! I haven't had time to actually test the patch yet, but it looks pretty solid just by what I can see with Dreditor.

I wonder if we could also provide a way for [cross-editor] plugins like Media to supply an abstracted set of rules for extending the sets here, since they can't directly use the editor API like native plugins. That would fix the major issue of inserted media not working. However, that's a fairly complex issue, and it'd have to be coordinated with the TinyMCE 4 integration.

I'll dig into that a bit more and get back here after rolling in the other patches you mentioned.

I attempted to apply this patch but it did not apply to wysiwyg 7.x-2.x HEAD

error: patch failed: editors/ckeditor.inc:138
error: editors/ckeditor.inc: patch does not apply

*[7.x-2.x][~/Sites/drupal7/sites/all/modules/wysiwyg]$ git apply wysiwyg-ckeditor-acf-1956778-12.patch -v
Checking patch editors/ckeditor.inc...
error: while searching for:
  $form['output']['paste_auto_cleanup_on_paste']['#title'] = t('Force paste as plain text');
  $form['output']['paste_auto_cleanup_on_paste']['#description'] = t('If enabled, all pasting operations insert plain text into the editor, loosing any formatting information possibly available in the source text. Note: Paste from Word is not affected by this setting.');

  if (version_compare($form_state['wysiwyg']['editor']['installed version'], '3.6.0', '>=')) {
    $form['appearance']['default_toolbar_grouping'] = array(
      '#type' => 'checkbox',

error: patch failed: editors/ckeditor.inc:138
error: editors/ckeditor.inc: patch does not apply

I've rerolled against HEAD and added field descriptions. This should be ready to go.

The patch in #16 worked for me (had to go in and re-save the admin settings first).

Just tested this patch on a fresh Drupal install with:

• Drupal 7.23
• Media 7.x-2.0-alpha2
• WYSIWYG 7.x-2.x-dev

and everything worked for me: I was able to easily add media files in the editor. Would be great to see this committed and a new release of wysiwyg created.

I have tested this patch as well and all appears to work as designed.

Quick & dirty D6 patch

#17 mentions having to resave the admin settings.
Can this be avoided or documented in the changelog?

One way to avoid it would be to use an update to inject the setting into all active CKEditor profiles and have ACF disabled by default. This should of course be noted with a message on the update page.

The patch in #16 works as a charm.

In order to add class in div, I have set up AFC as "automatic" and add new rules in the allowed content

It is worth to note that the documentation can be found in the page - ckeditor/samples/datafiltering.html - in either Ckeditor standard or full version.

#16 worked for me in OpenAtrium's latest dev (after I updated WYSIWIG to the latest dev).

Works great for me :) Hope it is okay to RTBC.

I made a small change to settings callback which should fix having to resave the profile settings. It does not require running update.php.

I just tested this, and it works like a charm. I configured the wysiwyg module with the media button before applying the patch, tried to add a media through ckeditor, it didn't work. Then, I applied the patch and tried to add a media through ckeditor, and it worked like a charm. RTBC ?

I also confirm this patch is working as my div classes are no longer removed.

works for me as well, +1 for rtbc

Yes works like a charm, even the title / alt attributes work :-) for media.
Adding divs with a class also works with the settings in #23.

+1 RTBC

#26 works for me too.

Tested with both Insert & oEmbed modules - everything now works as expected. Also tested with with CKEditor 4.2.2 and everything appears to be happy.

Thanks!

#26 works for me too.

Tested with both Insert & oEmbed modules - everything now works as expected. Also tested with with CKEditor 4.2.2 and everything appears to be happy.

Thanks!

#26 works for me too.

Tested with both Insert & oEmbed modules - everything now works as expected. Also tested with with CKEditor 4.2.2 and everything appears to be happy.

Thanks!

Apologies for the comment spam. D.O had some troubles posting my original comment.

Yes, #26 works for me too! My setup: CKEditor 4.2.2, wysiwyg 7.x-2.2+23-dev, media 7.x-2.0-alpha2.

+1 RTBC!

Thanks!

Great! Thanks for helping with this!

There's one thing we'll have to change though. The constants should not start with 'CKEDITOR_' since we don't really "own" that namespace. It's not ideal and unsupported, but it's possible to have ckeditor.module running alongside wsiwyg.module and they prefix their globals like that.
To play nice, we should prefix this with "WYSIWYG_CKEDITOR_", just like for our function names.

New patch taking into account comments from TwoD. RTBC ?

Patch from #37 works for me, thanks!

WYSIYWG 7.x-2.2+23-dev, CKEditor 4.2.2.

+1 for RBTC.

+1 for #37 from me

Quick visual on the patch, everything seems sane. I've got one of iterations (prob #12) running on a few sites with no known issues.

Let's get this committed.

patch from #37 worked for me with wysiwyg 7.x-2.x-dev + CKEditor 4.2.2 + Media 7.x-1.3

I tried this out with Media v7.x-2.0-alpha3+3-dev with the patch from #2067063-124 and it worked GREAT! Full test notes: https://drupal.org/node/2067063#comment-8009717

Thanks everyone for putting this together!

patch from #37 worked for me as well.

Outlined the current situation and a proposed solution.

Did this get committed? I just updated to latest dev and found that I didn't need to apply any patches from this issue.

@danbohea: No, none of the patches from this issue have been committed.

@DamienMcKenna: Thanks for clearing that up. I need to figure out what on earth's going on with my set up then :)

I can confirm this patch works as intended with CKEditor 4.2.3.a8bf556, and the latest dev releases of Media (7.x-2.0-alpha3+17-dev) and WYSIWYG (7.x-2.2+23-dev)

dev version appears to work with CKEditor 4.3.0.d2184ac

Dev does not work with media module.

#37 works with CKeditor 4.3.0.d2184ac

I'll just add right here that the patch, and only the patch, in #37, makes this combination work:

CKEditor 4.3.0.d2184ac
Media 7.x-2.0-alpha3+31-dev
Wysiwyg 7.x-2.2+23-dev

Ship it.

Any chance of incorporating these patches into nice released modules? I can't use CKEditor while it deletes my data

#37 is working well for me, thanks.

I don't know where this 'advanced' option even is?!

https://dl.dropboxusercontent.com/u/63070476/Screen%20Shot%202013-12-17%...

I checked the box, saved, flushed cache, logged out/in, everything. I get no extra options.

+1 the sentiments in #51. I just wasted far too much time trying to get Media/WYSIWYG/CKEditor to work with latest dev versions, only to find out that this patch for CKEditor ACF was the missing piece of the puzzle. I was even already subscribed to this issue (for a different reason) yet it was still too much to troubleshoot and piece together.

+1 RBTC.

WYSIWYG 7.x-2.2+23-dev (latest at time of writing)
Media 7.x-2.0-alpha3+34-dev (latest at time of writing)
CKEditor 4.3.1.3ecd0b8 (latest download at time of writing)

Yet another month passes without this being committed. I think I'm using this on 5 production sites now, could we please commit it?

I'm using this on several sites as well. Seems to work great.

+1 RBTC. Would love to see this committed.

How do I install the patch?

@tjtj: https://drupal.org/patch/apply

For those who are inexpert (like me), in the sites/all/libraries/wysiwyg directory, do:
patch -p1 < wysiwyg-ckeditor-acf-1956778-37.patch

I hope this is the right patch.

I've committed the #37 patch with a few minor modifications, see the interdiff if you wish to apply the additional changes I made.
This fix is now in 7.x-2.x-dev and 6.x-2.x-dev.

Thanks all for reporting, patching, reviewing and testing this patch!

The -dev snapshots will be updated within 12 hours and this will be part of the next releases.

Many thanks for getting this committed, and for including D6 as well.

Yey! Top work.

See also:
http://drupal.stackexchange.com/questions/74778/ckeditor-removes-class-n...

Will this feature allow me to blacklist certain tags/attributes with
config.disallowedContent ?

Hi all,

I tried the dev release of the module and can see these options in the configurations. I am still confused about how to configure this. I read all of the comments, but would be great if someone can help me.

I have a simple text as <p><span>MY TEXT HERE</span></p>

I am using dev branch of the wysiwyg module, ckeditor 4.5.3 and when I edit the page the ckeditor shows blank i.e. it destroys all text.

When I click on disable rich text editor it shows the html.

Not sure what should be the configurations for my html to retain everything which was entered previously.

Thanks,
Sadashiv.

@sadashiv, sounds like input format configuration to me. Make sure it's allowing <p> and <span> tags

If so, your issue isn't directly related to the ACF configuration.

I double checked that I am not filtering html tags. I am sure that it's ACF because If I use a different rich text editor like IMCE then it doesn't trim anything.

Thanks,
Sadashiv.

@sadashiv open a new issue and include what the current settings are for ACF

Hi,

I created a new issue at https://www.drupal.org/node/2636384

Thanks,
Sadashiv