From 3c55c991ad8e9df4badcf84b0158edf62d91e6ed Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Raimbault?= <stephane.raimbault@gmail.com>
Date: Mon, 26 Nov 2012 17:07:03 +0100
Subject: [PATCH 1/5] Removed useless intermediate function

---
 django_select2/widgets.py | 11 +----------
 1 file changed, 1 insertion(+), 10 deletions(-)

diff --git a/django_select2/widgets.py b/django_select2/widgets.py
index b0f813bf..95c920a8 100644
--- a/django_select2/widgets.py
+++ b/django_select2/widgets.py
@@ -143,15 +143,6 @@ def get_options(self):
             options['allowClear'] = not self.is_required
         return options
 
-    def render_select2_options_code(self, options, id_):
-        """
-        Renders options for Select2 JS.
-
-        :return: The rendered JS code.
-        :rtype: :py:obj:`unicode`
-        """
-        return convert_dict_to_js_map(options, id_)
-
     def render_js_code(self, id_, *args):
         """
         Renders the ``<script>`` block which contains the JS code for this widget.
@@ -171,7 +162,7 @@ def render_inner_js_code(self, id_, *args):
         :rtype: :py:obj:`unicode`
         """
         options = dict(self.get_options())
-        options = self.render_select2_options_code(options, id_)
+        options = convert_dict_to_js_map(options, id_)
 
         return u'$("#%s").select2(%s);' % (id_, options)
 

From c93de5c79a2f44ee2d9ebdad7233538ff74ff1ea Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Raimbault?= <stephane.raimbault@gmail.com>
Date: Mon, 26 Nov 2012 17:09:45 +0100
Subject: [PATCH 2/5] Fix two files in DOS format

---
 django_select2/widgets.py | 1046 ++++++++++++++++++-------------------
 docs/conf.py              |  570 ++++++++++----------
 2 files changed, 808 insertions(+), 808 deletions(-)

