Django CKEditor

NOTICE: The django-ckeditor-updated 4.4.4 have been merged with django-ckeditor and released as django-ckeditor-4.4.4.

NOTICE 2: This newer version has different configuration than old django-ckeditor releases!

Django admin CKEditor integration. Provides a RichTextField and CKEditorWidget utilizing CKEditor with image upload and browsing support included.

• This version also includes:

1. support to django-storages (works with S3)
2. updated ckeditor to version 4.4
3. included all ckeditor language files to made everyone happy!

Contents

• Installation
  • Required
  • Optional
• Usage
  • Field
  • Widget
  • Outside of django admin
  • Management Commands
  • Using S3
  • If you want to use allowedContent
  • Demo / Test application
  • Running selenium test
  • Versioning

Installation

Required

1. Install or add django-ckeditor to your python path.

   pip install django-ckeditor

2. Add ckeditor to your INSTALLED_APPS setting.

3. Add a CKEDITOR_UPLOAD_PATH setting to the project's settings.py file. This setting specifies an relative path to your CKEditor media upload directory. CKEditor uses Django storage API. By default Django uses file system storage backend (it will use your MEDIA_ROOT and MEDIA_URL) and if you don't use different backend you have to have write permissions for the CKEDITOR_UPLOAD_PATH path within MEDIA_ROOT, i.e.:

   CKEDITOR_UPLOAD_PATH = "uploads/"
   

   For the default file system storage images will be uploaded to "uploads" folder in your MEDIA_ROOT and urls will be created against MEDIA_URL (/media/uploads/image.jpg).

   CKEditor has been tested with django FileSystemStorage and S3BotoStorage. There are issues using S3Storage from django-storages.

4. For the default filesystem storage configuration MEDIA_ROOT and MEDIA_URL must be set correctly for the media files to work (like those uploaded by the ckeditor widget).

5. Run the collectstatic management command: $ ./manage.py collectstatic. This'll copy static CKEditor require media resources into the directory given by the STATIC_ROOT setting. See Django's documentation on managing static files for more info.

6. Add CKEditor URL include to your project's urls.py file:

   (r'^ckeditor/', include('ckeditor.urls')),
   

7. Note that by adding those URLs you add views that can upload and browse through uploaded images. Since django-ckeditor 4.4.6 those views are staff_member_required. If you want different permission decorator (login_required, user_passes_test etc.) then add views defined in ckeditor.urls manualy to you urls.py.

8. Set CKEDITOR_IMAGE_BACKEND to one of supported backends to enable thumbnails in ckeditor gallery. By default no thumbnails are created and full size images are used as preview. Supported backends:

   • pillow: uses PIL or Pillow

9. django-ckeditor uses jQuery in ckeditor-init.js file. You must set ``CKEDITOR_JQUERY_URL`` to a jQuery URL that will be used to load the library. If you have jQuery loaded from a different source just don't set [CKEDITOR_JQUERY_URL] and django-ckeditor will not try to load its own jQuery. If you find that CKEditor widgets don't appear in your Django admin site then check that this variable is set correctly. Example:

   CKEDITOR_JQUERY_URL = '//ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js'
   

Optional

1. All uploaded files are slugified by defaults, to disable this feature set CKEDITOR_UPLOAD_SLUGIFY_FILENAME to False

2. Set the CKEDITOR_RESTRICT_BY_USER setting to True in the project's settings.py file (default False). This restricts access to uploaded images to the uploading user (e.g. each user only sees and uploads their own images). Superusers can still see all images. NOTE: This restriction is only enforced within the CKEditor media browser.

