From 72fbfadf47a9488ee53af9374a04a0bd0fce82ba Mon Sep 17 00:00:00 2001 From: Artur Barseghyan Date: Wed, 21 Feb 2018 20:19:02 +0100 Subject: [PATCH] prepare 0.12.19 --- CHANGELOG.rst | 6 ++++++ README.rst | 11 +++++++++++ docs/changelog.rst | 6 ++++++ docs/index.rst | 11 +++++++++++ setup.py | 2 +- src/fobi/__init__.py | 2 +- 6 files changed, 36 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 316b24cb..45aaf1c4 100644 --- a/CHANGELOG.rst +++ b/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 diff --git a/README.rst b/README.rst index 96f3d5b5..0c6a6402 100644 --- a/README.rst +++ b/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 diff --git a/docs/changelog.rst b/docs/changelog.rst index 316b24cb..45aaf1c4 100644 --- a/docs/changelog.rst +++ b/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 diff --git a/docs/index.rst b/docs/index.rst index 89121453..6996c19d 100644 --- a/docs/index.rst +++ b/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 diff --git a/setup.py b/setup.py index bf11c6c6..cf9148aa 100644 --- a/setup.py +++ b/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 ********************************* diff --git a/src/fobi/__init__.py b/src/fobi/__init__.py index d440b2b4..3571b01f 100644 --- a/src/fobi/__init__.py +++ b/src/fobi/__init__.py @@ -1,5 +1,5 @@ __title__ = 'django-fobi' -__version__ = '0.12.18' +__version__ = '0.12.19' __author__ = 'Artur Barseghyan ' __copyright__ = '2014-2018 Artur Barseghyan' __license__ = 'GPL 2.0/LGPL 2.1'