Metadata-Version: 1.1
Name: django-froala-editor
Version: 2.9.0
Summary: django-froala-editor package helps integrate Froala WYSIWYG HTML editor with Django.
Home-page: http://github.com/froala/django-froala-editor/
Author: Froala Labs
Author-email: xtranophilist@gmail.com
License: BSD License
Description: # Django Froala WYSIWYG Editor
        
        >django-froala-editor package helps integrate [Froala WYSIWYG HTML editor](https://froala.com/wysiwyg-editor/) with Django.
        
        ## Getting started
        
        1. Install the package:
        
          `pip install django-froala-editor`
        
          if not update in pypi use this
          
          `pip install https://github.com/froala/django-froala-editor/archive/master.zip`
        
        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`.
        
        ```python
          url(r'^froala_editor/', include('froala_editor.urls')),
        ```
        
        Skip this url inclusion if you don't want image and file upload inside WYSIWYG editor. Images from URLs can still be embedded.
        
        ## Usage
        
        ```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:
        
        ```python
        from django import forms
        from froala_editor.widgets import FroalaEditor
        
        class PageForm(forms.ModelForm):
          content = forms.CharField(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:
        
        ```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.
        
        ```python
        <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.4.0/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" />
        <link href="{{STATIC_URL}}froala_editor/css/froala_style.min.css" type="text/css" media="all" rel="stylesheet" />
        <script type="text/javascript" src="{{STATIC_URL}}froala_editor/js/froala_editor.min.js"></script>
        ```
        
        Or simply, you may use the following in your `settings.py` if you don't want Froala to include jQuery by itself, thus preventing any conflicts:
        
        ```python
        FROALA_INCLUDE_JQUERY = False
        ```
        
        ### Options
        
        Froala Editor provides several options for customizing the editor. See [https://froala.com/wysiwyg-editor/docs](https://froala.com/wysiwyg-editor/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 `FroalaEditor` class. This overrides any options set via `FROALA_EDITOR_OPTIONS`:
        
        ```python
        from django.db import models
        from froala_editor.fields import FroalaField
        
        class Page(models.Model):
          content = FroalaField(options={
            'toolbarInline': True,
          })
        ```
        
        ```python
        from django import forms
        from froala_editor.widgets import FroalaEditor
        
        class PageForm(forms.ModelForm):
          content = forms.TextField(widget=FroalaEditor(options={
            'toolbarInline': True,
          }))
        ```
        
        ### Theme
        
        You may provide the name of the theme to be used as `theme` argument to `FroalaField` or `FroalaEditor`.
        
        ```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 [https://froala.com/wysiwyg-editor/docs/plugins](<https://froala.com/wysiwyg-editor/docs/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
        
        ```python
        FROALA_EDITOR_PLUGINS = ('align', 'char_counter', 'code_beautifier' ,'code_view', 'colors', 'draggable', 'emoticons',
                'entities', 'file', 'font_family', 'font_size', 'fullscreen', 'image_manager', 'image', 'inline_style',
                'line_breaker', 'link', 'lists', 'paragraph_format', 'paragraph_style', 'quick_insert', 'quote', 'save', 'table',
                'url', 'video')
        ```
        
        The usage of `plugins` argument with `FroalaEditor` or `FroalaField` overrides this for that particular instance.
        
        ```python
        from django.db import models
        from froala_editor.fields import FroalaField
        
        class Page(models.Model):
          content = FroalaField(plugins=('font_size', 'font_family'))
        ```
        
        ### Third party integrations
        
        `FROALA_EDITOR_THIRD_PARTY` setting can be used to configure third party integrations. Aviary Image Editor and SCAYT Web SpellChecker are available for now.
        To enable, in `settings.py`:
        
        ```python
        FRAOLA_EDITOR_THIRD_PARTY = ('image_aviary', 'spell_checker')
        ```
        
        Similar to plugin configuration, this can also be overridden on `ForalaEditor` and `FroalaField`.
        
        Use your key for SCAYT Web SpellChecker with `SCAYT_CUSTOMER_ID` in your project setings.
        
        
        ### 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.
        
        ### Other Settings
        
        Using `USE_FROALA_EDITOR = False` in your Django settings disables Froala editor and uses a TextArea instead.
        
        ## License
        
        This package is available under BSD License. However, in order to use Froala WYSIWYG HTML Editor plugin you should purchase a license for it.
        
        See [https://froala.com/wysiwyg-editor/pricing](https://froala.com/wysiwyg-editor/pricing) for licensing the Froala Editor.
        
        If you bought a license and got your key, the easiest way to implement it is to put it into the `FROALA_EDITOR_OPTIONS` setting in `settings.py`:
        
        ```python
        FROALA_EDITOR_OPTIONS = {
          'key': '<our key goes here>',
          # other options
          # ...
        }
        
Keywords: froala,django,admin,wysiwyg,editor,text,html,editor,rich,web
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: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
