plone.app.widgets 2.2.1

Warning
=======

2.x is only to be used with Plone 5 and 1.x is to be used in Plone 4.3.

Contents
========
The goal of ``plone.app.widgets`` is to provide an implementation for a new set
of javascript widgets being developed outside Plone as part of `Mockup`_
project. It overrides explicit widgets used in dexterity and archetypes to
provide tested and modularized widgets based on the concept of *patterns*.

.. image:: https://travis-ci.org/plone/plone.app.widgets.png?branch=master
:target: https://travis-ci.org/plone/plone.app.widgets

.. image:: https://coveralls.io/repos/plone/plone.app.widgets/badge.png?branch=master
:target: https://coveralls.io/r/plone/plone.app.widgets?branch=master

.. image:: https://pypip.in/v/plone.app.widgets/badge.png
:target: https://crate.io/packages/plone.app.widgets

.. image:: https://pypip.in/d/plone.app.widgets/badge.png
:target: https://crate.io/packages/plone.app.widgets

.. image:: https://saucelabs.com/browser-matrix/plone-pa-widgets.svg
:target: https://saucelabs.com/u/plone-pa-widgets


.. contents::

Is safe to use this package?
============================

This package should be safe to install and easy to uninstall (there is also
uninstall profile). That means its fairly safe to give it a try, but just in
case don't forget to create backup before testing it.

As of version 1.4.0 there is quite comprehensive unittest coverage of python
code as well as high coverage of our javascript code. There are also some robot
tests which are testing integration with Plone, but this will be improved with
future releases.

This project will be integrated with Plone 5 and will never reach version
2.0.0. You can monitor progress of `PLIP here`_.

If you wonder why there is no Alpha/Beta marker in version, its because version
of this package is kept in sync with other projects deriving from `Mockup`_
(eg. `plone.app.toolbar`_). Version 1.4.1 would then mean we're using
`Mockup`_ version 1.4 and there was one bugfix only to the python code. Version
packaged javascript inside is still in sync with `Mockup`_ project.


What is included?
=================

The fields that are using updated widgets are:

- **Tags field** (AjaxSelectWidget)
- **Language field** (SelectWidget)
- **Effective date field** (DatetimeWidget)
- **Expire date field** (DatetimeWidget)
- **Contributors field** (AjaxSelectWidget)
- **Creators field** (AjaxSelectWidget)
- **Related items field** (RelatedItemsWidget)
- **Query string field** (QueryStringWidget) in case `plone.app.contenttypes`_
is installed.

.. - **Text field** (TinyMCEWidget)

All client side code (javascript/css/images) is done and tested as part of
`Mockup`_ project.

.. image:: https://travis-ci.org/plone/mockup.png
:target: https://travis-ci.org/plone/mockup
:alt: Travis CI

.. image:: https://coveralls.io/repos/plone/mockup/badge.png?branch=master
:target: https://coveralls.io/r/plone/mockup?branch=master
:alt: Coveralls

.. image:: https://d2weczhvl823v0.cloudfront.net/plone/mockup/trend.png
:target: https://bitdeli.com/free
:alt: Bitdeli

For any feature / bug / comment please create an issue in the `issue tracker`_.


Installation
============

For now only tested with latest Plone 4.3::

[buildout]
extends =
http://dist.plone.org/release/4.3-latest/versions.cfg
https://raw.github.com/plone/plone.app.widgets/master/versions.cfg
versions = versions
parts = instance

[instance]
recipe = plone.recipe.zope2instance
user = admin:admin
http-address = 8080
eggs =
Pillow
Plone
plone.app.widgets[archetypes,dexterity]
zcml =
plone.app.widgets

Make sure you install the "Plone Widgets" profile when creating your Plone site
or include ``plone.app.widgets:default`` profile in your ``metadata.xml``..


.. _`Mockup`: http://plone.github.io/mockup
.. _`issue tracker`: https://github.com/plone/mockup/issues?labels=widgets
.. _`PLIP here`: https://dev.plone.org/ticket/13476
.. _`plone.app.toolbar`: https://github.com/plone/plone.app.toolbar
.. _`plone.app.contenttypes`: https://github.com/plone/plone.app.contenttypes

Changelog
=========

2.2.1 (2017-08-27)
------------------

Bug fixes:

- Allow related items options to work on non OFS Simple Item objects.
[thet]


2.2 (2017-07-03)
----------------

