This reusable Django app using WYSIWYG editor redactorjs.com
Project description
# django-wysiwyg-redactor
Updated to work with django 2.0.x
(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.3 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.
Updated to work with django 2.0.x
(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.3 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-redactor-2.0-0.1.tar.gz
(148.5 kB
view hashes)
Built Distribution
Close
Hashes for django_redactor_2.0-0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f1572d3f03265d01daba5c41a1b7ebff10e1ca38233c7a0883ff7b8fc443fc2 |
|
MD5 | bed73f4c07a187b2006418e09d038434 |
|
BLAKE2b-256 | f8994a130b60812f3541d4b4cee711f9b973e39ade28f23fdc2210e95f0302f1 |