Skip to main content

django-wysiwyg-redactor is a lightweight responsive wysiwyg editor for Django

Project description

A lightweight wysiwyg editor for Django
=======================================

Some changes:

- redactorjs 7.6.3 (changes the [license](#license) too)
- new API methods
- `$('#redactor').getSelection()` get the selected content in editor
- `$('#redactor').getSettings()` you can get and set settings anytime you want
- removing some ajax calls, (modal windows), to avoid the crossdomain issue on production env
- with the *extra_script* option/setting you can load some script to do something more after load the redactor
- now the redactor toolbar is more responsive
- fixing some bugs, adapting things...

Screenshot
----------

.. image:: https://raw.github.com/douglasmiranda/django-wysiwyg-redactor/master/static/img/screenshot.png

What's that
-----------------

*django-wysiwyg-redactor* is a reusable application for Django, using `Redactor WYSIWYG editor <http://redactorjs.com/>`_

Dependence
----------

- `Django >= 1.3` # for static files
- `PIL` # for image upload

Getting started
---------------

- Install *django-wysiwyg-redactor*:

```pip install django-wysiwyg-redactor```

- Add `'redactor'` to INSTALLED_APPS.

- Add `url(r'^redactor/', include('redactor.urls'))`, to urls.py

- Add default config in settings.py (fot more settings, see `here <https://github.com/douglasmiranda/django-wysiwyg-redactor/wiki/Settings>`_)

.. code-block:: python

REDACTOR_OPTIONS = {'lang': 'en'}
REDACTOR_UPLOAD = 'uploads/'



Using in model
--------------

.. code-block:: python

from django.db import models
from redactor.fields import RedactorField

class Entry(models.Model):
title = models.CharField(max_length=250, verbose_name=u'Title')
short_text = RedactorField(verbose_name=u'Text')

or use custom parametrs:

.. code-block:: python

short_text = RedactorField(
verbose_name=u'Text',
redactor_options={'lang': 'en', 'focus': 'true'},
upload_to='tmp/',
allow_file_upload=True,
allow_image_upload=True
)

Using for only admin interface
------------------------------

.. code-block:: python
from django import forms
from redactor.widgets import RedactorEditor
from blog.models import Entry

class EntryAdminForm(forms.ModelForm):
class Meta:
model = Entry
widgets = {
'short_text': RedactorEditor(),
}

class EntryAdmin(admin.ModelAdmin):
form = EntryAdminForm

`RedactorEditor` takes the same parameters as `RedactorField`


Upload Handlers
---------------
SimpleUploader - The Standard Uploader. Will upload your file to REDACTOR_UPLOAD.

UUIDUploader - This handler will replace the original file name for an UUID.

DateDirectoryUploader - This handler saves the file in a directory based on the current server date.

Usage:

For example, if I want to use the DateDirectoryUploader handler, I will put this on settings.py:

.. code-block:: python

REDACTOR_UPLOAD_HANDLER = 'redactor.handlers.DateDirectoryUploader'


NOTE: Soon we will have a better documentation.

Contributing
------------

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request =]

History
-------
- 0.3.9 Mar 29, 2014

- New Feature: Upload Handler (pull #43) Special Thanks to @SilentSokolov
- Fix unicode filename issue.

- 0.3.8.2 Feb 14, 2014

- Improvement: Rename uploaded image by dint of uuid ( pull #33 )

- 0.3.8.1 Feb 13, 2014

- Fix: Solve Deprecation of 'simplejson' ( pull #25 )

- previous versions

- Lots of fixes, see the commits.

Who is behind this?
-------------------
Awesome people, you should see the `AUTHORS <https://github.com/douglasmiranda/django-wysiwyg-redactor/blob/master/AUTHORS>`_ file.

License
-------
Starting with version 7.6.3 redactor-js is licensed under `Creative Commons Attribution-NonCommercial 3.0 license <http://creativecommons.org/licenses/by-nc/3.0/>`_

If you want to use a newer version please buy license `here <http://imperavi.com/redactor/download>`_

Project details


Release history Release notifications

History Node

0.5.1

History Node

0.5.0

History Node

0.4.9.1

History Node

0.4.9

History Node

0.4.8.1

History Node

0.4.8

History Node

0.4.7

History Node

0.4.6

History Node

0.4.5.1

History Node

0.4.5

History Node

0.4.4.1

History Node

0.4.4

History Node

0.4.3.2

History Node

0.4.3.1

History Node

0.4.3

History Node

0.4.2.1

History Node

0.4.2

History Node

0.4.1

History Node

0.4.0

History Node

0.3.9.1

This version
History Node

0.3.9

History Node

0.3.8.2

History Node

0.3.8.1

History Node

0.3.8

History Node

0.3.7

History Node

0.3.6

History Node

0.3.5

History Node

0.3.4

History Node

0.3.3

History Node

0.3.2

History Node

0.3.1

History Node

0.3.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django-wysiwyg-redactor-0.3.9.tar.gz (96.0 kB) Copy SHA256 hash SHA256 Source None Mar 29, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page