New features:

- Related items widget options changes:
- Let the browsing/searching start path be the current context if its folderish or a level up.
- Include the ``contextPath`` option to exclude the current context from selection.
- Include the ``favorites`` option with the current context and the navigation root to quickly jump to these paths.
- Clean up obsolete options.
Fixes https://github.com/plone/Products.CMFPlone/issues/1974
[thet]

Bug fixes:

- Change deprecated unittest method ``assertEquals`` to ``assertEqual``.
[thet]


2.1 (2017-02-20)
----------------

Bug fixes:

- Change options ``today`` and ``clear`` to reflect changes in mockup 2.4.
Refs: PR #154
[thet]

- Root the related items widget path bar to the top most visible site in the url and not the portal object itself.
This avoids related item widgets in subsites being able to break out of their virtual hosting root.
[thet]


2.0.7 (2016-11-19)
------------------

Bug fixes:

- No longer test on Travis. We are tested on jenkins.plone.org, and
the Travis setup on master is pretty broken. [maurits]

- Take more time during robot tests.
I hope that this makes a sometimes failing test always pass. [maurits]
- Root the related items widget path bar to the top most visible site in the url and not the portal object itself.
This avoids related item widgets in subsites being able to break out of their virtual hosting root.
[thet]

- Root the related items widget path bar to the top most visible site in the url and not the portal object itself.
This avoids related item widgets in subsites being able to break out of their virtual hosting root.
[thet]


2.0.6 (2016-08-18)
------------------

Bug fixes:

- Use zope.interface decorator.
[gforcada]


2.0.5 (2016-04-28)
------------------

Fixes:

- Fix related items to search for the whole site rather than from the navigation root only.
[Gagaro]


2.0.4 (2016-02-27)
------------------

New:

- Add navigation root support to related items widget. Fix incorrect options
merge for TinyMCE widget.
[alecm]

Fixes:

- Ensure vocabulary lookup works on add forms for related items widget.
[alecm]

- Ensure we have all content for tree query in relateditems
[Gagaro]

- Sort relateditems tree by sortable_title.
[Gagaro]

2.0.3 (2016-02-14)
------------------

Fixes:

- Fixed timing issue in robot tests. [maurits]

- Use plone i18n domain
[staeff]


2.0.2 (2015-11-28)
------------------

Fixes:

- Removed code for unused types_link_to_folder_contents.
[maurits]

- Don't install the plone.app.widgets dummy default profile in tests.
[thet]

2.0.1 (2015-09-21)
------------------

- Pull types_link_to_folder_contents values from the configuration registry.
[esteele]


2.0.0 (2015-03-26)
------------------

- Add Plone 5 warning.
[gforcada]

- Include TinyMCE languages from mockup.
[petschki]

- Raise minimum ``Products.CMFPlone`` requirement to 4.3.4 to ensure
compatibility with jQuery 1.9+. jQuery 1.11.1 is included in recent
``mockup``.
[thet]

- Always include CSS and JS SourceMap files. They are only loaded, when the
browser's developer console is open. Replaces previous behavior, where
uninified (and broken) resources were loaded when mockup was installed, which
was also an ugly implicit development mode behavior.
[thet]

- Use a mimetype selector for richtext areas, if multiple mimetypes are allowed.
[thet]

- Allow to remove a selected option in the ``select2`` widget if the field
is not required
[frapell]

- Test fixes.
[thet]

- add jsi18n integration
[vangheem, kiorky]


1.7.0 (2014-07-15)
------------------

- Remove configuration of plone.app.event's ``start`` and ``end`` fields in the
``dx_bbb`` module. Requires ``plone.app.event >= 1.2``, which does the widget
configuration by itself. There is no point in using a previous version of
plone.app.event together with plone.app.widgets.
[thet]

- Store RelatedItems in correct order.
[garbas]

1.6.0 (2014-04-20)
------------------

- Add default_timezone widget attribute to the Dexterity DatetimeWidget. If
used and set to a valid Olson DB/pytz timezone identifier or to an callback
returning such, the datetime object returned by the widget will be localized
to that timezone. This changes the timezone related behavior from version
1.4.0.
[thet]

- fix related items widget using getSource when it should use getVocabulary
[davisagli]


1.5.0 (2014-03-05)
------------------

- robot tests for SelectWidget
[gforcada]

- make tests pass for plone 5
[davisagli]

- add more tests for richtext widget
[amleczko]

