Metadata-Version: 1.1
Name: django-froala-editor
Version: 1.2.1
Summary: django-froala-editor package helps integrate Froala WYSIWYG editor with Django.
Home-page: http://github.com/froala/django-froala-editor/
Author: Dipesh Acharya
Author-email: xtranophilist@gmail.com
License: BSD License
Description: ======================
        django-froala-editor
        ======================
        
        django-froala-editor package helps integrate `Froala WYSIWYG editor <http://editor.froala.com/>`_ with Django.
        
        
        Getting started
        ====================
        
        1. Install the package::
        
            pip install django-froala-editor
        
        OR
        
        Add the directory `froala_editor` from this repo to your Python path.
        
        2. Add ``froala_editor`` to INSTALLED_APPS in ``settings.py``.
        
        3. Add the following line to ``urlpatterns`` in your application's ``urls.py``.
        
        
        .. code-block:: python
        
            url(r'^froala_editor/', include('froala_editor.urls')),
        
        Skip this url inclusion if you don't want image upload inside WYSIWYG editor. Images from URLs can still be embedded.
        
        Usage
        ==============
        
        .. code-block:: python
        
            from django.db import models
            from froala_editor.fields import FroalaField
        
            class Page(models.Model):
                content = FroalaField()
        
        ``FroalaField`` uses ``froala_editor.widgets.FroalaEditor`` as its widget. You may directly use this widget with any of your forms.py:
        
        .. code-block:: python
        
            from django import forms
            from froala_editor.widgets import FroalaEditor
        
            class PageForm(forms.ModelForm):
                content = models.TextField(widget=FroalaEditor)
        
        
        Usage outside admin
        ^^^^^^^^^^^^^^^^^^^^^^
        
        When used outside the Django admin, the media files are to be manually included in the template. Inside the ``<head>`` section or before the form is rendered, include:
        
        .. code-block:: python
        
            {{ form.media }}
        
        
        In case of jQuery conflict (when your project template already has jQuery), you need to include the following files instead of ``{{ form.media }}`` plus the static files for theme (if not default) and required plugins.
        
        .. code-block:: python
        
            <link href="{{STATIC_URL}}froala_editor/css/font-awesome.min.css" type="text/css" media="all" rel="stylesheet" />
            <link href="{{STATIC_URL}}froala_editor/css/froala_editor.min.css" type="text/css" media="all" rel="stylesheet" />
            <script type="text/javascript" src="{{STATIC_URL}}froala_editor/js/froala_editor.min.js"></script
        
        
        If you don't want to use jQuery from this package, you may use the following in your `settings.py`:
        
        .. code-block:: python
        
            FROALA_INCLUDE_JQUERY = False
        
        
        
        Customization
        ==============
        
        
        ``FroalaField`` and ``FroalaEditor`` take in the following arguments:
        
        options
        ^^^^^^^^^
        
        Froala Editor provides several options for customizing the editor. See http://editor.froala.com/docs for all available options.
        You can provide a dictionary of these options as ``FROALA_EDITOR_OPTIONS`` setting in ``settings.py``. These options would then be used for all instances of the WYSIWYG editor in the project.
        
        Options for individual field can also be provided via ``FroalaField`` or ``FroalEditor`` class. This overrides any options set via ``FROALA_EDITOR_OPTIONS``.:
        
        .. code-block:: python
        
            from django.db import models
            from froala_editor.fields import FroalaField
        
            class Page(models.Model):
                content = FroalaField(options={
                    'inlineMode': True,
                })
        
        .. code-block:: python
        
            from django import forms
            from froala_editor.widgets import FroalaEditor
        
            class PageForm(forms.ModelForm):
                content = forms.TextField(widget=FroalaEditor(options={
                    'inlineMode': True,
                }        ))
        
        
        theme
        ^^^^^^^^^
        
        You may provide the name of the theme to be used as ``theme`` argument to ``FroalaField`` or ``FroalaEditor``.
        
        
        .. code-block:: python
        
            from django.db import models
            from froala_editor.fields import FroalaField
        
            class Page(models.Model):
                content = FroalaField(theme='dark')
        
        
        ``FROALA_EDITOR_THEME`` can be set in ``settings.py`` making all instances of the editor to use a theme. However, ``theme`` argument in ``FroalaField`` and ``FroalaEditor`` overrides ``FROALA_EDITOR_THEME``. Using a theme named 'dark' would require the existence of the file ``froala_editor/static/froala_editor/css/themes/dark.min.css``. Available themes are: 'dark', 'gray' and 'red'.
        
        
        plugins
        ^^^^^^^^^^
        Froala Editor comes with the plugins: block style, text & background colors, font size, font family, insert video, insert table, media manager, lists and file upload. By default, all plugins are enabled by default in this package. See `http://editor.froala.com/plugins <http://editor.froala.com/plugins>`_ for all available plugins.
        
        ``FROALA_EDITOR_PLUGINS`` can be set in ``settings.py`` to tell which plugins should all instances of Froala Editor be using. By default, it is
        
        .. code-block:: python
        
            FROALA_EDITOR_PLUGINS = ('font_size', 'font_family', 'colors', 'block_styles', 'video', 'tables', 'media_manager', 'lists', 'file_upload')
        
        The usage of ``plugins`` argument with ``FroalaEditor`` or ``FroalaField`` overrides this for that particular instance.
        
        
        .. code-block:: python
        
            from django.db import models
            from froala_editor.fields import FroalaField
        
            class Page(models.Model):
                content = FroalaField(plugins=('font_size', 'font_family',))
        
        
        image_upload
        ^^^^^^^^^^^^^^
        ``FroalaEditor`` and ``FroalaField`` optionally take in a boolean value for ``image_upload`` argument to enable or disable image uploads. Image uploads are enabled by default if the urls of this package are included in your urls.py.
        
        You can use ``FROALA_UPLOAD_PATH`` setting in ``settings.py`` to change the path where uploaded files are stored within the ``MEDIA_ROOT``. By default, ``uploads/froala_editor/images`` is used for storing uploaded images.
        
        
        include_jquery
        ^^^^^^^^^^^^^^^
        jQuery is included by default in form media. If you don't want to include jQuery, you may pass ``include_jquery=False`` to ``FroalaEditor`` or ``FroalaField``. ``FROALA_INCLUDE_JQUERY`` can be also set in ``settings.py`` for project wide effects.
        
        License
        ===============
        
        This package is available under BSD License.
        However, Froala editor is free only for non-commercial projects. See http://editor.froala.com/download for licensing.
        
Keywords: froala,django,admin,wysiwyg,editor
Platform: UNKNOWN
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
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
