CKEditor: What should I know about it?

Added by Robert Schneider over 3 years ago

Hi,

I've just installed the ckeditor for testing purposes. I'm impressed. I think it is much more user friendly to users than textile (though it is not complicated, but my users don't want to learn anything if possible). However, I'd like too know if using ckeditor causes any drawbacks.

Compared to textile is there anything that does not work? Or are there any major issues? I don't want to be blamed for introducing ckeditor that cannot be used in production.
And also I'd like to know how linking works. Is the syntax the same as in textile?
And silly question probably: textile's macros don't work with ckeditor? E.g. {{>toc}} was a nice thing. This is not possible, right?

Is there any documentation regarding ckeditor with Redmine?

Thanks,
Robert

Replies (13)

RE: CKEditor: What should I know about it? - Added by Pierre Labrie over 3 years ago

I have installed it in production recently and had good comments about the ease of use. Of course you loose some benefits of Textile and some macros but for the links ans image CkEditor as a different solution. I have also redmine_per_project_formatting so you can configure CkEditor for the Issues and keep Textile for the Wiki.

Some macros still work like {{thumbnail(picture152-1.png, size=800,title=demo image)}} or {{macro_list}} but not {{>toc}} probably because <h1> does not match h1.

You can modify the style sheet of CkEditor to suit your need. For the formated style () I changed the background color and the font style. Additional information is at http://ckeditor.com/

RE: CKEditor: What should I know about it? - Added by Robert Schneider over 3 years ago

Even {{>toc}} works! I just tried it with typing {{>toc}} into the editor. In HTML mode this gets converted to {{&gt;toc}}. Anyhow this works in detail, it just works. I guess that all macros work, which is quite beautiful. Though I haven't test it. But I can even use the macros of the DMSF plugin.

But what could be the benefits of Textile that you said gets lost?

RE: CKEditor: What should I know about it? - Added by Jeremy Bailey over 3 years ago

My limited experience is that it's great for fresh installs, but I had bad luck trying to run the rake task that migrates existing Textile content to HTML. I haven't reported this as a bug, and it could be user error. I ran the command below but left out the [PROJECT...] argument so that all my projects would be migrated. If you have a mature site (and this is obvious), I definitely recommend backing up your database before you try to install CKEditor.

rake redmine_ckeditor:migrate RAILS_ENV=production [PROJECT=project_identifier1,project_identifier2] [FORMAT=textile]

Great tip about the redmine_per_project_formatting plugin!

RE: CKEditor: What should I know about it? - Added by Anonymous about 3 years ago

I've been running CKEditor in Redmine for about a year now, personally I prefer markdown, but I needed to find something that the end users could handle without any trouble.

The biggest issue you'll run into with this is the macro support. I've had to drop into the source view (hit the "Source" button in the editor tool bar) in order to get most of them to work. At the same time, I've never managed to get any of the multi-line macros to work, such as collapsible sections, probably due to how the text is stored in the DB (as HTML). Single-line macros like includes and thumbnails work just fine though.

One big word of warning though: there are no plugins or conversion scripts that I know of to convert Redmine wiki pages or issue descriptions from HTML to any other format. Once you go for CKEditor, unless you manually update everything, you will quite likely be stuck with it for a very long time... I'd suggest you run it in a test environment and give the end users access to it to get their opinion before you implement it in your production environment.

RE: CKEditor: What should I know about it? - Added by Robert Schneider about 3 years ago

Thank you for your comments!

RE: CKEditor: What should I know about it? - Added by Roman Pickl almost 3 years ago

does anyone else have the problem that & are converted to &amp; in links?

RE: CKEditor: What should I know about it? - Added by Roman Pickl almost 3 years ago

this has just been fixed. see github/a-ono_/

(I can't post links in this forum?)

RE: CKEditor: What should I know about it? - Added by Anonymous almost 3 years ago

Roman Pickl wrote:

this has just been fixed. see github/a-ono_/

(I can't post links in this forum?)

For reference: issue 132

If you need help with posting links, check out this wiki page, or just paste the full URL with a leading "http://" and Redmine's Wiki engine will make it a link for you. :)

RE: CKEditor: What should I know about it? - Added by Roman Pickl almost 3 years ago

thanks for the info (I knew this stuff before), but posting a url like https://github.com/a-ono/redmine_ckeditor/issues/132 did definitely not work a few days ago!

RE: CKEditor: What should I know about it? - Added by Alexander Strunck almost 3 years ago

I installed CKEditor in december. It looked very good at first but then I discovered a problem with uploading small images (<111kb)

Could not upload your file:

-rich_file

Paperclip:Errors::NotIdentifiedbyImageMagickError

I posted the problem on different forums, but no solution or no response.
https://community.bitnami.com/t/ckeditor-for-redmine-image-upload-fails/28943/18
http://ckeditor.com/forums/CKEditor/Error-for-uploading-small-images
http://stackoverflow.com/questions/27937636/error-for-small-image-111kb-upload-in-ckeditor-for-redmine?noredirect=1#comment44286292_27937636
Has someone an idea where to get help?

RE: CKEditor: What should I know about it? - Added by Roman Pickl almost 3 years ago

update to the newest version: https://github.com/a-ono/redmine_ckeditor/releases

if the problem persists: post an issue including redmine version, testimage, error-logs to https://github.com/a-ono/redmine_ckeditor/issues

Roman

RE: CKEditor: What should I know about it? - Added by Alexander Strunck almost 3 years ago

thank you I already opened an issue. I will complete the information with the information you mentioned (redmine verions, testimage, error-logs).
https://github.com/a-ono/redmine_ckeditor/issues/143

RE: CKEditor: What should I know about it? - Added by Roman Pickl over 2 years ago

Hi,
I have the problem that xml/html code is not shown as text. this is quite annoying when e.g. posting requests etc.

<br>
text
<br>

or
<xml>
test
</xml>

does anyone experience the same issue?
https://github.com/a-ono/redmine_ckeditor/issues/158

(1-13/13)