3. Add a CKEDITOR_CONFIGS setting to the project's settings.py file. This specifies sets of CKEditor settings that are passed to CKEditor (see CKEditor's Setting Configurations), i.e.:

   CKEDITOR_CONFIGS = {
       'awesome_ckeditor': {
           'toolbar': 'Basic',
       },
   }
   

   The name of the settings can be referenced when instantiating a RichTextField:

   content = RichTextField(config_name='awesome_ckeditor')
   

   The name of the settings can be referenced when instantiating a CKEditorWidget:

   widget = CKEditorWidget(config_name='awesome_ckeditor')
   

   By specifying a set named default you'll be applying its settings to all RichTextField and CKEditorWidget objects for which config_name has not been explicitly defined

   CKEDITOR_CONFIGS = {
       'default': {
           'toolbar': 'full',
           'height': 300,
           'width': 300,
       },
   }
   

   It is possible to create a custom toolbar

   CKEDITOR_CONFIGS = {
       'default': {
           'toolbar': 'Custom',
           'toolbar_Custom': [
               ['Bold', 'Italic', 'Underline'],
               ['NumberedList', 'BulletedList', '-', 'Outdent', 'Indent', '-', 'JustifyLeft', 'JustifyCenter', 'JustifyRight', 'JustifyBlock'],
               ['Link', 'Unlink'],
               ['RemoveFormat', 'Source']
           ]
       }
   }
   

Usage

Field

The quickest way to add rich text editing capabilities to your models is to use the included RichTextField model field type. A CKEditor widget is rendered as the form field but in all other regards the field behaves as the standard Django TextField. For example:

from django.db import models
from ckeditor.fields import RichTextField

class Post(models.Model):
    content = RichTextField()

Widget

Alernatively you can use the included CKEditorWidget as the widget for a formfield. For example:

from django import forms
from django.contrib import admin
from ckeditor.widgets import CKEditorWidget

from post.models import Post

class PostAdminForm(forms.ModelForm):
    content = forms.CharField(widget=CKEditorWidget())
    class Meta:
        model = Post

class PostAdmin(admin.ModelAdmin):
    form = PostAdminForm

admin.site.register(Post, PostAdmin)

Outside of django admin

When you are rendering form outside of admin panel you will have to make sure that all form media is present for the editor to work. One of the way how to achieve this is following:

<form>
    {{ myform.media }}
    {{ myform.as_p }}
    <input type="submit"/>
</form>

or you can load the media manually at it is done in demo app:

{% load staticfiles %}
<script type="text/javascript" src="{% static "ckeditor/ckeditor/ckeditor.js" %}"></script>
<script type="text/javascript" src="{% static "ckeditor/ckeditor-init.js" %}"></script>

Management Commands

Included is a management command to create thumbnails for images already contained in CKEDITOR_UPLOAD_PATH. This is useful to create thumbnails when starting to use django-ckeditor with existing images. Issue the command as follows:

$ ./manage.py generateckeditorthumbnails

NOTE: If you're using custom views remember to include ckeditor.js in your form's media either through {{ form.media }} or through a <script> tag. Admin will do this for you automatically. See Django's Form Media docs for more info.

Using S3

See http://django-storages.readthedocs.org/en/latest/

NOTE: django-ckeditor will not work with S3 through django-storages without this line in settings.py:

AWS_QUERYSTRING_AUTH = False

If you want to use allowedContent

To allowedContent works, disable stylesheetparser plugin. So included this on your settings.py.:

CKEDITOR_CONFIGS = {
    "default": {
        "removePlugins": "stylesheetparser",
    }
}

Demo / Test application

If you clone the repository you will be able to run the ckeditor_demo application.

1. pip install -r ckeditor_demo_requirements.txt
2. Run python.manage.py syncdb
3. Create a superuser if you want to test the widget in the admin panel
4. Start the development server.

There is a forms.Form on main page (/) and a model in admin that uses the widget for a model field. Database is set to sqlite3 and STATIC/MEDIA_ROOT to folders in temporary directory.

Running selenium test

You can run the test with python manage.py test ckeditor_demo (for repo checkout only) or with tox which is configured to run with Python 2.7 and 3.3. (You may have to fix some imports in selenium webdriver for Python 3.3).

Versioning

First two numbers resemble ckeditor version used in the package. The third is used to issue releases for given ckeditor bundle (fixes, new features)