diff --git a/django_select2/widgets.py b/django_select2/widgets.py
index 95c920a8..b0006e09 100644
--- a/django_select2/widgets.py
+++ b/django_select2/widgets.py
@@ -1,523 +1,523 @@
-"""
-Contains all the Django widgets for Select2.
-"""
-
-import logging
-from itertools import chain
-
-from django import forms
-from django.utils.encoding import force_unicode
-from django.utils.safestring import mark_safe
-from django.core.urlresolvers import reverse
-from django.utils.datastructures import MultiValueDict, MergeDict
-
-from .util import render_js_script, convert_to_js_string_arr, JSVar, JSFunction, JSFunctionInContext, \
-    convert_dict_to_js_map, convert_to_js_arr
-
-from . import __RENDER_SELECT2_STATICS as RENDER_SELECT2_STATICS
-
-logger = logging.getLogger(__name__)
-
-
-def get_select2_js_path():
-    from django.conf import settings
-    if settings.configured and settings.DEBUG:
-        return 'js/select2.js'
-    else:
-        return 'js/select2.min.js'
-
-
-### Light mixin and widgets ###
-
-class Select2Mixin(object):
-    """
-    The base mixin of all Select2 widgets.
-
-    This mixin is responsible for rendering the necessary Javascript and CSS codes which turns normal ``<select>``
-    markups into Select2 choice list.
-
-    The following Select2 otions are added by this mixin:-
-
-        * minimumResultsForSearch: ``6``
-        * placeholder: ``''``
-        * allowClear: ``True``
-        * multiple: ``False``
-        * closeOnSelect: ``False``
-
-    .. note:: Many of them would be removed by sub-classes depending on requirements.
-    """
-
-    # For details on these options refer: http://ivaynberg.github.com/select2/#documentation
-    options = {
-        'minimumResultsForSearch': 6,  # Only applicable for single value select.
-        'placeholder': '',  # Empty text label
-        'allowClear': True,  # Not allowed when field is multiple since there each value has a clear button.
-        'multiple': False,  # Not allowed when attached to <select>
-        'closeOnSelect': False,
-    }
-    """
-    The options listed in this are rendered as JS map and passed to Select2 JS code.
-    The complete description of theses options are available in Select2_ JS' site.
-
-    .. _Select2: http://ivaynberg.github.com/select2/#documentation.
-    """
-
-    def __init__(self, **kwargs):
-        """
-        Constructor of the class.
-
-        The following additional kwarg is allowed:-
-
-        :param select2_options: This is similar to standard Django way to pass extra attributes to widgets.
-            This is meant to override values of existing :py:attr:`.options`.
-
-            Example::
-
-                class MyForm(ModelForm):
-                    class Meta:
-                        model = MyModel
-                        widgets = {
-                            'name': Select2WidgetName(select2_options={
-                                'minimumResultsForSearch': 10,
-                                'closeOnSelect': True,
-                                })
-                        }
-
-            .. tip:: You cannot introduce new options using this. For that you should sub-class and overried
-                :py:meth:`.init_options`. The reason for this is, few options are not compatible with each other
-                or are not applicable in some scenarios. For example, when Select2 is attached to ``<select>`` tag,
-                it can get if it is multiple or single valued from that tag itself. In this case if you specify
-                ``multiple`` option then not only it is useless but an error in Select2 JS' point of view.
-
-                There are other such intricacies, based on which some options are removed. By enforcing this
-                restriction we make sure to not break the code by passing some wrong concotion of options.
-
-        :type select2_options: :py:obj:`dict` or None
-
-        """
-        # Making an instance specific copy
-        self.options = dict(self.options)
-        self.init_options()
-        select2_options = kwargs.pop('select2_options', None)
-        if select2_options:
-            for name in self.options:
-                val = self.options[name]
-                self.options[name] = select2_options.get(name, val)
-
-        super(Select2Mixin, self).__init__(**kwargs)
-
-    def init_options(self):
-        """
-        Sub-classes can use this to pass additional options to Select2 JS library.
-
-        Example::
-
-            def init_options(self):
-                self.options['createSearchChoice'] = JSFunction('Your_js_function')
-
-        In the above example we are setting ``Your_js_function`` as Select2's ``createSearchChoice``
-        function.
-
-        .. tip:: If you want to run ``Your_js_function`` in the context of the Select2 DOM element,
-            i.e. ``this`` inside your JS function should point to the component instead of ``window``, then
-            use :py:class:`~.util.JSFunctionInContext` instead of :py:class:`~.util.JSFunction`.
-        """
-        pass
-
-    def set_placeholder(self, val):
-        """
-        Placeholder is a value which Select2 JS library shows when nothing is selected. This should be string.
-
-        :return: None
-        """
-        self.options['placeholder'] = val
-
-    def get_options(self):
-        """
-        :return: Dictionary of options to be passed to Select2 JS.
-
-        :rtype: :py:obj:`dict`
-        """
-        options = dict(self.options)
-        if options.get('allowClear', None) is not None:
-            options['allowClear'] = not self.is_required
-        return options
-
-    def render_js_code(self, id_, *args):
-        """
-        Renders the ``<script>`` block which contains the JS code for this widget.
-
-        :return: The rendered JS code enclosed inside ``<script>`` block.
-        :rtype: :py:obj:`unicode`
-        """
-        if id_:
-            return render_js_script(self.render_inner_js_code(id_, *args))
-        return u''
-
-    def render_inner_js_code(self, id_, *args):
-        """
-        Renders all the JS code required for this widget.
-
-        :return: The rendered JS code which will be later enclosed inside ``<script>`` block.
-        :rtype: :py:obj:`unicode`
-        """
-        options = dict(self.get_options())
-        options = convert_dict_to_js_map(options, id_)
-
-        return u'$("#%s").select2(%s);' % (id_, options)
-
-    def render(self, name, value, attrs=None, choices=()):
-        """
-        Renders this widget. Html and JS code blocks all are rendered by this.
-
-        :return: The rendered markup.
-        :rtype: :py:obj:`unicode`
-        """
-        args = [name, value, attrs]
-        if choices:
-            args.append(choices)
-
-        s = unicode(super(Select2Mixin, self).render(*args))  # Thanks to @ouhouhsami Issue#1
-        if RENDER_SELECT2_STATICS:
-            s += self.media.render()
-        final_attrs = self.build_attrs(attrs)
-        id_ = final_attrs.get('id', None)
-        s += self.render_js_code(id_, name, value, attrs, choices)
-
-        if logger.isEnabledFor(logging.DEBUG):
-            logger.debug("Generated widget code:-\n%s", s)
-
-        return mark_safe(s)
-
-    class Media:
-        js = (get_select2_js_path(), )
-        css = {'screen': ('css/select2.css', 'css/extra.css', )}
-
-
-class Select2Widget(Select2Mixin, forms.Select):
-    """
-    Drop-in Select2 replacement for :py:class:`forms.Select`.
-
-    Following Select2 option from :py:attr:`.Select2Mixin.options` is removed:-
-
-        * multiple
-
-    """
-
-    def init_options(self):
-        self.options.pop('multiple', None)
-
-    def render_options(self, choices, selected_choices):
-        if not self.is_required:
-            choices = list(choices)
-            choices.append(('', '', ))  # Adding an empty choice
-        return super(Select2Widget, self).render_options(choices, selected_choices)
-
-
-class Select2MultipleWidget(Select2Mixin, forms.SelectMultiple):
-    """
-    Drop-in Select2 replacement for :py:class:`forms.SelectMultiple`.
-
-    Following Select2 options from :py:attr:`.Select2Mixin.options` are removed:-
-
-        * multiple
-        * allowClear
-        * minimumResultsForSearch
-
-    """
-
-    def init_options(self):
-        self.options.pop('multiple', None)
-        self.options.pop('allowClear', None)
-        self.options.pop('minimumResultsForSearch', None)
-
-
-### Specialized Multiple Hidden Input Widget ###
-class MultipleSelect2HiddenInput(forms.TextInput):
-    """
-    Multiple hidden input for Select2.
-
-    This is a specialized multiple Hidden Input widget. This includes a special
-    JS component which renders multiple Hidden Input boxes as there are values.
-    So, if user suppose chooses values 1, 4 and 9 then Select2 would would write them
-    to the primary hidden input. The JS component of this widget will read that value and
-    will render three more hidden input boxes each with values 1, 4 and 9 respectively.
-    They will all share the name of this field, and the name of the primary source
-    hidden input would be removed. This way, when submitted all the selected values
-    would be available as list.
-    """
-    # We want it hidden but should be treated as if is_hidden is False
-    input_type = 'hidden'
-
-    def render(self, name, value, attrs=None, choices=()):
-        attrs = self.build_attrs(attrs, multiple='multiple')
-        s = unicode(super(MultipleSelect2HiddenInput, self).render(name, u"", attrs))
-        id_ = attrs.get('id', None)
-        if id_:
-            jscode = u''
-            if value:
-                jscode = u"$('#%s').val(django_select2.convertArrToStr(%s));" \
-                    % (id_, convert_to_js_arr(value, id_))
-            jscode += u"django_select2.initMultipleHidden($('#%s'));" % id_
-            s += render_js_script(jscode)
-        return s
-
-    def value_from_datadict(self, data, files, name):
-        if isinstance(data, (MultiValueDict, MergeDict)):
-            return data.getlist(name)
-        return data.get(name, None)
-
-
-### Heavy mixins and widgets ###
-
-class HeavySelect2Mixin(Select2Mixin):
-    """
-    The base mixin of all Heavy Select2 widgets. It sub-classes :py:class:`Select2Mixin`.
-
-    This mixin adds more Select2 options to :py:attr:`.Select2Mixin.options`. These are:-
-
-        * minimumInputLength: ``2``
-        * initSelection: ``JSFunction('django_select2.onInit')``
-        * ajax:
-            * dataType: ``'json'``
-            * quietMillis: ``100``
-            * data: ``JSFunctionInContext('django_select2.get_url_params')``
-            * results: ``JSFunctionInContext('django_select2.process_results')``
-
-    .. tip:: You can override these options by passing ``select2_options`` kwarg to :py:meth:`.__init__`.
-    """
-
-    def __init__(self, **kwargs):
-        """
-        Constructor of the class.
-
-        The following kwargs are allowed:-
-
-        :param data_view: A :py:class:`~.views.Select2View` sub-class which can respond to this widget's Ajax queries.
-        :type data_view: :py:class:`django.views.generic.base.View` or None
-
-        :param data_url: Url which will respond to Ajax queries with JSON object.
-        :type data_url: :py:obj:`str` or None
-
-        .. tip:: When ``data_view`` is provided then it is converted into Url using
-            :py:func:`~django.core.urlresolvers.reverse`.
-
-        .. warning:: Either of ``data_view`` or ``data_url`` must be specified, else :py:exc:`ValueError` would
-            be raised.
-
-        :param choices: The list of available choices. If not provided then empty list is used instead. It
-            should be of the form -- ``[(val1, 'Label1'), (val2, 'Label2'), ...]``.
-        :type choices: :py:obj:`list` or :py:obj:`tuple`
-
-        :param userGetValTextFuncName: The name of the custom JS function which you want to use to convert
-            value to label.
-
-            In ``heavy_data.js``, ``django_select2.getValText()`` employs the following logic to convert value
-            to label :-
-
-                1. First check if the Select2 input field has ``txt`` attribute set along with ``value``. If found
-                then use it.
-
-                2. Otherwise, check if user has provided any custom method for this. Then use that. If it returns a
-                label then use it.
-
-                3. Otherwise, check the cached results. When the user searches in the fields then all the returned
-                responses from server, which has the value and label mapping, are cached by ``heavy_data.js``.
-
-                4. If we still do not have the label then check the cookies. When user selects some value then
-                ``heavy_data.js`` stores the selected values and their labels in the cookies. These are cleared
-                when browser is closed.
-        """
-        self.field = None
-        self.options = dict(self.options)  # Making an instance specific copy
-        self.view = kwargs.pop('data_view', None)
-        self.url = kwargs.pop('data_url', None)
-        self.userGetValTextFuncName = kwargs.pop('userGetValTextFuncName', u'null')
-        self.choices = kwargs.pop('choices', [])
-
-        if not self.view and not self.url:
-            raise ValueError('data_view or data_url is required')
-
-        self.options['ajax'] = {
-            'dataType': 'json',
-            'quietMillis': 100,
-            'data': JSFunctionInContext('django_select2.get_url_params'),
-            'results': JSFunctionInContext('django_select2.process_results'),
-        }
-        self.options['minimumInputLength'] = 2
-        self.options['initSelection'] = JSFunction('django_select2.onInit')
-        super(HeavySelect2Mixin, self).__init__(**kwargs)
-
-    def render_texts(self, selected_choices, choices):
-        """
-        Renders a JS array with labels for the ``selected_choices``.
-
-        :param selected_choices: List of selected choices' values.
-        :type selected_choices: :py:obj:`list` or :py:obj:`tuple`
-
-        :param choices: Extra choices, if any. This is a list of tuples. In each tuple, the first
-            item is the choice value and the second item is choice label.
-        :type choices: :py:obj:`list` or :py:obj:`tuple`
-
-        :return: The rendered JS array code.
-        :rtype: :py:obj:`unicode`
-        """
-        selected_choices = list(force_unicode(v) for v in selected_choices)
-        txts = []
-        all_choices = choices if choices else []
-        for val, txt in chain(self.choices, all_choices):
-            val = force_unicode(val)
-            if val in selected_choices:
-                selected_choices = [v for v in selected_choices if v != val]
-                txts.append(txt)
-        if hasattr(self.field, '_get_val_txt') and selected_choices:
-            for val in selected_choices:
-                txt = self.field._get_val_txt(val)
-                if txt is not None:
-                    txts.append(txt)
-        if txts:
-            return convert_to_js_string_arr(txts)
-
-    def get_options(self):
-        if self.url is None:
-            # We lazy resolve the view. By this time Url conf would been loaded fully.
-            self.url = reverse(self.view)
-
-        if self.options['ajax'].get('url', None) is None:
-            self.options['ajax']['url'] = self.url
-
-        return super(HeavySelect2Mixin, self).get_options()
-
-    def render_texts_for_value(self, id_, value, choices):
-        """
-        Renders the JS code which sets the ``txt`` attribute on the field. It gets the array
-        of lables from :py:meth:`.render_texts`.
-
-        :param id_: Id of the field. This can be used to get reference of this field's DOM in JS.
-        :type id_: :py:obj:`str`
-
-        :param value: Currently set value on the field.
-        :type value: Any
-
-        :param choices: Extra choices, if any. This is a list of tuples. In each tuple, the first
-            item is the choice value and the second item is choice label.
-        :type choices: :py:obj:`list` or :py:obj:`tuple`
-
-        :return: JS code which sets the ``txt`` attribute.
-        :rtype: :py:obj:`unicode`
-        """
-        if value is not None:
-            # Just like forms.Select.render() it assumes that value will be single valued.
-            values = [value]
-            texts = self.render_texts(values, choices)
-            if texts:
-                return u"$('#%s').txt(%s);" % (id_, texts)
-
-    def render_inner_js_code(self, id_, name, value, attrs=None, choices=(), *args):
-        js = u"$('#%s').change(django_select2.onValChange).data('userGetValText', %s);" \
-            % (id_, self.userGetValTextFuncName)
-        texts = self.render_texts_for_value(id_, value, choices)
-        if texts:
-            js += texts
-        js += super(HeavySelect2Mixin, self).render_inner_js_code(id_, name, value, attrs, choices, *args)
-        return js
-
-    class Media:
-        js = (get_select2_js_path(), 'js/heavy_data.js', )
-        css = {'screen': ('css/select2.css', 'css/extra.css', )}
-
-
-class HeavySelect2Widget(HeavySelect2Mixin, forms.TextInput):
-    """
-    Single selection heavy widget.
-
-    Following Select2 option from :py:attr:`.Select2Mixin.options` is added or set:-
-
-        * multiple: ``False``
-
-    """
-    # We want it hidden but should be treated as if is_hidden is False
-    input_type = 'hidden'
-
-    def init_options(self):
-        self.options['multiple'] = False
-
-
-class HeavySelect2MultipleWidget(HeavySelect2Mixin, MultipleSelect2HiddenInput):
-    """
-    Multiple selection heavy widget.
-
-    Following Select2 options from :py:attr:`.Select2Mixin.options` are removed:-
-
-        * allowClear
-        * minimumResultsForSearch
-
-    Following Select2 options from :py:attr:`.Select2Mixin.options` are added or set:-
-
-        * multiple: ``False``
-        * separator: ``JSVar('django_select2.MULTISEPARATOR')``
-
-    """
-
-    def init_options(self):
-        self.options['multiple'] = True
-        self.options.pop('allowClear', None)
-        self.options.pop('minimumResultsForSearch', None)
-        self.options['separator'] = JSVar('django_select2.MULTISEPARATOR')
-
-    def render_texts_for_value(self, id_, value, choices):
-        """
-        Renders the JS code which sets the ``txt`` attribute on the field. It gets the array
-        of lables from :py:meth:`.render_texts`.
-
-        :param id_: Id of the field. This can be used to get reference of this field's DOM in JS.
-        :type id_: :py:obj:`str`
-
-        :param value: **List** of currently set value on the field.
-        :type value: :py:obj:`list`
-
-        :param choices: Extra choices, if any. This is a list of tuples. In each tuple, the first
-            item is the choice value and the second item is choice label.
-        :type choices: :py:obj:`list` or :py:obj:`tuple`
-
-        :return: JS code which sets the ``txt`` attribute.
-        :rtype: :py:obj:`unicode`
-        """
-        # Just like forms.SelectMultiple.render() it assumes that value will be multi-valued (list).
-        if value:
-            texts = self.render_texts(value, choices)
-            if texts:
-                return u"$('#%s').txt(%s);" % (id_, texts)
-
-
-### Auto Heavy widgets ###
-
-class AutoHeavySelect2Mixin(object):
-    """
-    This mixin is needed for Auto heavy fields.
-
-    This mxin adds extra JS code to notify the field's DOM object of the generated id. The generated id
-    is not the same as the ``id`` attribute of the field's Html markup. This id is generated by
-    :py:func:`~.util.register_field` when the Auto field is registered. The client side (DOM) sends this
-    id along with the Ajax request, so that the central view can identify which field should be used to
-    serve the request.
-    """
-
-    def __init__(self, *args, **kwargs):
-        kwargs['data_view'] = "django_select2_central_json"
-        super(AutoHeavySelect2Mixin, self).__init__(*args, **kwargs)
-
-    def render_inner_js_code(self, id_, *args):
-        js = u"$('#%s').data('field_id', '%s');" % (id_, self.field_id)
-        js += super(AutoHeavySelect2Mixin, self).render_inner_js_code(id_, *args)
-        return js
-
-
-class AutoHeavySelect2Widget(AutoHeavySelect2Mixin, HeavySelect2Widget):
-    "Auto version of :py:class:`.HeavySelect2Widget`"
-    pass
-
-
-class AutoHeavySelect2MultipleWidget(AutoHeavySelect2Mixin, HeavySelect2MultipleWidget):
-    "Auto version of :py:class:`.HeavySelect2MultipleWidget`"
-    pass
+"""
+Contains all the Django widgets for Select2.
+"""
+
+import logging
+from itertools import chain
+
+from django import forms
+from django.utils.encoding import force_unicode
+from django.utils.safestring import mark_safe
+from django.core.urlresolvers import reverse
+from django.utils.datastructures import MultiValueDict, MergeDict
+
+from .util import render_js_script, convert_to_js_string_arr, JSVar, JSFunction, JSFunctionInContext, \
+    convert_dict_to_js_map, convert_to_js_arr
+
+from . import __RENDER_SELECT2_STATICS as RENDER_SELECT2_STATICS
+
+logger = logging.getLogger(__name__)
+
+
+def get_select2_js_path():
+    from django.conf import settings
+    if settings.configured and settings.DEBUG:
+        return 'js/select2.js'
+    else:
+        return 'js/select2.min.js'
+
+
+### Light mixin and widgets ###
+
+class Select2Mixin(object):
+    """
+    The base mixin of all Select2 widgets.
+
+    This mixin is responsible for rendering the necessary Javascript and CSS codes which turns normal ``<select>``
+    markups into Select2 choice list.
+
+    The following Select2 otions are added by this mixin:-
+
+        * minimumResultsForSearch: ``6``
+        * placeholder: ``''``
+        * allowClear: ``True``
+        * multiple: ``False``
+        * closeOnSelect: ``False``
+
+    .. note:: Many of them would be removed by sub-classes depending on requirements.
+    """
+
+    # For details on these options refer: http://ivaynberg.github.com/select2/#documentation
+    options = {
+        'minimumResultsForSearch': 6,  # Only applicable for single value select.
+        'placeholder': '',  # Empty text label
+        'allowClear': True,  # Not allowed when field is multiple since there each value has a clear button.
+        'multiple': False,  # Not allowed when attached to <select>
+        'closeOnSelect': False,
+    }
+    """
+    The options listed in this are rendered as JS map and passed to Select2 JS code.
+    The complete description of theses options are available in Select2_ JS' site.
+
+    .. _Select2: http://ivaynberg.github.com/select2/#documentation.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Constructor of the class.
+
+        The following additional kwarg is allowed:-
+
+        :param select2_options: This is similar to standard Django way to pass extra attributes to widgets.
+            This is meant to override values of existing :py:attr:`.options`.
+
+            Example::
+
+                class MyForm(ModelForm):
+                    class Meta:
+                        model = MyModel
+                        widgets = {
+                            'name': Select2WidgetName(select2_options={
+                                'minimumResultsForSearch': 10,
+                                'closeOnSelect': True,
+                                })
+                        }
+
+            .. tip:: You cannot introduce new options using this. For that you should sub-class and overried
+                :py:meth:`.init_options`. The reason for this is, few options are not compatible with each other
+                or are not applicable in some scenarios. For example, when Select2 is attached to ``<select>`` tag,
+                it can get if it is multiple or single valued from that tag itself. In this case if you specify
+                ``multiple`` option then not only it is useless but an error in Select2 JS' point of view.
+
+                There are other such intricacies, based on which some options are removed. By enforcing this
+                restriction we make sure to not break the code by passing some wrong concotion of options.
+
+        :type select2_options: :py:obj:`dict` or None
+
+        """
+        # Making an instance specific copy
+        self.options = dict(self.options)
+        self.init_options()
+        select2_options = kwargs.pop('select2_options', None)
+        if select2_options:
+            for name in self.options:
+                val = self.options[name]
+                self.options[name] = select2_options.get(name, val)
+
+        super(Select2Mixin, self).__init__(**kwargs)
+
+    def init_options(self):
+        """
+        Sub-classes can use this to pass additional options to Select2 JS library.
+
+        Example::
+
+            def init_options(self):
+                self.options['createSearchChoice'] = JSFunction('Your_js_function')
+
+        In the above example we are setting ``Your_js_function`` as Select2's ``createSearchChoice``
+        function.
+
+        .. tip:: If you want to run ``Your_js_function`` in the context of the Select2 DOM element,
+            i.e. ``this`` inside your JS function should point to the component instead of ``window``, then
+            use :py:class:`~.util.JSFunctionInContext` instead of :py:class:`~.util.JSFunction`.
+        """
+        pass
+
+    def set_placeholder(self, val):
+        """
+        Placeholder is a value which Select2 JS library shows when nothing is selected. This should be string.
+
+        :return: None
+        """
+        self.options['placeholder'] = val
+
+    def get_options(self):
+        """
+        :return: Dictionary of options to be passed to Select2 JS.
+
+        :rtype: :py:obj:`dict`
+        """
+        options = dict(self.options)
+        if options.get('allowClear', None) is not None:
+            options['allowClear'] = not self.is_required
+        return options
+
+    def render_js_code(self, id_, *args):
+        """
+        Renders the ``<script>`` block which contains the JS code for this widget.
+
+        :return: The rendered JS code enclosed inside ``<script>`` block.
+        :rtype: :py:obj:`unicode`
+        """
+        if id_:
+            return render_js_script(self.render_inner_js_code(id_, *args))
+        return u''
+
+    def render_inner_js_code(self, id_, *args):
+        """
+        Renders all the JS code required for this widget.
+
+        :return: The rendered JS code which will be later enclosed inside ``<script>`` block.
+        :rtype: :py:obj:`unicode`
+        """
+        options = dict(self.get_options())
+        options = convert_dict_to_js_map(options, id_)
+
+        return u'$("#%s").select2(%s);' % (id_, options)
+
+    def render(self, name, value, attrs=None, choices=()):
+        """
+        Renders this widget. Html and JS code blocks all are rendered by this.
+
+        :return: The rendered markup.
+        :rtype: :py:obj:`unicode`
+        """
+        args = [name, value, attrs]
+        if choices:
+            args.append(choices)
+
+        s = unicode(super(Select2Mixin, self).render(*args))  # Thanks to @ouhouhsami Issue#1
+        if RENDER_SELECT2_STATICS:
+            s += self.media.render()
+        final_attrs = self.build_attrs(attrs)
+        id_ = final_attrs.get('id', None)
+        s += self.render_js_code(id_, name, value, attrs, choices)
+
+        if logger.isEnabledFor(logging.DEBUG):
+            logger.debug("Generated widget code:-\n%s", s)
+
+        return mark_safe(s)
+
+    class Media:
+        js = (get_select2_js_path(), )
+        css = {'screen': ('css/select2.css', 'css/extra.css', )}
+
+
+class Select2Widget(Select2Mixin, forms.Select):
+    """
+    Drop-in Select2 replacement for :py:class:`forms.Select`.
+
+    Following Select2 option from :py:attr:`.Select2Mixin.options` is removed:-
+
+        * multiple
+
+    """
+
+    def init_options(self):
+        self.options.pop('multiple', None)
+
+    def render_options(self, choices, selected_choices):
+        if not self.is_required:
+            choices = list(choices)
+            choices.append(('', '', ))  # Adding an empty choice
+        return super(Select2Widget, self).render_options(choices, selected_choices)
+
+
+class Select2MultipleWidget(Select2Mixin, forms.SelectMultiple):
+    """
+    Drop-in Select2 replacement for :py:class:`forms.SelectMultiple`.
+
+    Following Select2 options from :py:attr:`.Select2Mixin.options` are removed:-
+
+        * multiple
+        * allowClear
+        * minimumResultsForSearch
+
+    """
+
+    def init_options(self):
+        self.options.pop('multiple', None)
+        self.options.pop('allowClear', None)
+        self.options.pop('minimumResultsForSearch', None)
+
+
+### Specialized Multiple Hidden Input Widget ###
+class MultipleSelect2HiddenInput(forms.TextInput):
+    """
+    Multiple hidden input for Select2.
+
+    This is a specialized multiple Hidden Input widget. This includes a special
+    JS component which renders multiple Hidden Input boxes as there are values.
+    So, if user suppose chooses values 1, 4 and 9 then Select2 would would write them
+    to the primary hidden input. The JS component of this widget will read that value and
+    will render three more hidden input boxes each with values 1, 4 and 9 respectively.
+    They will all share the name of this field, and the name of the primary source
+    hidden input would be removed. This way, when submitted all the selected values
+    would be available as list.
+    """
+    # We want it hidden but should be treated as if is_hidden is False
+    input_type = 'hidden'
+
+    def render(self, name, value, attrs=None, choices=()):
+        attrs = self.build_attrs(attrs, multiple='multiple')
+        s = unicode(super(MultipleSelect2HiddenInput, self).render(name, u"", attrs))
+        id_ = attrs.get('id', None)
+        if id_:
+            jscode = u''
+            if value:
+                jscode = u"$('#%s').val(django_select2.convertArrToStr(%s));" \
+                    % (id_, convert_to_js_arr(value, id_))
+            jscode += u"django_select2.initMultipleHidden($('#%s'));" % id_
+            s += render_js_script(jscode)
+        return s
+
+    def value_from_datadict(self, data, files, name):
+        if isinstance(data, (MultiValueDict, MergeDict)):
+            return data.getlist(name)
+        return data.get(name, None)
+
+
+### Heavy mixins and widgets ###
+
+class HeavySelect2Mixin(Select2Mixin):
+    """
+    The base mixin of all Heavy Select2 widgets. It sub-classes :py:class:`Select2Mixin`.
+
+    This mixin adds more Select2 options to :py:attr:`.Select2Mixin.options`. These are:-
+
+        * minimumInputLength: ``2``
+        * initSelection: ``JSFunction('django_select2.onInit')``
+        * ajax:
+            * dataType: ``'json'``
+            * quietMillis: ``100``
+            * data: ``JSFunctionInContext('django_select2.get_url_params')``
+            * results: ``JSFunctionInContext('django_select2.process_results')``
+
+    .. tip:: You can override these options by passing ``select2_options`` kwarg to :py:meth:`.__init__`.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Constructor of the class.
+
+        The following kwargs are allowed:-
+
+        :param data_view: A :py:class:`~.views.Select2View` sub-class which can respond to this widget's Ajax queries.
+        :type data_view: :py:class:`django.views.generic.base.View` or None
+
+        :param data_url: Url which will respond to Ajax queries with JSON object.
+        :type data_url: :py:obj:`str` or None
+
+        .. tip:: When ``data_view`` is provided then it is converted into Url using
+            :py:func:`~django.core.urlresolvers.reverse`.
+
+        .. warning:: Either of ``data_view`` or ``data_url`` must be specified, else :py:exc:`ValueError` would
+            be raised.
+
+        :param choices: The list of available choices. If not provided then empty list is used instead. It
+            should be of the form -- ``[(val1, 'Label1'), (val2, 'Label2'), ...]``.
+        :type choices: :py:obj:`list` or :py:obj:`tuple`
+
+        :param userGetValTextFuncName: The name of the custom JS function which you want to use to convert
+            value to label.
+
+            In ``heavy_data.js``, ``django_select2.getValText()`` employs the following logic to convert value
+            to label :-
+
+                1. First check if the Select2 input field has ``txt`` attribute set along with ``value``. If found
+                then use it.
+
+                2. Otherwise, check if user has provided any custom method for this. Then use that. If it returns a
+                label then use it.
+
+                3. Otherwise, check the cached results. When the user searches in the fields then all the returned
+                responses from server, which has the value and label mapping, are cached by ``heavy_data.js``.
+
+                4. If we still do not have the label then check the cookies. When user selects some value then
+                ``heavy_data.js`` stores the selected values and their labels in the cookies. These are cleared
+                when browser is closed.
+        """
+        self.field = None
+        self.options = dict(self.options)  # Making an instance specific copy
+        self.view = kwargs.pop('data_view', None)
+        self.url = kwargs.pop('data_url', None)
+        self.userGetValTextFuncName = kwargs.pop('userGetValTextFuncName', u'null')
+        self.choices = kwargs.pop('choices', [])
+
+        if not self.view and not self.url:
+            raise ValueError('data_view or data_url is required')
+
+        self.options['ajax'] = {
+            'dataType': 'json',
+            'quietMillis': 100,
+            'data': JSFunctionInContext('django_select2.get_url_params'),
+            'results': JSFunctionInContext('django_select2.process_results'),
+        }
+        self.options['minimumInputLength'] = 2
+        self.options['initSelection'] = JSFunction('django_select2.onInit')
+        super(HeavySelect2Mixin, self).__init__(**kwargs)
+
+    def render_texts(self, selected_choices, choices):
+        """
+        Renders a JS array with labels for the ``selected_choices``.
+
+        :param selected_choices: List of selected choices' values.
+        :type selected_choices: :py:obj:`list` or :py:obj:`tuple`
+
+        :param choices: Extra choices, if any. This is a list of tuples. In each tuple, the first
+            item is the choice value and the second item is choice label.
+        :type choices: :py:obj:`list` or :py:obj:`tuple`
+
+        :return: The rendered JS array code.
+        :rtype: :py:obj:`unicode`
+        """
+        selected_choices = list(force_unicode(v) for v in selected_choices)
+        txts = []
+        all_choices = choices if choices else []
+        for val, txt in chain(self.choices, all_choices):
+            val = force_unicode(val)
+            if val in selected_choices:
+                selected_choices = [v for v in selected_choices if v != val]
+                txts.append(txt)
+        if hasattr(self.field, '_get_val_txt') and selected_choices:
+            for val in selected_choices:
+                txt = self.field._get_val_txt(val)
+                if txt is not None:
+                    txts.append(txt)
+        if txts:
+            return convert_to_js_string_arr(txts)
+
+    def get_options(self):
+        if self.url is None:
+            # We lazy resolve the view. By this time Url conf would been loaded fully.
+            self.url = reverse(self.view)
+
+        if self.options['ajax'].get('url', None) is None:
+            self.options['ajax']['url'] = self.url
+
+        return super(HeavySelect2Mixin, self).get_options()
+
+    def render_texts_for_value(self, id_, value, choices):
+        """
+        Renders the JS code which sets the ``txt`` attribute on the field. It gets the array
+        of lables from :py:meth:`.render_texts`.
+
+        :param id_: Id of the field. This can be used to get reference of this field's DOM in JS.
+        :type id_: :py:obj:`str`
+
+        :param value: Currently set value on the field.
+        :type value: Any
+
+        :param choices: Extra choices, if any. This is a list of tuples. In each tuple, the first
+            item is the choice value and the second item is choice label.
+        :type choices: :py:obj:`list` or :py:obj:`tuple`
+
+        :return: JS code which sets the ``txt`` attribute.
+        :rtype: :py:obj:`unicode`
+        """
+        if value is not None:
+            # Just like forms.Select.render() it assumes that value will be single valued.
+            values = [value]
+            texts = self.render_texts(values, choices)
+            if texts:
+                return u"$('#%s').txt(%s);" % (id_, texts)
+
+    def render_inner_js_code(self, id_, name, value, attrs=None, choices=(), *args):
+        js = u"$('#%s').change(django_select2.onValChange).data('userGetValText', %s);" \
+            % (id_, self.userGetValTextFuncName)
+        texts = self.render_texts_for_value(id_, value, choices)
+        if texts:
+            js += texts
+        js += super(HeavySelect2Mixin, self).render_inner_js_code(id_, name, value, attrs, choices, *args)
+        return js
+
+    class Media:
+        js = (get_select2_js_path(), 'js/heavy_data.js', )
+        css = {'screen': ('css/select2.css', 'css/extra.css', )}
+
+
+class HeavySelect2Widget(HeavySelect2Mixin, forms.TextInput):
+    """
+    Single selection heavy widget.
+
+    Following Select2 option from :py:attr:`.Select2Mixin.options` is added or set:-
+
+        * multiple: ``False``
+
+    """
+    # We want it hidden but should be treated as if is_hidden is False
+    input_type = 'hidden'
+
+    def init_options(self):
+        self.options['multiple'] = False
+
+
+class HeavySelect2MultipleWidget(HeavySelect2Mixin, MultipleSelect2HiddenInput):
+    """
+    Multiple selection heavy widget.
+
+    Following Select2 options from :py:attr:`.Select2Mixin.options` are removed:-
+
+        * allowClear
+        * minimumResultsForSearch
+
+    Following Select2 options from :py:attr:`.Select2Mixin.options` are added or set:-
+
+        * multiple: ``False``
+        * separator: ``JSVar('django_select2.MULTISEPARATOR')``
+
+    """
+
+    def init_options(self):
+        self.options['multiple'] = True
+        self.options.pop('allowClear', None)
+        self.options.pop('minimumResultsForSearch', None)
+        self.options['separator'] = JSVar('django_select2.MULTISEPARATOR')
+
+    def render_texts_for_value(self, id_, value, choices):
+        """
+        Renders the JS code which sets the ``txt`` attribute on the field. It gets the array
+        of lables from :py:meth:`.render_texts`.
+
+        :param id_: Id of the field. This can be used to get reference of this field's DOM in JS.
+        :type id_: :py:obj:`str`
+
+        :param value: **List** of currently set value on the field.
+        :type value: :py:obj:`list`
+
+        :param choices: Extra choices, if any. This is a list of tuples. In each tuple, the first
+            item is the choice value and the second item is choice label.
+        :type choices: :py:obj:`list` or :py:obj:`tuple`
+
+        :return: JS code which sets the ``txt`` attribute.
+        :rtype: :py:obj:`unicode`
+        """
+        # Just like forms.SelectMultiple.render() it assumes that value will be multi-valued (list).
+        if value:
+            texts = self.render_texts(value, choices)
+            if texts:
+                return u"$('#%s').txt(%s);" % (id_, texts)
+
+
+### Auto Heavy widgets ###
+
+class AutoHeavySelect2Mixin(object):
+    """
+    This mixin is needed for Auto heavy fields.
+
+    This mxin adds extra JS code to notify the field's DOM object of the generated id. The generated id
+    is not the same as the ``id`` attribute of the field's Html markup. This id is generated by
+    :py:func:`~.util.register_field` when the Auto field is registered. The client side (DOM) sends this
+    id along with the Ajax request, so that the central view can identify which field should be used to
+    serve the request.
+    """
+
+    def __init__(self, *args, **kwargs):
+        kwargs['data_view'] = "django_select2_central_json"
+        super(AutoHeavySelect2Mixin, self).__init__(*args, **kwargs)
+
+    def render_inner_js_code(self, id_, *args):
+        js = u"$('#%s').data('field_id', '%s');" % (id_, self.field_id)
+        js += super(AutoHeavySelect2Mixin, self).render_inner_js_code(id_, *args)
+        return js
+
+
+class AutoHeavySelect2Widget(AutoHeavySelect2Mixin, HeavySelect2Widget):
+    "Auto version of :py:class:`.HeavySelect2Widget`"
+    pass
+
+
+class AutoHeavySelect2MultipleWidget(AutoHeavySelect2Mixin, HeavySelect2MultipleWidget):
+    "Auto version of :py:class:`.HeavySelect2MultipleWidget`"
+    pass
diff --git a/docs/conf.py b/docs/conf.py
index bd47e85e..3fb76c00 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,285 +1,285 @@
-# -*- coding: utf-8 -*-
-#
-# Django-Select2 documentation build configuration file, created by
-# sphinx-quickstart on Sat Aug 25 10:23:46 2012.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys, os
-
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
-
-# This is needed since django_select2 requires django model modules
-# and those modules assume that django settings is configured and
-# have proper DB settings.
-# Using this we give a proper environment with working django settings.
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testapp.settings")
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../testapp'))
-sys.path.insert(0, os.path.abspath('..'))
-
-import datetime
-year = datetime.datetime.now().strftime("%Y")
-
-# -- General configuration -----------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc',  'sphinx.ext.inheritance_diagram', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode']
-
-intersphinx_mapping = {
-    'python': ('http://docs.python.org/2.7', None),
-    'django': ('https://docs.djangoproject.com/en/1.4/',
-      'http://www.applegrew.com/others/django.inv'),
-      #'http://docs.djangoproject.com/en/1.4/_objects/'),
-}
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'Django-Select2'
-copyright = u'%s, Nirupam Biswas' % year
-
-def get_version():
-  import django_select2
-  return django_select2.__version__
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = get_version()
-# The full version, including alpha/beta/rc tags.
-release = version
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-def skip(app, what, name, obj, skip, options):
-  if name == "__init__" and obj.__doc__:
-    return False
-  return skip
-
-def setup(app):
-  app.connect("autodoc-skip-member", skip)
-
-autodoc_default_flags = ['members', 'show-inheritance']
-autodoc_member_order = 'bysource'
-
-inheritance_graph_attrs = dict(rankdir="TB", size='""')
-
-inheritance_node_attrs = dict(shape='ellipse', fontsize=9,
-                              color='"#97C9FD"', style='filled')
-
-inheritance_edge_attrs = dict(penwidth=0.75)
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-if on_rtd:
-  html_theme = 'default'
-else:
-  html_theme = 'nature'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'Django-Select2doc'
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
-  ('index', 'Django-Select2.tex', u'Django-Select2 Documentation',
-   u'Nirupam Biswas', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'django-select2', u'Django-Select2 Documentation',
-     [u'Nirupam Biswas'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output ------------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-  ('index', 'Django-Select2', u'Django-Select2 Documentation',
-   u'Nirupam Biswas', 'Django-Select2', 'One line description of project.',
-   'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# -*- coding: utf-8 -*-
+#
+# Django-Select2 documentation build configuration file, created by
+# sphinx-quickstart on Sat Aug 25 10:23:46 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+# This is needed since django_select2 requires django model modules
+# and those modules assume that django settings is configured and
+# have proper DB settings.
+# Using this we give a proper environment with working django settings.
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testapp.settings")
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('../testapp'))
+sys.path.insert(0, os.path.abspath('..'))
+
+import datetime
+year = datetime.datetime.now().strftime("%Y")
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc',  'sphinx.ext.inheritance_diagram', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode']
+
+intersphinx_mapping = {
+    'python': ('http://docs.python.org/2.7', None),
+    'django': ('https://docs.djangoproject.com/en/1.4/',
+      'http://www.applegrew.com/others/django.inv'),
+      #'http://docs.djangoproject.com/en/1.4/_objects/'),
+}
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Django-Select2'
+copyright = u'%s, Nirupam Biswas' % year
+
+def get_version():
+  import django_select2
+  return django_select2.__version__
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = get_version()
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+def skip(app, what, name, obj, skip, options):
+  if name == "__init__" and obj.__doc__:
+    return False
+  return skip
+
+def setup(app):
+  app.connect("autodoc-skip-member", skip)
+
+autodoc_default_flags = ['members', 'show-inheritance']
+autodoc_member_order = 'bysource'
+
+inheritance_graph_attrs = dict(rankdir="TB", size='""')
+
+inheritance_node_attrs = dict(shape='ellipse', fontsize=9,
+                              color='"#97C9FD"', style='filled')
+
+inheritance_edge_attrs = dict(penwidth=0.75)
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+if on_rtd:
+  html_theme = 'default'
+else:
+  html_theme = 'nature'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Django-Select2doc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'Django-Select2.tex', u'Django-Select2 Documentation',
+   u'Nirupam Biswas', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'django-select2', u'Django-Select2 Documentation',
+     [u'Nirupam Biswas'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'Django-Select2', u'Django-Select2 Documentation',
+   u'Nirupam Biswas', 'Django-Select2', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'

From e828ba253c898ea8d4eb60736f7045d5c8804d14 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Raimbault?= <stephane.raimbault@gmail.com>
Date: Mon, 26 Nov 2012 18:25:12 +0100
Subject: [PATCH 3/5] Replace render_to_response by new render

It was a strange use of RequestContext by the way...
---
 django_select2/util.py            |  1 -
 testapp/testapp/testmain/forms.py |  2 +-
 testapp/testapp/testmain/views.py | 41 ++++++++++++++++---------------
 3 files changed, 22 insertions(+), 22 deletions(-)

diff --git a/django_select2/util.py b/django_select2/util.py
index 1b22a440..f04d0d38 100644
--- a/django_select2/util.py
+++ b/django_select2/util.py
@@ -290,7 +290,6 @@ def timer_end(t):
 
 def timer(f):
     def inner(*args, **kwargs):
-        
         t = timer_start(f.func_name)
         ret = f(*args, **kwargs)
         timer_end(t)
diff --git a/testapp/testapp/testmain/forms.py b/testapp/testapp/testmain/forms.py
index 986df0f4..f692399c 100644
--- a/testapp/testapp/testmain/forms.py
+++ b/testapp/testapp/testmain/forms.py
@@ -60,7 +60,7 @@ def get_results(self, request, term, page, context):
 class EmployeeForm(forms.ModelForm):
     manager = EmployeeChoices(required=False)
     dept = ModelSelect2Field(queryset=Dept.objects)
-    
+
     class Meta:
         model = Employee
 
diff --git a/testapp/testapp/testmain/views.py b/testapp/testapp/testmain/views.py
index 4bb75b7a..946d0635 100644
--- a/testapp/testapp/testmain/views.py
+++ b/testapp/testapp/testmain/views.py
@@ -1,20 +1,21 @@
 from django.core.urlresolvers import reverse
 from django.http import HttpResponseRedirect
-from django.shortcuts import render_to_response, get_object_or_404
-from django.template import RequestContext
+from django.shortcuts import render, get_object_or_404
 
 from .forms import EmployeeForm, DeptForm, MixedForm, InitialValueForm
 from .models import Employee, Dept
 
+
 def test_single_value_model_field(request):
-    return render_to_response('list.html', RequestContext(request, {
-    	'title': 'Employees',
-    	'href': 'test_single_value_model_field1',
-    	'object_list': Employee.objects.all()
-    	}))    
+    return render(request, 'list.html', {
+        'title': 'Employees',
+        'href': 'test_single_value_model_field1',
+        'object_list': Employee.objects.all()
+    })
+
 
 def test_single_value_model_field1(request, id):
-    emp =  get_object_or_404(Employee, pk=id)
+    emp = get_object_or_404(Employee, pk=id)
     if request.POST:
         form = EmployeeForm(data=request.POST, instance=emp)
         if form.is_valid():
@@ -22,18 +23,19 @@ def test_single_value_model_field1(request, id):
             return HttpResponseRedirect(reverse('home'))
     else:
         form = EmployeeForm(instance=emp)
-    return render_to_response('form.html', RequestContext(request, {'form': form}))
+    return render(request, 'form.html', {'form': form})
 
 
 def test_multi_values_model_field(request):
-    return render_to_response('list.html', RequestContext(request, {
-    	'title': 'Departments',
-    	'href': 'test_multi_values_model_field1',
-    	'object_list': Dept.objects.all()
-    	}))    
+    return render(request, 'list.html', {
+        'title': 'Departments',
+        'href': 'test_multi_values_model_field1',
+        'object_list': Dept.objects.all()
+    })
+
 
 def test_multi_values_model_field1(request, id):
-    dept =  get_object_or_404(Dept, pk=id)
+    dept = get_object_or_404(Dept, pk=id)
     if request.POST:
         form = DeptForm(data=request.POST, instance=dept)
         if form.is_valid():
@@ -41,7 +43,8 @@ def test_multi_values_model_field1(request, id):
             return HttpResponseRedirect(reverse('home'))
     else:
         form = DeptForm(instance=dept)
-    return render_to_response('form.html', RequestContext(request, {'form': form}))
+    return render(request, 'form.html', {'form': form})
+
 
 def test_mixed_form(request):
     if request.POST:
@@ -49,10 +52,8 @@ def test_mixed_form(request):
         form.is_valid()
     else:
         form = MixedForm()
-    return render_to_response('form.html', RequestContext(request, {'form': form}))
+    return render(request, 'form.html', {'form': form})
 
 
 def test_init_values(request):
-    return render_to_response('form.html', RequestContext(request, {'form': InitialValueForm()}))
-
-
+    return render(request, 'form.html', {'form': InitialValueForm()})

From ff2cbb2519ec780342545c58d58ca37313bdef36 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Raimbault?= <stephane.raimbault@gmail.com>
Date: Mon, 26 Nov 2012 21:05:50 +0100
Subject: [PATCH 4/5] Allow to use select2 options not listed in django-select2

---
 django_select2/widgets.py         | 13 ++++++-------
 testapp/testapp/testmain/forms.py |  8 ++++++++
 2 files changed, 14 insertions(+), 7 deletions(-)

diff --git a/django_select2/widgets.py b/django_select2/widgets.py
index b0006e09..971c11dd 100644
--- a/django_select2/widgets.py
+++ b/django_select2/widgets.py
@@ -56,8 +56,8 @@ class Select2Mixin(object):
         'closeOnSelect': False,
     }
     """
-    The options listed in this are rendered as JS map and passed to Select2 JS code.
-    The complete description of theses options are available in Select2_ JS' site.
+    The options listed here are rendered as JS map and passed to Select2 JS code.
+    Complete description of these options are available in Select2_ JS' site.
 
     .. _Select2: http://ivaynberg.github.com/select2/#documentation.
     """
@@ -80,7 +80,7 @@ class Meta:
                             'name': Select2WidgetName(select2_options={
                                 'minimumResultsForSearch': 10,
                                 'closeOnSelect': True,
-                                })
+                            })
                         }
 
             .. tip:: You cannot introduce new options using this. For that you should sub-class and overried
