Text Plugin for django CMS with CKEditor support
Project description
djangocms-text-ckeditor
=======================
Text Plugin for django-cms with CK-Editor
.. WARNING::
``cms.plugins.text`` and ``djangocms-text-ckeditor`` can't be used at the same time.
Installation
------------
This plugin requires `django CMS` 2.3 or higher to be properly installed.
* In your projects `virtualenv`_, run ``pip install djangocms-text-ckeditor``.
* Add ``'djangocms_text_ckeditor'`` to your ``INSTALLED_APPS`` setting **BEFORE** the ``cms`` entry.
* Run ``manage.py migrate djangocms_text_ckeditor``.
Upgrading from ``cms.plugins.text``
-----------------------------------
* Remove ``cms.plugins.text`` from ``INSTALLED_APPS``
* Add ``djangocms_text_ckeditor`` to ``INSTALLED_APPS``
* Run ``python manage.py migrate djangocms_text_ckeditor 0001 --fake``
Usage
-----
You can add a new setting to your settings.py called `CKEDITOR_SETTINGS`
the default is::
CKEDITOR_SETTINGS = {
'language': '{{ language }}',
'toolbar': 'CMS',
'skin': 'moono'
}
It is a dict that hold all CKEditor settings. For an overview of all the available settings have a look here:
http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html for all settings
Drag & Drop Images
------------------
In IE and Firefox based browsers it is possible to drag and drop a picture into the text editor.
This image is base64 encoded and lives in the 'src' attribute as a 'data' tag.
We detect this images, encode them and convert them to picture plugins.
If you want to overwirite this behavior for your own picture plugin:
There is a setting called:
`TEXT_SAVE_IMAGE_FUNCTION = 'djangocms_text_ckeditor.picture_save.create_picture_plugin'`
you can overwrite this setting in your settings.py and point it to a function that handles image saves.
Have a look at the function `create_picture_plugin` for details.
Translations
------------
If you want to help translate the plugin please do it on transifex:
https://www.transifex.com/projects/p/django-cms/resource/djangocms-text-ckeditor/
=======================
Text Plugin for django-cms with CK-Editor
.. WARNING::
``cms.plugins.text`` and ``djangocms-text-ckeditor`` can't be used at the same time.
Installation
------------
This plugin requires `django CMS` 2.3 or higher to be properly installed.
* In your projects `virtualenv`_, run ``pip install djangocms-text-ckeditor``.
* Add ``'djangocms_text_ckeditor'`` to your ``INSTALLED_APPS`` setting **BEFORE** the ``cms`` entry.
* Run ``manage.py migrate djangocms_text_ckeditor``.
Upgrading from ``cms.plugins.text``
-----------------------------------
* Remove ``cms.plugins.text`` from ``INSTALLED_APPS``
* Add ``djangocms_text_ckeditor`` to ``INSTALLED_APPS``
* Run ``python manage.py migrate djangocms_text_ckeditor 0001 --fake``
Usage
-----
You can add a new setting to your settings.py called `CKEDITOR_SETTINGS`
the default is::
CKEDITOR_SETTINGS = {
'language': '{{ language }}',
'toolbar': 'CMS',
'skin': 'moono'
}
It is a dict that hold all CKEditor settings. For an overview of all the available settings have a look here:
http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html for all settings
Drag & Drop Images
------------------
In IE and Firefox based browsers it is possible to drag and drop a picture into the text editor.
This image is base64 encoded and lives in the 'src' attribute as a 'data' tag.
We detect this images, encode them and convert them to picture plugins.
If you want to overwirite this behavior for your own picture plugin:
There is a setting called:
`TEXT_SAVE_IMAGE_FUNCTION = 'djangocms_text_ckeditor.picture_save.create_picture_plugin'`
you can overwrite this setting in your settings.py and point it to a function that handles image saves.
Have a look at the function `create_picture_plugin` for details.
Translations
------------
If you want to help translate the plugin please do it on transifex:
https://www.transifex.com/projects/p/django-cms/resource/djangocms-text-ckeditor/
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
djangocms-text-ckeditor-1.0.4.tar.gz
(753.9 kB
view details)
File details
Details for the file djangocms-text-ckeditor-1.0.4.tar.gz
.
File metadata
- Download URL: djangocms-text-ckeditor-1.0.4.tar.gz
- Upload date:
- Size: 753.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c96be5ddc4bf3c89eada6746a95fc2c533df24326445b7b2899889a5e5ef1ed |
|
MD5 | 2ec91a994a10e14dbfd77362537333ef |
|
BLAKE2b-256 | 26e949130499a095ad992d2fdd3be57ee63f069a126fb8f3f94f866f767707ca |