CKEditor and elFinder integration for Django Framework.
Project description
# Django CKEd
**CKEditor and elFinder integration for Django Framework.**
Provides a `RichTextField` and `CKEditorWidget` with upload and browse support.
## Installation
1. Install or add django-cked to your PYTHONPATH.
2. Add `cked` to your `INSTALLED_APPS` setting.
3. Add a `CKED_UPLOAD_PATH` to your proejct `settings.py` file.
Default: `os.path.join(MEDIA_ROOT, 'uploads')`.
4. Add CKEd URL include to your project `urls.py` file:
`url(r'^cked/', include('cked.urls')),`
## Settings
* **CKED_UPLOAD_PATH**:
Path to store your uploads.
Default: `os.path.join(MEDIA_ROOT, 'uploads')`
* **CKEDITOR_OPTIONS**:
CKEditor config. See [http://docs.ckeditor.com/#!/guide/dev_configuration](http://docs.ckeditor.com/#!/guide/dev_configuration).
* **ELFINDER_OPTIONS**:
elFinder config. See [https://github.com/Studio-42/elFinder/wiki/Client-configuration-options](https://github.com/Studio-42/elFinder/wiki/Client-configuration-options)
## 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 }}`.
**CKEditor and elFinder integration for Django Framework.**
Provides a `RichTextField` and `CKEditorWidget` with upload and browse support.
## Installation
1. Install or add django-cked to your PYTHONPATH.
2. Add `cked` to your `INSTALLED_APPS` setting.
3. Add a `CKED_UPLOAD_PATH` to your proejct `settings.py` file.
Default: `os.path.join(MEDIA_ROOT, 'uploads')`.
4. Add CKEd URL include to your project `urls.py` file:
`url(r'^cked/', include('cked.urls')),`
## Settings
* **CKED_UPLOAD_PATH**:
Path to store your uploads.
Default: `os.path.join(MEDIA_ROOT, 'uploads')`
* **CKEDITOR_OPTIONS**:
CKEditor config. See [http://docs.ckeditor.com/#!/guide/dev_configuration](http://docs.ckeditor.com/#!/guide/dev_configuration).
* **ELFINDER_OPTIONS**:
elFinder config. See [https://github.com/Studio-42/elFinder/wiki/Client-configuration-options](https://github.com/Studio-42/elFinder/wiki/Client-configuration-options)
## 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 }}`.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-cked-0.0.0.1.tar.gz
(13.8 kB
view hashes)