@@ -98,12 +98,11 @@ class Meta:
         # Making an instance specific copy
         self.options = dict(self.options)
         self.init_options()
+
         select2_options = kwargs.pop('select2_options', None)
         if select2_options:
-            for name in self.options:
-                val = self.options[name]
-                self.options[name] = select2_options.get(name, val)
-
+            for name, value in select2_options.items():
+                self.options[name] = value
         super(Select2Mixin, self).__init__(**kwargs)
 
     def init_options(self):
diff --git a/testapp/testapp/testmain/forms.py b/testapp/testapp/testmain/forms.py
index f692399c..c9174957 100644
--- a/testapp/testapp/testmain/forms.py
+++ b/testapp/testapp/testmain/forms.py
@@ -6,22 +6,27 @@
 
 ############# Choice fields ###################
 
+
 class EmployeeChoices(AutoModelSelect2Field):
     queryset = Employee.objects
     search_fields = ['name__icontains', ]
 
+
 class ClassRoomChoices(AutoModelSelect2MultipleField):
     queryset = ClassRoom.objects
     search_fields = ['number__icontains', ]
 
+
 class ClassRoomSingleChoices(AutoModelSelect2Field):
     queryset = ClassRoom.objects
     search_fields = ['number__icontains', ]
 
+
 class WordChoices(AutoModelSelect2Field):
     queryset = Word.objects
     search_fields = ['word__icontains', ]
 
