Skip to main content

Django admin CKEditor integration.

Project description

Django admin CKEditor integration.

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

Installation

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

  2. Add ckeditor to your INSTALLED_APPS setting.

  3. Copy the media/ckeditor directory into any directory within your media root. You can override the location in your settings (see below).

  4. Add a CKEDITOR_MEDIA_PREFIX setting to the project’s settings.py file. This setting specifies a URL prefix to the ckeditor JS and CSS media (not uploaded media). Make sure to use a trailing slash:

    CKEDITOR_MEDIA_PREFIX = "/media/ckeditor/"
  5. Add a CKEDITOR_UPLOAD_PATH setting to the project’s settings.py file. This setting specifies an absolute path to your ckeditor media upload directory. Make sure you have write permissions for the path, i.e.:

    CKEDITOR_UPLOAD_PATH = "/home/media/media.lawrence.com/uploads"
  6. Add ckeditor url include to the project’s url.py file:

    (r'^ckeditor/', include('ckeditor.urls')),
  7. Optionally, add a CKEDITOR_UPLOAD_PREFIX setting to the project’s settings.py file. This setting specifies a URL prefix to media uploaded through ckeditor, i.e.:

    CKEDITOR_UPLOAD_PREFIX = "http://media.lawrence.com/media/ckuploads/

(If CKEDITOR_UPLOAD_PREFIX is not provided, the media URL will fall back to MEDIA_URL with the difference of MEDIA_ROOT and CKEDITOR_UPLOAD_PATH appended.)

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)

ChangeLog

0.0.1

Added CKEDITOR_UPLOAD_PREFIX setting. Thanks to chr15m for the input.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-ckeditor-0.0.1.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

django_ckeditor-0.0.1-py2.6.egg (9.7 kB view details)

Uploaded Egg

File details

Details for the file django-ckeditor-0.0.1.tar.gz.

File metadata

File hashes

Hashes for django-ckeditor-0.0.1.tar.gz
Algorithm Hash digest
SHA256 4c518777571900f1d367098291590155a99829208edbbc775c5c97ec9cc08954
MD5 869fed5a8002e95e7a5d39d39714f38a
BLAKE2b-256 77bc74f34fbb2d2e3b28f44a2ca77ad7e0701c69cc9817a770729a5678735778

See more details on using hashes here.

File details

Details for the file django_ckeditor-0.0.1-py2.6.egg.

File metadata

File hashes

Hashes for django_ckeditor-0.0.1-py2.6.egg
Algorithm Hash digest
SHA256 c47ead78e11ac3a261114911a7c0400bdb78e263fde4173a6a49178f38a562df
MD5 4401ff1ca4d10e3eb00bf0acfd9ad3e9
BLAKE2b-256 03c13eb2b083d329e4a91736ff69172cea442ffabab198e58ee88fb93b01cd95

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page