- fix querystring converter with empty input
[davisagli]

- add richtext widget support and remove Products.TinyMCE dependency
[amleczko]

- Add sphinx-based documentation.
[tisto]

- move the AT macros to a browser view
[davisagli]

- make the profile not do anything on plone 5, which already includes the
widgets bundle in the plone bundle
[davisagli]

- Fix tests when portal_tinymce is missing.
[jaroel]

- Create robot tests for querystring widget
[ale-rt]

- Add DX tinymce test
[jaroel]

- Fix to import ROBOT_TEST_LEVEL from plone.app.testing.interfaces
[datakurre]

- RelatedItems widget: use a single selection for Choice fields
[cillian]

- add support for the tus resumable file upload protocol
[vangheem]

- handle unicode filenames for dexterity file uploads
[vangheem]

- just always default to using File objects for uploads that aren't images.
[vangheem]


1.4.0 (2013-11-24)
------------------

- add firstDay option to DatetimeWidgets
[thet]

- removing bbb.py (SiteRSSItemsFieldWidget and SearchBoxViewlet)
[garbas]

- For Archetypes DatetimeWidget, the value on pattern options is fixed, which
was the time component missing.
[thet]

- Fix the date/time value in pattern options for Archetypes DatetimeWidget.
[thet]

- commenting out tinymce widget for the time being. will be back with next
release.
[garbas]

- Add robot tests for datetime widget
[David Erni]

- fix saving dates in dexterity
[vangheem]

- rework of base widget code. we should now share more code between at and dx
[garbas]

- use ajax to grab query index options for querystring widget
[vangheem]

- rename ajaxvocabulary to ajaxVocabulary to match mockup
[vangheem]

- use select2 widget for ISiteSyndicationSettings
[garbas]

- select2 widget should support initvaluemap options OOTB
[garbas]

- adding SyndicatableFeedItems to the permitted vocabularies list
[garbas]

- fix VocabularyView to accept 1-based batch pages as per doc
[djay]

- Change the start and end date fields of Products.ATContentTypes ATEvent
types to use plone.app.widgets.
[thet]

- For Dexterity DatetimeWidgetConverter, when converting to the field value,
try to localize the value, if the old value is a timezone aware datetime
object. It uses the 'timezone' attribute on the widget's context, if
available, otherwise UTC. We do not use the tzinfo object in the first
place, because it might already be converted from user's input timezone to
UTC, as it is the case with plone.app.event.
[thet]

- Support query arguments for function based vocabularies.
[thet]


1.3.3 (2013-09-11)
------------------

- fix formlib uberselectionwidget override
[vangheem]

- SelectWidget fixes: support multiple-select; indicate the selected value.
[davisagli]

- Don't include time in DateWidget.
[davisagli]

- Allow to define a different vocabulary view for select widget
[do3c]

- Don't do double batching in select widget code
[do3cc]


1.3.2 (2013-08-12)
------------------

- Allow overriding with a custom vocabulary for Archetypes.
[pbauer]

- Reuse z3c.form SelectWidget's logic for determing what items
are available rather than recreating it incompletely.
[davisagli]

- Use normal widget templates for z3c.form widgets in hidden mode.
[davisagli]

- add formlib uber selection override for portlets
[vangheem]


1.3.1 (2013-07-22)
------------------

- handle plone.app.relationfield not being installed
[vangheem]

- handle unicode data in widgets beter
[vangheem]


1.3 (2013-07-21)
----------------

- Additional set of widgets added and improved at Oshkosh and Bastille Sprint.
[bunch of ppl]

- Fix bug where empty select elements rendered as <select/>
[davisagli]

- Use normal widget templates for z3c.form widgets in display mode.
[davisagli]

- For Archetypes subject fields, use the field's vocabulary_factory and fall
back to 'plone.app.vocabularies.Keywords' if it's not present.
[thet]

- Conditional include of collection ``QueryStringWidget`` which expects
``plone.app.contenttypes``.
[saily]

- Restructure buildout to build an instance.
[saily]

- Add travis icon
[saily]

- Add german translation
[saily]

- Fields and widgets demo gallery added [miohtama]


0.2 (2013-03-04)
----------------

- add support for dexterity content types as well.
[garbas]

- using select2 pattern instead of textext pattern for select/autocomplete
elements.
[garbas]


0.1 (2013-01-31)
----------------

- initial release
[garbas]