+
 class SelfChoices(AutoSelect2Field):
     def get_results(self, request, term, page, context):
         res = []
@@ -31,6 +36,7 @@ def get_results(self, request, term, page, context):
 
         return (NO_ERR_RESP, False, res)
 
+
 class SelfMultiChoices(AutoSelect2MultipleField):
     big_data = {
         1: "First", 2: "Second", 3: "Third",
@@ -57,6 +63,7 @@ def get_results(self, request, term, page, context):
 
 ########### Forms ##############
 
+
 class EmployeeForm(forms.ModelForm):
     manager = EmployeeChoices(required=False)
     dept = ModelSelect2Field(queryset=Dept.objects)
@@ -64,6 +71,7 @@ class EmployeeForm(forms.ModelForm):
     class Meta:
         model = Employee
 
+
 class DeptForm(forms.ModelForm):
     allotted_rooms = ClassRoomChoices()
     allotted_labs = ModelSelect2MultipleField(queryset=Lab.objects, required=False)

From 42318c7ce68ffb1b721409d42aa0729f563de3f7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Raimbault?= <stephane.raimbault@gmail.com>
Date: Mon, 26 Nov 2012 21:16:41 +0100
Subject: [PATCH 5/5] Fix placeHolder instead of placeholder

My code sample in issue report was misleading ;)
---
 django_select2/widgets.py         |  2 +-
 testapp/testapp/testmain/forms.py | 28 +++++++++++++++++-----------
 2 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/django_select2/widgets.py b/django_select2/widgets.py
