Metadata-Version: 1.1
Name: django-wysiwyg-redactor
Version: 0.4.4
Summary: django-wysiwyg-redactor is a lightweight responsive wysiwyg editor for Django
Home-page: https://github.com/douglasmiranda/django-wysiwyg-redactor
Author: Douglas Miranda
Author-email: douglasmirandasilva@gmail.com
License: MIT
Description: A lightweight wysiwyg editor for Django
        =======================================
        
        .. image:: https://pypip.in/download/django-wysiwyg-redactor/badge.png
            :target: https://pypi.python.org/pypi/django-wysiwyg-redactor/
            :alt: Downloads
        
        Screenshot
        ----------
        
        .. image:: https://raw.githubusercontent.com/douglasmiranda/django-wysiwyg-redactor/master/screenshots/redactor.jpg
        
        What's that
        -----------------
        
        *django-wysiwyg-redactor* is a reusable application for Django, using `Redactor WYSIWYG editor <http://redactorjs.com/>`_
        
        Sponsored by `Mess Marketing <http://www.thisismess.com>`_, we use the latest version of redactorjs, always up-to-date.
        
        Dependence
        ----------
        
        - `Django >= 1.3` # for static files
        - `Pillow or 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
        
        .. code-block:: python
        
            REDACTOR_OPTIONS = {'lang': 'en'}
            REDACTOR_UPLOAD = 'uploads/'
        
        More `redactor settings <http://imperavi.com/redactor/docs/settings/>`_.
        
        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`.
        
        Using Plugins
        -------------
        `Download <http://imperavi.com/redactor/plugins/>`_ the plugin you want or `create a custom plugin <http://imperavi.com/redactor/docs/how-to-create-plugin/>`_.
        
        Then:
        
        .. 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',
                    # for example, if you downloaded the 'table' plugin:
                    redactor_options={'plugins': ['table']}
                )
        
        OR (on settings.py):
        
        .. code-block:: python
        
            REDACTOR_OPTIONS = {'lang': 'en', 'plugins': ['table']}
        
        Important: if you set a plugin called "table", you must create/paste the "table.js" on **YOUR_STATIC_FILES_FOLDER/redactor/plugins/table.js**
        
        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'
        
        
        File Storages
        -------------
        *django-wysiwyg-redactor* defaults to using the default media storage for your Django application.
        
        This can be overriden to use a different storage backend with this settings.py variable:
        
        .. code-block::
        
            REDACTOR_FILE_STORAGE = 'my_site.file_storages.storage_instance'
        
        Information on writing a custom storage backend is `here in the Django documentation <https://docs.djangoproject.com/en/1.7/howto/custom-file-storage/>`_.
        
        Other third-party libraries exist to provide storage backends for cloud object storages (e.g. `django-cumulus <https://github.com/django-cumulus/django-cumulus/>`_ for Rackspace/OpenStack or `django-storages <http://django-storages.readthedocs.org/en/latest/backends/amazon-S3.html>`_ for Amazon S3).
        
        
        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 =]
        
        Who is behind this?
        -------------------
        Awesome people, you should see the `AUTHORS <https://github.com/douglasmiranda/django-wysiwyg-redactor/blob/master/AUTHORS>`_ file.
        
        And our awesome sponsor:
        
        Mess Marketing from Chicago, IL
        jshedd@thisismess.com
        thisismess.com
        @etchalon
        
Keywords: django,admin,wysiwyg,editor,redactor,redactorjs
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
