2.2.0 > 4.0.0 braking upgrade notes

Author: Tibor Szakmany

README.rst

@@ -3,141 +3,46 @@ Introduction
 
 Integration of jQueryUI in Plone
 
+IMPORTANT - 2.2.0 > 4.0.0 Upgrade
+=================================
 
-WARNINGS
-========
+Can not be upgraded from 2.2.0 directly! It is a major braking release!
 
-Plone < 4
----------
+There is no upgrade step provided for this "version jump", instead follow these steps:
 
-For Plone 3 you need version 1.7.x of this package
 
-JQueryUI > 1.8.6 is supposed to be compatible with jQuery 1.3.2.
-At the moment you should prefer to use the 1.7.X version of jQueryUI
-(same package exists for 1.7 branch)
+1. First uninstall 2.1.8 version of JQuery UI using "Site Setup / Add-ons" page. This will cleanly remove all: Plugin selection related registry records; Old style `jsregistry` items; Actions and controlpanel pages.
+2. Run the buildout to get the 4.0.0 version.
+3. Restart instance.
+4. Install JQuery UI again using "Site Setup / Add-ons" page.
 
-Plone < 4.3
------------
+WARNINGS
+========
 
-Use version < 1.9
+Plone < 5
+---------
 
-Integration for Zope and Plone
-==============================
+Support is dropped for older versions of Plone and Python 2.7.
 
-This package can be used as a Plone add-on - for this it adds GenericSetup
-profiles and Plone ControlPanel configlets - or it can be used as a simple Zope
-jQuery UI resources registrar. See bellow how your zc.buildout config file
-should look like if you use collective.js.jqueryui with or without Plone.
+Integration for Zope
+--------------------
 
-Plone
------
+This package can be used as a Plone add-on only.
 
-for Plone > 4.0:
+Usage
+=====
 
 buildout.cfg::
 
     [instance]
     eggs +=
          collective.js.jqueryui
 
-for Plone == 4.0 you must add plone.app.registry yourself:
-
-buildout.cfg::
-
-    extends=http://good-py.appspot.com/release/plone.app.registry/1.0b2
-    [instance]
-    eggs +=
-        collective.js.jqueryui
-        plone.app.registry
-
-Zope
-----
-
-buildout.cfg::
-
-    [instance]
-    eggs =
-        collective.js.jqueryui
-    zcml =
-        collective.js.jqueryui
 
 Include plugins and optimizations
 =================================
 
-By default this addon register all plugins and activate all of them except tabs.
-So ui.tabs is registred but not activated.
-
-Because jQueryUI is big on both javascripts and css you may want to optimize
-the configuration of your site or your addon which depends on this one.
-
-So you can activate/unactivate plugins using registry profile or the jQueryUI
-controlpanel.
-
-Using registry.xml, you can activate only what you want::
-
-    <registry>
-        <records interface="collective.js.jqueryui.controlpanel.IJQueryUIPlugins">
-          <value key="ui_draggable">True</value>
-          <value key="ui_droppable">True</value>
-        </records>
-    </registry>
-
-In the case of a policy you can do a full configuration::
-
-    <registry>
-        <records interface="collective.js.jqueryui.controlpanel.IJQueryUIPlugins">
-          <value key="ui_core">True</value>
-          <value key="ui_widget">True</value>
-          <value key="ui_mouse">True</value>
-          <value key="ui_position">True</value>
-          <value key="ui_draggable">True</value>
-          <value key="ui_droppable">True</value>
-          <value key="ui_resizable">True</value>
-          <value key="ui_selectable">True</value>
-          <value key="ui_sortable">True</value>
-          <value key="ui_accordion">False</value>
-          <value key="ui_autocomplete">False</value>
-          <value key="ui_button">False</value>
-          <value key="ui_dialog">False</value>
-          <value key="ui_slider">False</value>
-          <value key="ui_tabs">False</value>
-          <value key="ui_datepicker">False</value>
-          <value key="ui_progressbar">False</value>
-          <value key="effects_core">False</value>
-          <value key="effects_blind">False</value>
-          <value key="effects_bounce">False</value>
-          <value key="effects_clip">False</value>
-          <value key="effects_drop">False</value>
-          <value key="effects_explode">False</value>
-          <value key="effects_fade">False</value>
-          <value key="effects_fold">False</value>
-          <value key="effects_highlight">False</value>
-          <value key="effects_pulsate">False</value>
-          <value key="effects_scale">False</value>
-          <value key="effects_shake">False</value>
-          <value key="effects_slide">False</value>
-          <value key="effects_transfer">False</value>
-        </records>
-        <records interface="collective.js.jqueryui.controlpanel.IJQueryUICSS">
-          <value key="css">False</value>
-          <value key="patch">False</value>
-        </records>
-    </registry>
-
-Using the control panel, you can select plugins you want. If you unselect a
-plugin it will be unactivated (but not its dependencies)
-
-Using python, you just have to use plone.registry api::
-
-    from zope.component import getUtility
-    from plone.registry.interfaces import IRegistry
-    from collective.js.jqueryui.config import DEPS
-    from collective.js.jqueryui.interfaces import IJQueryUICSS, IJQueryUIPlugins
-    #is plone.app.registry
-    registry = getUtility(IRegistry)
-    proxy = registry.forInterface(IJQueryUIPlugins)
-    setattr(proxy, 'ui_draggable', True)
-    setattr(proxy, 'ui_droppable', True)
+By default this addon register all plugins and activate all of them. The registry based plugin activation is dropped. See https://github.com/collective/collective.js.jqueryui/issues/46.
 
 Credits and contributions
 =========================
@@ -148,4 +53,4 @@ Credits and contributions
 * `Ecreall <https://www.ecreall.com>`_
 
 .. |makinacom| image:: http://depot.makina-corpus.org/public/logo.gif
-.. _makinacom:  https://www.makina-corpus.com
+.. _makinacom:  https://www.makina-corpus.com