index 971c11dd..d8072b66 100644
--- a/django_select2/widgets.py
+++ b/django_select2/widgets.py
@@ -138,7 +138,7 @@ def get_options(self):
         :rtype: :py:obj:`dict`
         """
         options = dict(self.options)
-        if options.get('allowClear', None) is not None:
+        if options.get('allowClear') is not None:
             options['allowClear'] = not self.is_required
         return options
 
diff --git a/testapp/testapp/testmain/forms.py b/testapp/testapp/testmain/forms.py
index c9174957..fa9d951d 100644
--- a/testapp/testapp/testmain/forms.py
+++ b/testapp/testapp/testmain/forms.py
@@ -40,7 +40,7 @@ def get_results(self, request, term, page, context):
 class SelfMultiChoices(AutoSelect2MultipleField):
     big_data = {
         1: "First", 2: "Second", 3: "Third",
-        }
+    }
 
     def validate_value(self, value):
         if value in [v for v in self.big_data]:
@@ -79,6 +79,7 @@ class DeptForm(forms.ModelForm):
     class Meta:
         model = Dept
 
+
 class MixedForm(forms.Form):
     emp1 = EmployeeChoices()
     rooms1 = ClassRoomChoices()
@@ -93,20 +94,25 @@ class MixedForm(forms.Form):
         widget=AutoHeavySelect2Widget(
             select2_options={
                 'width': '32em',
-                'placeHolder': u"Search foo"
+                'placeholder': u"Search foo"
             }
         )
     )
 
 # These are just for testing Auto registration of fields
-EmployeeChoices() # Should already be registered
-EmployeeChoices(auto_id="EmployeeChoices_CustomAutoId") # Should get registered
+EmployeeChoices()  # Should already be registered
+EmployeeChoices(auto_id="EmployeeChoices_CustomAutoId")  # Should get registered
 
-class InitialValueForm(forms.Form):
-    select2Choice = Select2ChoiceField(initial=2, choices=((1, "First"), (2, "Second"), (3, "Third"), ))
-    select2MultipleChoice = Select2MultipleChoiceField(initial=[2,3], choices=((1, "First"), (2, "Second"), (3, "Third"), ))
-    heavySelect2Choice = AutoSelect2Field(initial=2, choices=((1, "First"), (2, "Second"), (3, "Third"), ))
-    heavySelect2MultipleChoice = AutoSelect2MultipleField(initial=[1,3], choices=((1, "First"), (2, "Second"), (3, "Third"), ))
-    self_choices = SelfChoices(label='Self copy choices', initial=2, choices=((1, "First"), (2, "Second"), (3, "Third"), ))
-    self_multi_choices = SelfMultiChoices(label='Self copy multi-choices', initial=[2,3])
 
+class InitialValueForm(forms.Form):
+    select2Choice = Select2ChoiceField(initial=2,
+        choices=((1, "First"), (2, "Second"), (3, "Third"), ))
+    select2MultipleChoice = Select2MultipleChoiceField(initial=[2, 3],
+        choices=((1, "First"), (2, "Second"), (3, "Third"), ))
+    heavySelect2Choice = AutoSelect2Field(initial=2,
+        choices=((1, "First"), (2, "Second"), (3, "Third"), ))
+    heavySelect2MultipleChoice = AutoSelect2MultipleField(initial=[1, 3],
+        choices=((1, "First"), (2, "Second"), (3, "Third"), ))
+    self_choices = SelfChoices(label='Self copy choices', initial=2,
+        choices=((1, "First"), (2, "Second"), (3, "Third"), ))
+    self_multi_choices = SelfMultiChoices(label='Self copy multi-choices', initial=[2, 3])