prepare 0.12.19

CHANGELOG.rst

@@ -15,6 +15,12 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.12.19
+-------
+2018-02-21
+
+- Make it possible to sort on plugin ``name`` instead of ``uid``.
+
 0.12.18
 -------
 2018-02-19

README.rst

@@ -2214,6 +2214,17 @@ Run the example project as follows:
 In the example given, "Boolean" and "Checkbox select multiple" plugin names
 are renamed to "Checkbox" and "Multiple checkboxes" respectively.
 
+All built-in plugin ``name`` values are almost equivalent to the plugin ``uid``
+values. By default plugins are sorted by ``uid`` value. When you override the
+``name`` of the plugin, sorting breaks. Therefore, it's recommended to
+set the ``FOBI_SORT_PLUGINS_BY_VALUE`` value to True in your settings module.
+Default value is False, which means that plugins are sorted by their ``uid``
+value.
+
+.. code-block:: python
+
+    FOBI_SORT_PLUGINS_BY_VALUE = True
+
 Debugging
 =========
 By default debugging is turned off. It means that broken form entries, which

docs/changelog.rst

@@ -15,6 +15,12 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.12.19
+-------
+2018-02-21
+
+- Make it possible to sort on plugin ``name`` instead of ``uid``.
+
 0.12.18
 -------
 2018-02-19

docs/index.rst

@@ -2214,6 +2214,17 @@ Run the example project as follows:
 In the example given, "Boolean" and "Checkbox select multiple" plugin names
 are renamed to "Checkbox" and "Multiple checkboxes" respectively.
 
+All built-in plugin ``name`` values are almost equivalent to the plugin ``uid``
+values. By default plugins are sorted by ``uid`` value. When you override the
+``name`` of the plugin, sorting breaks. Therefore, it's recommended to
+set the ``FOBI_SORT_PLUGINS_BY_VALUE`` value to True in your settings module.
+Default value is False, which means that plugins are sorted by their ``uid``
+value.
+
+.. code-block:: python
+
+    FOBI_SORT_PLUGINS_BY_VALUE = True
+
 Debugging
 =========
 By default debugging is turned off. It means that broken form entries, which

setup.py

@@ -4,7 +4,7 @@ import sys
 from distutils.version import LooseVersion
 from setuptools import setup, find_packages
 
-version = '0.12.18'
+version = '0.12.19'
 
 # ***************************************************************************
 # ************************** Python version *********************************

src/fobi/__init__.py

@@ -1,5 +1,5 @@
 __title__ = 'django-fobi'
-__version__ = '0.12.18'
+__version__ = '0.12.19'
 __author__ = 'Artur Barseghyan <artur.barseghyan@gmail.com>'
 __copyright__ = '2014-2018 Artur Barseghyan'
 __license__ = 'GPL 2.0/LGPL 2.1'