django-wysiwyg-redactor is a lightweight responsive wysiwyg editor for Django
Project description
# A lightweight wysiwyg editor for Django
<a href="https://crate.io/packages/django-wysiwyg-redactor/"><img src="https://pypip.in/d/django-wysiwyg-redactor/badge.png"></a>
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
<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 here: <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/',
allow_file_upload=True,
allow_image_upload=True
)
```
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`
## 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 =]
## 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
<a href="https://crate.io/packages/django-wysiwyg-redactor/"><img src="https://pypip.in/d/django-wysiwyg-redactor/badge.png"></a>
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
<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 here: <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/',
allow_file_upload=True,
allow_image_upload=True
)
```
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`
## 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 =]
## 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 | 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
Close
Hashes for django-wysiwyg-redactor-0.3.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8aaa757f0fb6ff9fab472b3dc90611982c72443f3650d7b98044c6ccae12e17d |
|
MD5 | bf2b6cd470775c1d28425ba4fd17e108 |
|
BLAKE2b-256 | 43b07cb6fb5139845c8839250065c4604ad960f43ef266a5f37bea15948ae240 |