Skip to main content

This reusable Django app using WYSIWYG editor redactorjs.com

Project description

# django-wysiwyg-redactor

(Version modified of django-redactorjs)

Some changes:

* version of plugin redactorjs 7.6.3 (changes the [license](#license) too)
* new API method `$('#redactor').getSelection()` get the selected content in editor
* new API method `$('#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

<img src="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 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 (more settings see: <https://github.com/douglasmiranda/django-wysiwyg-redactor/wiki/Settings>):

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

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

```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:
```python
short_text = RedactorField(
verbose_name=u'Text',
redactor_options={'lang': 'en', 'focus': 'true'},
upload_to='tmp/'
)
```
Using for only admin interface
-----------------------------
```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`

## License
Starting with version 7.6.2 redactor-js is licensed under [Creative Commons Attribution-NonCommercial 3.0 license](http://creativecommons.org/licenses/by-nc/3.0/)

For commercial use please buy license here: http://redactorjs.com/download/ or use earlier version.

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-wysiwyg-redactor-0.3.2.tar.gz (94.0 kB view details)

Uploaded Source

File details

Details for the file django-wysiwyg-redactor-0.3.2.tar.gz.

File metadata

File hashes

Hashes for django-wysiwyg-redactor-0.3.2.tar.gz
Algorithm Hash digest
SHA256 2a01bd78acedee37d79b99981f73505947af64643cb5a6f26982def84ed7261a
MD5 5a5f233c3e58d3efa79dee1b625e598e
BLAKE2b-256 1142f5fcefdda77685b99ffbedc97fcddd64b6e854a1e6a7ae7e8d3d5d0fb32f

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