.. contents::
===============================
django-inplaceedit-extra-fields
===============================
Information
===========
.. image:: https://badge.fury.io/py/django-inplaceedit-extra-fields.png
:target: https://badge.fury.io/py/django-inplaceedit-extra-fields
django-inplaceedit-extra-fields is a Django application that adds other useful fields to `django-inplaceedit <http://pypi.python.org/pypi/django-inplaceedit/>`_ .
It is distributed under the terms of the `GNU Lesser General Public
License <http://www.gnu.org/licenses/lgpl.html>`_.
Requirements
============
* `django-inplaceedit <http://pypi.python.org/pypi/django-inplaceedit/>`_ (>= 1.4.1)
And other packages, depending on which fields you want to use (see below).
Demo (this video use a very old version of django-inplaceedit and django-inplaceedit-extra-fields)
==================================================================================================
Video Demo, of `django-inplaceedit <http://pypi.python.org/pypi/django-inplaceedit/>`_, django-inplaceedit-extra-fields 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?t=34s
Installation
============
After installing `django-inplaceedit egg`_
.. _`django-inplaceedit egg`: https://django-inplaceedit.readthedocs.org/en/latest/install.html
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',
#'textarea': 'inplaceeditform_extra_fields.fields.AdaptorSimpleTinyMCEField',
'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',
'tiny_simple': 'inplaceeditform_extra_fields.fields.AdaptorSimpleTinyMCEField'}
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 depend 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-selects (1.3.6) <http://pypi.python.org/pypi/django-ajax-selects/1.3.6>`_. 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 django-ajax-selects <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/django-inplaceedit/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/django-inplaceedit/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 (12.3) <http://pypi.python.org/pypi/sorl-thumbnail/12.3>`_. 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 sorl-thumbnail <http://thumbnail.sorl.net/>`_
AdaptorTinyMCEField and AdaptorSimpleTinyMCEField
=================================================
::
{% inplace_edit "content.field_name" adaptor="tiny" %}
or
{% inplace_edit "content.field_name" adaptor="tiny_simple" %}
.. note::
We use tinyMCE 4.0 without changes (from django-inplaceedit-extra-fields==0.3.0), if you want to use another version (4.X) of tinyMCE set INPLACE_TINYMCE_JS in your settings.
::
INPLACE_TINYMCE_JS = '/my/path/of/tinyMCE'
If you want to use a tinyMCE 3.X, please use `django-inplaceedit-extra-fields==0.2.4 <http://pypi.python.org/pypi/django-inplaceedit-extra-fields/0.2.4>`_
Testing
=======
You can test it with the `testing project of django-inplaceedit <https://github.com/Yaco-Sistemas/django-inplaceedit/tree/master/testing>`_ or with the `testing project of django-inplaceedit-bootstrap <https://github.com/django-inplaceedit/django-inplaceedit-bootstrap/tree/master/testing>`_
Development
===========
You can get the bleeding edge version of django-inplaceedit-extra-fields by doing a clone
of its repository::
git clone git@github.com:django-inplaceedit/django-inplaceedit-extra-fields.git
0.7.1 (2016-04-22)
===================
* Fix tinyMCE url warning
0.7.0 (2016-04-21)
===================
* Django 1.9 suport: Thanks to `Paul Stenius <https://github.com/stenius/>`_
0.6.1 (2015-08-30)
===================
* Detail
0.6.0 (2015-08-30)
===================
* Django 1.7 and Django 1.8 suport
* Python 3 support for every adaptor
* Upgrade tinyMCE version
* Upgrade django-ajax-select version
* Upgrade jQuery-ui version (used in AdaptorAutoCompleteForeingKeyField AdaptorAutoCompleteManyToManyField)
* Upgrade sorl-thumbnail
0.5.0 (2013-10-04)
===================
* Support to python2.6 (this was not supported from django-inplaceedit-extra-fields>=0.0.9 to django-inplaceedit-extra-fields<0.5.0)
0.4.1 (2013-09-17)
===================
* Improvements in AdaptorSimpleTinyMCEField and AdaptorTinyMCEField
0.4.0 (2013-09-17)
===================
* Add AdaptorSimpleTinyMCEField adaptor
0.3.2 (2013-09-17)
===================
* Improvements in the README file
0.3.1 (2013-09-17)
===================
* Improvements in the README file
0.3.0 (2013-09-16)
===================
* AdaptorTinyMCEField now use **tinyMCE 4.X**
* Not the AdaptorTinyMCEField, AdaptorAutoCompleteForeingKeyField and AdaptorAutoCompleteManyToManyField use the static file recolector, new in django-inplaceedit==1.2.1
0.2.4 (2013-10-04)
===================
* Support to python2.6 (this was not supported from django-inplaceedit-extra-fields>=0.0.9 to django-inplaceedit-extra-fields<=0.2.3)
0.2.3 (2013-09-17)
===================
* Improvements in the README file
0.2.2 (2013-09-17)
===================
* Improvements in the README file
0.2.1 (2013-09-15)
===================
* Fix an error in AdaptorTinyMCEField when the inplace edit item was very little (its width was very little)
* Update the tinyMCE to last version (3.X)
0.2.0 (2013-09-10)
===================
* Improvements in AdaptorTinyMCEField, and adapt the code to the new features of django-inplaceedit==1.2
* Improvements in the README file
0.1.1 (2013-09-06)
===================
* Update the metainfo
0.1.0 (2013-09-05)
===================
* Fix an error in IE browser with the AdaptorTinyMCEField
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