Metadata-Version: 1.1
Name: django-inplaceedit-extra-fields
Version: 0.0.9
Summary: Django application that adds other useful fields to Django inplace edit
Home-page: https://github.com/goinnn/django-inplaceedit-extra-fields
Author: Pablo Martin
Author-email: goinnn@gmail.com
License: LGPL 3
Description: .. contents::
        
        ==============================
        Inplace Edit Form Extra Fields
        ==============================
        
        Information
        ===========
        
        .. image:: https://badge.fury.io/py/django-inplaceedit-extra-fields.png
            :target: https://badge.fury.io/py/django-inplaceedit-extra-fields
        
        .. image:: https://pypip.in/d/django-inplaceedit-extra-fields/badge.png
            :target: https://pypi.python.org/pypi/django-inplaceedit-extra-fields
        
        Inplace Edit Form Extra Field is a Django application that adds other useful fields to `Inplace Edit <https://github.com/Yaco-Sistemas/django-inplaceedit>`_.
        
        It is distributed under the terms of the `GNU Lesser General Public
        License <http://www.gnu.org/licenses/lgpl.html>`_.
        
        Requirements
        ============
        
         * `Django Inplace Edit (1.0.0) <http://pypi.python.org/pypi/django-inplaceedit/>`_
        
        And other packages, depending on which fields you want to use (see below).
        
        
        Demo
        ====
        
        Video Demo of django-inplaceedit and `Django-inlinetrans <http://pypi.python.org/pypi/django-inlinetrans>`_ (Set full screen mode to view it correctly)
        
        
        .. image:: https://github.com/Yaco-Sistemas/django-inplaceedit/raw/master/video-frame.png
           :target: http://www.youtube.com/watch?v=_EjisXtMy_Y
        
        
        
        Installation
        ============
        
        After installing `django inplace edit egg`_
        
        
        .. _`django inplace edit egg`: http://pypi.python.org/pypi/django-inplaceedit/#installation
        
        
        In your settings.py
        -------------------
        
        ::
        
            INSTALLED_APPS = (
                'django.contrib.auth',
                'django.contrib.contenttypes',
                'django.contrib.sessions',
                'django.contrib.sites',
                'django.contrib.admin',
                #.....................#
                'inplaceeditform',
                'inplaceeditform_extra_fields',
            )
        
        If you want to overwrite the adaptors for all cases in your project:
        
        ::
        
            ADAPTOR_INPLACEEDIT = {'textarea': 'inplaceeditform_extra_fields.fields.AdaptorTinyMCEField',
                                   'image': 'inplaceeditform_extra_fields.fields.AdaptorImageThumbnailField',
                                   'fk': 'inplaceeditform_extra_fields.fields.AdaptorAutoCompleteForeingKeyField',
                                   'm2mcomma': 'inplaceeditform_extra_fields.fields.AdaptorAutoCompleteManyToManyField'}
        
        If you want, you can register these fields in your settings with different keys:
        
        ::
        
            ADAPTOR_INPLACEEDIT = {'auto_fk': 'inplaceeditform_extra_fields.fields.AdaptorAutoCompleteForeingKeyField',
                                   'auto_m2m': 'inplaceeditform_extra_fields.fields.AdaptorAutoCompleteManyToManyField',
                                   'image_thumb': 'inplaceeditform_extra_fields.fields.AdaptorImageThumbnailField',
                                   'tiny': 'inplaceeditform_extra_fields.fields.AdaptorTinyMCEField',}
        
        And after that, to want use a specific adaptor you can pass it to the templatetag, e.g.:
        
        ::
        
           {% inplace_edit "content.field_name" adaptor="tiny" %}
        
        
        Why these fields are not in django-inplaceedit
        ==============================================
        
         * They depends on the other eggs
         * They are a specific solution
         * These do not work immediately, you have to code them
        
        
        AdaptorAutoCompleteForeingKeyField and AdaptorAutoCompleteManyToManyField
        =========================================================================
        
        These fields depend on `Django Ajax Select (1.2.5) <http://pypi.python.org/pypi/django-ajax-selects/>`_. You have to create a channel (lookup)
        
        ::
        
            {% inplace_edit "content.field_name" adaptor="auto_fk", lookup="my_lookup" %}
        
        For more info, visit the `doc of ajax select <https://github.com/twidi/django-ajax-select/blob/master/ajax_select/docs.txt#L40>`_
        
        It is recomended you overwrite the following templates:
        
         * `inc.css_library.html <http://github.com/goinnn/django-inplaceedit-extra-fields/blob/master/inplaceeditform_extra_fields/templates/inplaceeditform_extra_fields/adaptor_autocomplete/inc.css_library.html>`_
         * `inc.js_library.html <http://github.com/goinnn/django-inplaceedit-extra-fields/blob/master/inplaceeditform_extra_fields/templates/inplaceeditform_extra_fields/adaptor_autocomplete/inc.js_library.html>`_
        
        AdaptorImageThumbnailField
        ==========================
        
        This field depends on `Sorl thumbnail (11.12) <http://pypi.python.org/pypi/sorl-thumbnail/>`_. You just need to specify the thumb size.
        
        ::
        
            {% inplace_edit "content.field_name" adaptor="image_thumb", size="16x16" %}
        
        It can help you, configure in your settings:
        
        ::
        
            THUMBNAIL_DEBUG = True
        
        
        For more info, visit the `doc of thumbnail <http://thumbnail.sorl.net/>`_
        
        
        AdaptorTinyMCEField
        ===================
        
        ::
        
            {% inplace_edit "content.field_name" adaptor="tiny" %}
        
        
        It's highly recommended that in your base.html you include the following CSS, to normalize the first element of the iframe
        
        
        ::
        
            <link rel="stylesheet" href="{{ STATIC_URL }}adaptor_tiny/css/block_normalize.css"> 
        
        .. note:: 
        
            We use tinyMCE (version 3.5.6) without changes, except we have added a `inplaceedit plugin <https://github.com/goinnn/django-inplaceedit-extra-fields/tree/master/inplaceeditform_extra_fields/static/adaptor_tiny/js/tiny_mce_3.5.6/plugins/inplaceedit>`_
        
        
        Testing
        =======
        
        You can test it with the `testing project of django-inplaceedit <https://github.com/Yaco-Sistemas/django-inplaceedit/tree/master/testing>`_
        
        
        Development
        ===========
        
        You can get the leading edge version of inplaceedit-extra-fields by doing a checkout
        of its repository:
        
          https://github.com/goinnn/django-inplaceedit-extra-fields
        
        
        
        0.0.9  (2013-09-05)
        ===================
        
        * Python 3 compatible (Only AdaptorTinyMCEField, django-ajax-fields and sorl.thumbnail are not python3 compatibles)
        * django-inplaceedit (1.0.0) compatible
        * django 1.2 support
        * Improvements in the README
        * Fix some details
        * Fix some grammar in README: Thanks to `Flavio Curella <https://github.com/fcurella/>`_
        
        0.0.8  (2012-11-12)
        ===================
        
        * Fix a little error of the tinyMCE adaptor: Thanks to `Yuego <https://github.com/Yuego/>`_
        
        0.0.7  (2012-08-21)
        ===================
        
        * Improve the tinyMCE field, modify the settings of the tinyMCE for can do a real inplaceedit, the layout must be the same with the tinyMCE and with a piece of HTML:
            * Now The tinyMCE automatically load the css of the view
            * Create a normalize css, there is a problem with the first element of the documents of the iframe
            * Now you can overwrite the extra_mce_settings from settings
            * Now I can load some css and not load the content.css of the tinyMCE
            * Remove the csmutils dependence
            * Adapt the code to the new option in django-inplaceedit (autosave)
            * Improve the inplace_edit plugin of the tinyMCE editor 
            * Update tinyMCE to last release
        
        0.0.6  (2012-05-22)
        ===================
        
        * Uncouple cmsutils of the tinyMCE widget overwriting two methods
        
        
        0.0.5  (2012-05-22)
        ===================
        
        * Now django-inplaceedit-extra-fields managing `static files <https://docs.djangoproject.com/en/dev/howto/static-files/>`_ (backward compatible)
        
        0.0.4  (2011-12-13)
        ===================
        
        * Fixes a error in tinyMCE adaptor when the user has not edit permission
        * Add MANIFEST.in. Until now, the egg is impossible that work
        
        0.0.3  (2011-12-09)
        ===================
        
        * More easy overwrite the jquery-ui
        * More clean the code of tiny field
        
        0.0.2  (2011-12-08)
        ===================
        
        * Complete the README
        
        
        0.0.1  (2011-12-08)
        ===================
        
        * First version to AdaptorAutoCompleteForeingKeyField and AdaptorAutoCompleteManyToManyField
        * First version to AdaptorImageThumbnailField
        * First version to AdaptorTinyMCEField
        
Keywords: django,inplace,inline edit,inline form,inline,inplace edit,inplace form,ajax,tinymce,autocomplete,thumbnail
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
