Source

django-cked / README.md

Django CKEd

CKEditor and elFinder integration for Django Framework.

Provides a RichTextField and CKEditorWidget with upload and browse support.

CKEditor elFinder

Installation

pip install django-cked

or

pip install -e hg+https://bitbucket.org/ssbb/django-cked#egg=django-cked

Configuration

  1. Add cked to your INSTALLED_APPS setting.

  2. Set ELFINDER_OPTIONS in your settings:

    :::python ELFINDER_OPTIONS = { ## required options 'root': os.path.join(PROJECT_ROOT, 'media', 'uploads'), 'URL': '/media/uploads/', }

  3. Add CKEd URL include to your project urls.py file:

    :::python url(r'^cked/', include('cked.urls')),

Settings

Usage

Model field

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


class Entry(models.Model):
    text = RichTextField()

Widget

from django import forms
from cked.widgets import CKEditorWidget

class MyForm(forms.Form):
    text = forms.CharField(widget=CKEditorWidget)

NOTE: If you are using custom forms, dont’r forget to include form media to your template:

{{ form.media }}
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.