plone.app.registry


Nameplone.app.registry JSON
Version 2.0.5 PyPI version JSON
download
home_pagehttps://pypi.org/project/plone.app.registry
SummaryZope 2 and Plone integration for plone.registry
upload_time2024-05-30 18:32:13
maintainerNone
docs_urlNone
authorMartin Aspeli
requires_python>=3.8
licenseGPL
keywords plone registry settings configuration
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

``plone.app.registry`` provides Plone UI and GenericSetup integration for
`plone.registry`_, which in turn implements a configuration registry for
Zope applications. For details about how the registry works, please see the
`plone.registry`_ documentation. What follows is a brief overview of common
usage patterns in Plone.

.. contents:: Table of contents

Overview
========

The registry provided by `plone.registry`_ is intended to store settings in
a safe, easily accessible manner. This makes it well-suited for applications
and add-on products that need to manage some configurable, user-editable
values. It is intended to replace the use of (less powerful and user friendly)
Zope 2 property sheets, as well as (less safe and more difficult to access)
persistent local utilities for managing such configuration.

The registry is *not* an arbitrary data store. For the most part, you can
store any Python primitive there, but not more complex data structures or
objects. This means that the registry cannot be broken by packages being
uninstalled, and that it can provide a simple, generic user interface for
editing values.

The registry is made up of *records*. A record consists of a *field*,
describing the record, and a *value*.  Fields are based on the venerable
``zope.schema``, although the standard allowable field types are defined in
the module ``plone.registry.field``. (This is partly because the field
definitions are actually persisted with the record, and partly because
``plone.registry`` performs some additional validation to ensure the integrity
of the registry).

A record can be created programmatically, though in a Plone context it is more
common to install records using the ``records.xml`` GenericSetup syntax. Once
the record has been created, its value can be read and set using standard
Python dictionary syntax. Accessing the record and field is just as easy.

Each record has a unique name, which must be a *dotted name* prefixed by the
package owning the record. For example, a record owned by the package
``my.package`` could have a name like ``my.package.myrecord``.

As of version 1.6, it is possible to split ``registry.xml`` into
multiple files; to import and export registry entries via the control
panel; and to add and delete records via the control panel.

Notes about versions
====================

- versions 1.3 and later are for Plone 5.

- versions 1.2.x are for Plone 4.

Usage
=====

This section describes how the registry is most commonly used in a Plone
context. For more details, please see the `plone.registry`_ documentation.

Using GenericSetup to manipulate the registry
---------------------------------------------

The best way to create, modify and delete registry records when writing Plone
add-on products is normally to use GenericSetup.

Creating records
~~~~~~~~~~~~~~~~

Once you have decided that you need a particular record, you need to answer
two questions:

1. What should the record be called?
2. What type of data should it hold?

Let's say you wanted to create a record call ``my.package.timeout``, holding
an integer. Integers are described by the field type
``plone.registry.field.Int``. Almost all the standard fields you would find
in ``zope.schema`` have an equivalent field in ``plone.registry.field``. The
main exception is ``Object``, which is unsupported. Also, ``Choice`` fields
only support vocabularies given by string name, or as a list of string values.
Finally, you cannot use the ``constraint`` property to set a validator
function, although other validation (such as min/max values) will work.

To install such a record, you could add a ``registry.xml`` step to the
GenericSetup profile of your product like this::

    <registry>

        <record name="my.package.timeout">
            <field type="plone.registry.field.Int">
                <title>Timeout</title>
                <min>0</min>
            </field>
            <value>100</value>
        </record>

    </registry>

Let's look at this in more detail:

* There is one record declared. The name is given in the ``name`` attribute.
* In the record, we first define the field type, by giving the full dotted
  name to the field class. Unless you have installed a third party package
  providing additional persistent fields, this will be a class in
  ``plone.registry.field`` mirroring a corresponding class in ``zope.schema``.
* Inside the ``<field />`` element, we list any required or optional
  attributes of the field. This uses `plone.supermodel`_ syntax. In essence,
  each allowed field attribute is represented by a tag (so the ``title``
  attribute can be set with the ``<title />`` tag), with the attribute value
  given as the tag body. If an attribute is required for a field, the
  corresponding tag is required here.
* We then set the value. This must obviously be a valid value for the field
  type.

Note that the ``<value />`` is optional. If not given, the field will default
to its ``missing_value`` until it is set. The ``<field />`` is optional if
the record has already been initialised elsewhere.

Most field attributes are simple tags like the ones shown above, with the
field name used as the tag name, and a string representation of the value
used as the contents of the tag. Collection fields are a little more involved,
however. A collection field (like a ``List`` or ``Tuple``) has a
``value_type`` property containing another field. Also, their values and
defaults are sequences. Let's look at an example::

    <record name="my.package.animals">
        <field type="plone.registry.field.Tuple">
            <title>Animals</title>
            <description>A list of cool animals</description>
            <value_type type="plone.registry.field.TextLine" />
        </field>
        <value>
            <element>Dog</element>
            <element>Cat</element>
            <element>Elephant</element>
        </value>
    </record>

Notice how the ``<value_type />`` tag takes a ``type`` attribute just like
the outer ``<field />`` tag. Here we have shown a value type with no options,
but if you need, you can put tags for additional field attributes inside the
``<value_type />`` tag.

Also notice how the value is represented. Each element in the sequence (a
tuple in this case) is given by an ``<element />`` tag, with the element
value given as the body of that tag.

``Dict`` fields also have a ``<key_type />`` and elements that are key/value
pairs. They can be configured like so::

    <record name="my.package.animalFood">
        <field type="plone.registry.field.Dict">
            <title>Food eaten by animals</title>
            <key_type type="plone.registry.field.TextLine" />
            <value_type type="plone.registry.field.TextLine" />
        </field>
        <value>
            <element key="Dog">Dog food</element>
            <element key="Cat">Cat food</element>
            <element key="Elephant">Squirrels</element>
        </value>
    </record>

Using multiple registry XML files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Instead of storing registry entries in a single, large
``registry.xml`` file, you can have Generic Setup load and process
registry entries from multiple files. This makes it easier to manage
and organize the registry entries provided by your applications and
add-ons.

Your add-on should include a folder named ``registry`` in its
profile(s) folders, e.g. ``profiles/default/registry``. Any XML files
in that folder will be read and processed by the registry the same way
it would have read and processed a single ``registry.xml`` file in
the ``profiles/default`` folder.

As an example, see how `Castle CMS
<https://github.com/castlecms/castle.cms>`_ uses multiple XML files in
its `profiles/default/registry
<https://github.com/castlecms/castle.cms/tree/master/castle/cms/profiles/default/registry>`_
folder.

The registry will process both the ``registry.xml`` file and the
contents of a ``registry`` folder, if both exist.


Conditional records
~~~~~~~~~~~~~~~~~~~

Importable records in ``registry.xml`` can be marked conditional with
``condition`` attribute, which supports the following condition values:

* ``installed my.package``, which causes record to be imported only when
  python module ``my.package`` is available to be imported.

* ``not-installed my.package``, which causes record to be imported only when
  python module ``my.package`` is *not* available to be imported:

* ``have my-feature``, which causes record to be imported only when
  ZCML feature flag ``my-feature`` has been registered (Zope2 only)

* ``not-have my-feature``, which causes record to be imported only when
  ZCML feature flag ``my-feature`` has *not* been registered (Zope2 only)

For example, the following ``registry.xml`` step at the GenericSetup profile of
your policy product, would only import records when module ``my.package`` is
available::

    <registry>
      <records interface="my.package.interfaces.IZooSettings"
               condition="installed my.package">
        <value key="entryPrice">40</value>
        <value key="messageOfTheDay">We've got lions and tigers!</value>
      </records>
    </registry>


Field references
~~~~~~~~~~~~~~~~

It is possible to define record to use another record's field. This is often
useful if you want one record to act as an optional override for another.
For example::

    <registry>

        <record name="my.package.timeout">
            <field type="plone.registry.field.Int">
                <title>Timeout</title>
                <min>0</min>
            </field>
            <value>100</value>
        </record>

        <record name="my.package.timeout.slowconnection">
            <field ref="my.package.timeout" />
            <value>300</value>
        </record>

    </registry>

In this example, we have defined the ``my.package.timeout`` record with an
integer field. We then have a separate record, with a separate value,
called ``my.package.timeout.slowconnection``, which uses the same field
(with the same type, validation, title, description, etc). This avoids having
to explicitly re-define a complete field.

Note: The field in this case is actually a ``FieldRef`` object. See the
`plone.registry`_ documentation for details.

Setting values
~~~~~~~~~~~~~~

Once a record has been defined, its value can be set or updated using
GenericSetup like so::

    <record name="my.package.animalFood">
        <value purge="false">
            <element key="Squirrel">Nuts</element>
            <element key="Piranha">Other piranha</element>
        </value>
    </record>

This is often useful if you have a record defined in one package that is
appended to or customised in another package.

In the example above, we used the ``purge`` attribute. When setting the value
of a multi-valued field such as a tuple, list, set or dictionary, setting this
attribute to ``false`` will cause the values listed to be added to the
existing collection, rather than overriding the collection entirely, as would
happen if the ``purge`` attribute was set to ``true`` or omitted.

Deleting records
~~~~~~~~~~~~~~~~

To delete a record, use the ``remove`` attribute::

    <record name="my.package.animalFood" remove="true" />

If the record does not exist, a warning will be logged, but processing will
continue.

Creating records based on an interface
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In the examples above, we created individual records directly in the registry.
Sometimes, however, it is easier to work with traditional schema interfaces
that group together several related fields. As we will see below,
``plone.registry`` and ``plone.app.registry`` provide certain additional
functionality for groups of records created from an interface.

For example, we could have an interface like this::

    from zope.interface import Interface
    from zope import schema

    class IZooSettings(Interface):

        entryPrice = schema.Decimal(title=u"Admission charge")
        messageOfTheDay = schema.TextLine(title=u"A banner message", default=u"Welcome!")

Notice how we are using standard ``zope.schema`` fields. These will be
converted to persistent fields (by adapting them to ``IPersistentField`` from
``plone.registry``) when the registry is populated. If that is not possible,
an error will occur on import.

To register these records, we simply add the following to ``registry.xml``::

    <records interface="my.package.interfaces.IZooSettings" />


This will create one record for each field. The record names are the full
dotted names to the fields, so in this case they would be
``my.package.interfaces.IZooSettings.entryPrice`` and
``my.package.interfaces.IZooSettings.messageOfTheDay``.

If you just want to use the interface as a template you can supply a
``prefix`` attribute::

    <records interface="my.package.interfaces.IZooSettings" prefix="my.zoo" />

which will generate fields named ``my.zoo.entryPrice`` and
``my.zoo.messageOfTheDay``.

In order to set the values of the fields created by a <records /> directive
you must provide ``value`` entries with keys corresponding to the fields on
the interface, as follows::

    <records interface="my.package.interfaces.IZooSettings" prefix="my.zoo">
        <value key="entryPrice">40</value>
        <value key="messageOfTheDay">We've got lions and tigers!</value>
    </records>

Values can be set as above using the full record name. However, we can also
explicitly state that we are setting a record bound to an interface, like so::

    <record interface="my.package.interfaces.IZooSettings" field="entryPrice">
        <value>10.0</value>
    </record>

This is equivalent to::

    <record name="my.package.interfaces.IZooSettings.entryPrice">
        <value>10.0</value>
    </record>

You can also use the ``interface``/``field`` syntax to register a new record
from an individual field.

Finally, if the interface contains fields that cannot or should be set, they
may be omitted::

    <records interface="my.package.interfaces.IZooSettings">
        <omit>someField</omit>
    </records>

The ``<omit />`` tag can be repeated to exclude multiple fields.

Deleting records based on an interface
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To delete a set of records, based on an interface use the ``remove``
attribute::

    <records interface="my.package.interfaces.IZooSettings" remove="true" />

If the record does not exist for any of the interface fields, a warning will
be logged, but processing will continue.

If you do not wish to delete, or wish to exclude certain fields, they may be
omitted::

    <records interface="my.package.interfaces.IZooSettings" remove="true">
        <omit>someField</omit>
    </records>

The ``<omit />`` tag can be repeated to exclude multiple fields.

Using the registry in Python code
---------------------------------

Now that we have seen how to manage records through GenericSetup, we can start
using values from the registry in our code.

Accessing the registry
~~~~~~~~~~~~~~~~~~~~~~

To get or set the value of a record, we must first look up the registry
itself. The registry is registered as a local utility, so we can look it up
with::

    from zope.component import getUtility
    from plone.registry.interfaces import IRegistry

    registry = getUtility(IRegistry)

Values can now get read or set using simple dictionary syntax::

    timeout = registry['my.package.timeout']

We can also use ``get()`` to get the value conditionally, and an ``in`` check
to test whether the registry contains a particular record.

The returned value will by of a type consistent with the field for the record
with the given name. It can be set in the same manner::

    registry['my.package.timeout'] = 120

If you need to access the underlying record, use the ``records`` attribute::

    timeoutRecord = registry.records['my.package.timeout']

The record returned conforms to ``plone.registry.interfaces.IRecord`` and has
two main attributes: ``value`` is the current record value, and ``field`` is
the persistent field instance. If the record was created from an interface,
it will also provide ``IInterfaceAwareRecord`` and have three additional
attributes: ``interfaceName``, the string name of the interface;
``interface``, the interface instance itself, and ``fieldName``, the name of
the field in the interface from which this record was created.

You can delete the whole record programmatically with the Python ``del``
statement::

    del registry.records['my.package.timeout']

In unit tests, it may be useful to create a new record programmatically.
You can do that like so::

    from plone.registry.record import Record
    from plone.registry import field

    registry.records['my.record'] = Record(field.TextLine(title=u"A record"), u"Test")

The constructor takes a persistent field and the initial value as parameters.

To register records for an interface programmatically, we can do::

    registry.registerInterface(IZooSettings)

You can omit fields by passing an ``omit`` parameter giving a sequence of
omitted field names.

See ``plone.registry`` for more details about how to introspect and manipulate
the registry records programmatically.

Accessing the registry in page templates
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also access the registry from page templates. Example TALES expression::

     python:context.portal_registry['plone.app.theming.interfaces.IThemeSettings.enabled']

Using the records proxy
~~~~~~~~~~~~~~~~~~~~~~~

Above, we used dictionary syntax to access individual records and values. This
will always work, but for so-called interface-aware records - those which were
created from an interface e.g. using the ``<records />`` syntax - we have
another option: the records proxy. This allows us to look up all the records
that belong to a particular interface at the same time, returning an object
that provides the given interface and can be manipulated like an object, that
is still connected to the underlying registry.

To look up a records proxy for our ``IZooSettings`` interface, we can do::

    zooSettings = registry.forInterface(IZooSettings)

The ``zooSettings`` object now provides ``IZooSettings``. Values may be
read and set using attribute notation::

    zooSettings.messageOfTheDay = u"New message"
    currentEntryPrice = zooSettings.entryPrice

When setting a value, it is immediately validated and written to the registry.
A validation error exception may be raised if the value is not permitted by
the field for the corresponding record.

When fetching the records proxy, ``plone.registry`` will by default verify
that records exists for each field in the interface, and will raise an error
if this is not the case. To disable this check, you can do::

    zooSettings = registry.forInterface(IZooSettings, check=False)

This is sometimes useful in cases where it is not certain that the registry
has been initialised. You can also omit checking for individual fields, by
passing an ``omit`` parameter giving a tuple of field names.

Delete records
~~~~~~~~~~~~~~

To delete a record is as simple as::

    del registry.records['plone.app.theming.interfaces.IThemeSettings.enabled']

Registry events
~~~~~~~~~~~~~~~

The registry emits events when it is modified:

* ``plone.registry.interfaces.IRecordAddedEvent`` is fired when a record has
  been added to the registry.
* ``plone.registry.interfaces.IRecordRemovedEvent`` is fired when a record
  has been removed from the registry.
* ``plone.registry.interfaces.IRecordModifiedEvent`` is fired when a record's
  value is modified.

You can register subscribers for these to catch any changes to the registry.
In addition, you can register an event handler that only listens to changes
pertaining to records associated with specific interfaces. For example::

    from zope.component import adapter
    from plone.registry.interfaces import IRecordModifiedEvent

    from logging import getLogger
    log = getLogger('my.package')

    @adapter(IZooSettings, IRecordModifiedEvent)
    def detectPriceChange(settings, event):
        if record.fieldName == 'entryPrice':
            log.warning("Someone change the price from %d to %d" % (event.oldValue, event.newValue,))

See `plone.registry`_ for details about these event types.

Creating a custom control panel
-------------------------------

The generic control panel is useful as a system administrator's tool for low-
level configuration. If you are writing a package aimed more at system
integrators and content managers, you may want to provide a more user-friendly
control panel to manage settings.

If you register your records from an interface as shown above, this package
provides a convenience framework based on `plone.autoform`_ and `z3c.form`_
that makes it easy to create your own control panel.

To use it, create a module like this::

    from plone.app.registry.browser.controlpanel import RegistryEditForm
    from plone.app.registry.browser.controlpanel import ControlPanelFormWrapper

    from my.package.interfaces import IZooSettings
    from plone.z3cform import layout
    from z3c.form import form

    class ZooControlPanelForm(RegistryEditForm):
        form.extends(RegistryEditForm)
        schema = IZooSettings

    ZooControlPanelView = layout.wrap_form(ZooControlPanelForm, ControlPanelFormWrapper)
    ZooControlPanelView.label = u"Zoo settings"

Register the ``ZooControlPanelView`` as a view::

    <browser:page
        name="zoo-controlpanel"
        for="Products.CMFPlone.interfaces.IPloneSiteRoot"
        permission="cmf.ManagePortal"
        class=".controlpanel.ZooControlPanelView"
        />

Then install this in the Plone control panel using the ``controlpanel.xml``
import step in your GenericSetup profile::

    <?xml version="1.0"?>
    <object
        name="portal_controlpanel"
        xmlns:i18n="http://xml.zope.org/namespaces/i18n"
        i18n:domain="my.package">

        <configlet
            title="Zoo settings"
            action_id="my.package.zoosettings"
            appId="my.package"
            category="Products"
            condition_expr=""
            url_expr="string:${portal_url}/@@zoo-controlpanel"
            icon_expr="string:${portal_url}/++resource++my.package/icon.png"
            visible="True"
            i18n:attributes="title">
                <permission>Manage portal</permission>
        </configlet>

    </object>

The ``icon_expr`` attribute should give a URL for the icon. Here, we have
assumed that a resource directory called ``my.package`` is registered and
contains the file ``icon.png``. You may omit the icon as well.

Using the Configuration Registry control panel
----------------------------------------------

Viewing and editing records through the control panel
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This package provides the "Configuration Registry" control panel in
Plone's Site Setup. Here, you can view all registry records, you can
search for records using a case sensitive filter field, and you can
select sets of records according to their prefix
(e.g. "IDiscussionSettings", "plone.app.caching").

Registry records' names, titles, descriptions, data types and current
values are displayed.

.. figure:: https://raw.githubusercontent.com/plone/plone.app.registry/master/docs/configuration_registry_screenshot.jpg

	    The Configuration Registry control panel

If you click on a record, an edit form appears that allows you to
change its value.

.. figure:: https://raw.githubusercontent.com/plone/plone.app.registry/master/docs/configuration_registry_edit_record_screenshot.jpg

	    How to change the value of a registry record


Exporting and importing records through the control panel
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can use the Configuration Registry control panel's Export tab to
export the entire registry into a single XML file.  When you click the
Export Now button, a file named ``registry.xml`` will be downloaded to
your computer.

.. figure:: https://raw.githubusercontent.com/plone/plone.app.registry/master/docs/configuration_registry_export_screenshot.jpg

	    How to export the entire registry

To import registry entries, use the Configuration Registry control
panel's Import tab, use the Choose File button to select an XML file
from your computer containing the registry entries, then press the
Import File button.

.. figure:: https://raw.githubusercontent.com/plone/plone.app.registry/master/docs/configuration_registry_import_screenshot.jpg

	    How to import a registry file


Adding and deleting records through the control panel
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can add individual registry records using the Configuration
Registry control panel's "Add new record" tab.

Enter the registry record's name, (human readable) title, select a
data type, and optionally check the Required box if the record must
have a value. Then press the "Add field" button.

.. figure:: https://raw.githubusercontent.com/plone/plone.app.registry/master/docs/configuration_registry_add_record_screenshot.jpg


Control panel widget settings
=============================

plone.app.registry provides ``RegistryEditForm`` class which is a subclass of
``z3c.form.form.Form``.

``RegistryEditForm`` has two methods to override which and how widgets are going
to be used in the control panel form.

* ``updateFields()`` may set widget factories i.e. widget type to be used

* ``updateWidgets()`` may play with widget properties and widget value
  shown to the user

Example (*collective.gtags* project controlpanel.py)::

        class TagSettingsEditForm(controlpanel.RegistryEditForm):

            schema = ITagSettings
            label = _(u"Tagging settings")
            description = _(u"Please enter details of available tags")

            def updateFields(self):
                super(TagSettingsEditForm, self).updateFields()
                self.fields['tags'].widgetFactory = TextLinesFieldWidget
                self.fields['unique_categories'].widgetFactory = TextLinesFieldWidget
                self.fields['required_categories'].widgetFactory = TextLinesFieldWidget

            def updateWidgets(self):
                super(TagSettingsEditForm, self).updateWidgets()
                self.widgets['tags'].rows = 8
                self.widgets['tags'].style = u'width: 30%;'

Troubleshooting
===============

The following sections describe some commonly encountered problems, with
suggestions for how to resolve them.

Required dependency add-ons installed
-------------------------------------

Both ``plone.app.z3cform`` (Plone z3c.form support) and ``plone.app.registry``
(Configuration registry) add-ons must be installed at Plone site before you
can use any control panel configlets using plone.app.registry framework.

KeyError: a field for which there is no record
----------------------------------------------

Example traceback::

        Module plone.app.registry.browser.controlpanel, line 44, in getContent
          Module plone.registry.registry, line 56, in forInterface
        KeyError: 'Interface `mfabrik.plonezohointegration.interfaces.ISettings` defines a field `username`, for which there is no record.'

This means that

* Your registry.xml does not define default values for your configuration keys
* You have changed your configuration schema, but haven't rerun add-on
  installer to initialize default values
* You might need to use the same prefix as you use for the interface name in
  your settings::

        <records prefix="mfabrik.plonezohointegration.interfaces.ISettings" interface="mfabrik.plonezohointegration.interfaces.ISettings">

.. _plone.registry: http://pypi.python.org/pypi/plone.registry
.. _plone.supermodel: http://pypi.python.org/pypi/plone.supermodel
.. _plone.autoform: http://pypi.python.org/pypi/plone.autoform
.. _z3c.form: http://pypi.python.org/pypi/z3c.form

Changelog
=========

.. You should *NOT* be adding new change log entries to this file.
   You should create a file in the news directory instead.
   For helpful instructions, please see:
   https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst

.. towncrier release notes start

2.0.5 (2024-05-30)
------------------

Bug fixes:


- Removes duplicate `<article id="content">`
  [@szakitibi] (#84)
- Fix misleading portal message when NOT deleting records @gforcada


2.0.4 (2023-12-14)
------------------

Bug fixes:


- disable visibility of the right column in records template
  [1letter] (#71)
- Fix template error deleting registry record.
  [maurits] (#76)


2.0.3 (2023-10-18)
------------------

Internal:


- Require ``setuptools`` 68.2+ for building the package.
  [plone devs] (18d04723)
- Update configuration files.
  [plone devs] (cfffba8c)


2.0.2 (2023-04-15)
------------------

Internal:


- Update configuration files.
  [plone devs] (5623f8b3)


2.0.1 (2022-12-10)
------------------

Bug fixes:


- Fix responsive table.
  [petschki] (#64)


2.0.0 (2022-11-30)
------------------

Bug fixes:


- Final release.
  [gforcada] (#600)


2.0.0a9 (2022-05-09)
--------------------

Breaking changes:


- isort, black, pyupgrade. Use plone.base and dependency cleanup.
  [jensens] (#63)


Bug fixes:


- Allow up to one dash in key when creating an a record ttw.
  [pbauer] (#62)


2.0.0a8 (2022-04-04)
--------------------

Breaking changes:


- Remove registry.js, lives now in mockup [MrTango] (#57)


2.0.0a7 (2022-01-25)
--------------------

Bug fixes:


- structured form description and explicit macro call
  [petschki] (#60)


2.0.0a6 (2022-01-19)
--------------------

Bug fixes:


- Ignoring dotted files in registry directories. [iham] (#3990)


2.0.0a5 (2021-10-16)
--------------------

Bug fixes:


- Add missing i18n:translate tag
  [erral] (#56)


2.0.0a4 (2021-09-15)
--------------------

Bug fixes:


- Remove cyclic dependency with Products.CMFPlone
  [sneridagh] (#54)


2.0.0a3 (2021-09-01)
--------------------

Bug fixes:


- Fix an issue that was preventing the edit of a registry record containing a "/" in its name [ale-rt] (#51)


2.0.0a2 (2021-08-04)
--------------------

New features:


- Add JSONField Handler for plone.registry.field.JSONField
  - add component JSONFieldHandler
  - add Tests for Import and Export JSONField
  - add towncrier message
  [1letter] (#48)


2.0.0a1 (2021-04-20)
--------------------

Breaking changes:


- Update for Plone 6 with Bootstrap markup
  [jensens, petschki, agitator] (#45)


1.7.8 (2021-01-08)
------------------

Bug fixes:


- Use better titles and descriptions for import and export steps.
  [jensens] (#1)


1.7.7 (2020-09-07)
------------------

Bug fixes:


- Make interface list on configuration export page visible. [jensens] (#41)


1.7.6 (2020-04-20)
------------------

Bug fixes:


- Minor packaging updates. (#1)


1.7.5 (2019-05-01)
------------------

Bug fixes:


- broken value in records table in Python 3
  [petschki] (#36)


1.7.4 (2019-03-03)
------------------

Bug fixes:


- Fix export of registry with Generic Setup. [pbauer] (#34)


1.7.3 (2019-02-13)
------------------

Bug fixes:


- Fix some deprecation warnings. [gforcada] (#32)


1.7.2 (2018-06-19)
------------------

New features:

- Added a pragmatic XML exporter for registry records in a format meant to be used in add-ons or policy profiles.
  [jensens]


1.7.1 (2018-04-08)
------------------

Bug fixes:

- Python 2 / 3 compatible imports.
  [pbauer]


1.7 (2018-02-04)
----------------

New features:

- Added traceback info of filename to importer in order to ease debugging.
  [jensens]

Bug fixes:

- Python 2 / 3 compatible imports.
  [pbauer]

- Minor refactoring of registry import (DRY).
  [jensens]


1.6.1 (2017-06-04)
------------------

Bug fixes:

- remove unittest2 dependency
  [kakshay21]


1.6 (2017-05-23)
----------------

New features:

- be able to split your registry.xml file into multiple files in a sub-directory `registry`
  [vangheem]

- Add ability to import/export records through control panel
  [vangheem]

- Add ability to add new record through control panel
  [vangheem]

- Add ability to delete record through control panel
  [vangheem]

- Document new features
  [tkimnguyen]


1.5 (2016-10-23)
----------------

New features:

- Add support for *have* and *have-not* import conditions in
  registry.xml
  [datakurre]


1.4 (2016-09-14)
----------------

New features:

- Add support for optional condition attribute in registry.xml entries
  to allow conditional importing of records. Conditions themselves are
  not import (nor exported).
  [datakurre]


1.3.12 (2016-06-27)
-------------------

New:

- Add traceback info with record name to importer in order to ease debugging.
  [jensens]


1.3.11 (2016-03-31)
-------------------

New:

- For ``ControlPanelFormWrapper`` and ``@@configuration_registry``, construct the base url to the ``@@overview-controlpanel`` from the nearest site.
  This gives more flexibility when calling controlpanels on sub sites with local registries while in standard Plone installations the controlpanel is still bound to the portal url.
  [thet]


1.3.10 (2016-02-27)
-------------------

Fixes:

- Saving registry value in modal no longer reloads whole page
  [vangheem]


1.3.9 (2016-02-20)
------------------

Fixes:

- Document how to remove a registry record with Python.
  [gforcada]


1.3.8 (2016-02-08)
------------------

New:

- Updated to work with new plone.batching ``pagination`` selector as
  well as with old one.  [davilima6]


1.3.7 (2015-11-28)
------------------

Fixes:

- Updated Site Setup link in all control panels.
  Fixes https://github.com/plone/Products.CMFPlone/issues/1255
  [davilima6]


1.3.6 (2015-10-27)
------------------

New:

- Show loading icon in control panel when searching.
  [vangheem]

Fixes:

- Cleanup: pep8, utf8 headers, readability, etc.
  [jensens]

- Let our ``plone.app.registry`` import step depend on ``typeinfo``.
  The portal types may be needed for vocabularies.  For example, you
  could get an error when adding a not yet installed type to
  ``types_not_searched``.
  Fixes https://github.com/plone/Products.CMFPlone/issues/1118
  [maurits]


1.3.5 (2015-09-20)
------------------

- Fix styling alignment issues with the buttons.
  [sneridagh]


1.3.4 (2015-09-14)
------------------

- registry javascript fix to not auto-expand search field as it was
  not working well
  [vangheem]


1.3.3 (2015-09-08)
------------------

- Fix modal in control panel
  [vangheem]


1.3.2 (2015-08-20)
------------------

- Added the `structure` keyword to the TALES expression that returns the description for registry entries.
  This ensures that descriptions are properly escaped and HTML entities don't show up in descriptions.
  [pigeonflight]


1.3.1 (2015-07-18)
------------------

- Change the category of the configlet to 'plone-advanced'.
  [sneridagh]

- Make configlets titles consistent across the site, first letter capitalized.
  [sneridagh]


1.3.0 (2015-03-13)
------------------

- fix control panel filtering to work with plone 5 and patterns
  [vangheem]


1.2.3 (2013-05-23)
------------------

- Fix control panel filtering (https://dev.plone.org/ticket/13557)
  [vangheem, danjacka]


1.2.2 (2013-01-13)
------------------

- Acquisition-wrap value dictionary such that widgets get a useful
  context.
  [malthe]

- Allow XML comments in registry.xml
  [gweis]

- allow using purge=false in dict.value_type == list registry
  imports.
  [vangheem]


1.2.1 (2012-10-16)
------------------

- Unified the control panel html structure.
  [TH-code]

- Fix jquery selectors
  [vangheem]

- handle control panel prefixes for fields that do not
  have interfaces better.
  [vangheem]


1.2 (2012-08-29)
----------------

- Control panel: Records without interface no longer cause
  "AttributeError: 'NoneType' object has no attribute 'split'".
  [kleist]

- Allow deletion of records by interface in GenericSetup.
  [mitchellrj]

- Deprecated the 'delete' attribute of <record /> and <records /> nodes
  in GenericSetup, in favor of 'remove'.
  [mitchellrj]

- Show 'Changes canceled.' message after control panel edit form is canceled
  to comply with plone.app.controlpanel behavior.
  [timo]

- Redirect to the form itself on control panel edit form submit to comply with
  plone.app.controlpanel behavior.
  [timo]


1.2a1 (2012-06-29)
------------------

- Use lxml instead of elementtree.
  [davisagli]

- Remove unused zope.app.component import.
  [hannosch]

- Better control panel view.
  [vangheem]


1.1 (2012-04-15)
----------------

- Add support for internationalization of strings imported into the
  registry.
  [davisagli]


1.0.1 (2011-09-19)
------------------

- On the portal_registry configlet, enable the left-menu, to be more consistent
  with all other configlets.
  Fixes http://dev.plone.org/plone/ticket/11737
  [WouterVH]

- On the portal_registry configlet, add link to "Site Setup".
  Fixes http://dev.plone.org/plone/ticket/11855
  [WouterVH]


1.0 - 2011-05-13
----------------

- 1.0 Final release.
  [esteele]

- Add MANIFEST.in.
  [WouterVH]


1.0b6 - 2011-04-06
------------------

- Add ``collectionOfInterface`` export/import support.
  [elro]


1.0b5 - 2011-02-04
------------------

- Declare Products.CMFCore zcml dependency to fix zcml loading under Zope
  2.13.
  [elro]

- Add support for the <field ref="..." /> syntax to import FieldRefs.
  Requires plone.registry >= 1.0b4.
  [optilude]


1.0b4 - 2011-01-18
------------------

- Switch controlpanel slot to prefs_configlet_main.
  [toutpt]


1.0b3 - 2011-01-04
------------------

- Depend on ``Products.CMFPlone`` instead of ``Plone``.
  [elro]

- Show status messages and a back link in the control panel view.
  [timo]

- Use plone domain to translate messages of this package.
  [vincentfretin]

- Add a prefix support to controlpanel.RegistryEditForm
  [garbas]


1.0b2 - 2010-04-21
------------------

- Ensure fields that are imported from XML only (no interface) have a name.
  This fixes a problem with edit forms breaking.
  [optilude]

- Capitalize the control panel link to match the Plone standard.
  [esteele]

- Overlay now reloads the registry listing on successful submit.
  [esteele]

- Pass the name of the interface, not the interface itself to the <records />
  importer.
  [esteele]

- Modify JS overlay call to pull in the #content div.
  [esteele]

- Allow <value> elements inside <records> if they contain a key attribute.
  This uses the record importer to set the values after creation.
  [MatthewWilkes]

- Add a prefix attribute to the <records /> importer to take advantage of the
  interfaces-as-templates pattern from plone.registry
  [MatthewWilkes]

- Improved the look and feel of the registry records control panel.
  [optilude]

- Added explanation how to plug-in custom widgets for the registry [miohtama]


1.0b1 - 2009-08-02
------------------

- Test with plone.registry 1.0b1
  [optilude]


1.0a3 - 2009-07-12
------------------

- Catch up with changes in plone.supermodel's API.
  [optilude]


1.0a2 - 2009-04-17
------------------

- Fixed typo in ZCML registration; tuple has a 'p' in it.  This fixes exportimport of tuple fields.
  [MatthewWilkes]

- Add missing handlers.zcml include
  [MatthewWilkes]


1.0a1 - 2009-04-17
------------------

- Initial release

            

Raw data

            {
    "_id": null,
    "home_page": "https://pypi.org/project/plone.app.registry",
    "name": "plone.app.registry",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "plone registry settings configuration",
    "author": "Martin Aspeli",
    "author_email": "optilude@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/62/2f/dbb80a2543bd72712694d608e23d76b9fe52ae01619190c878f5bd5583ee/plone_app_registry-2.0.5.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n``plone.app.registry`` provides Plone UI and GenericSetup integration for\n`plone.registry`_, which in turn implements a configuration registry for\nZope applications. For details about how the registry works, please see the\n`plone.registry`_ documentation. What follows is a brief overview of common\nusage patterns in Plone.\n\n.. contents:: Table of contents\n\nOverview\n========\n\nThe registry provided by `plone.registry`_ is intended to store settings in\na safe, easily accessible manner. This makes it well-suited for applications\nand add-on products that need to manage some configurable, user-editable\nvalues. It is intended to replace the use of (less powerful and user friendly)\nZope 2 property sheets, as well as (less safe and more difficult to access)\npersistent local utilities for managing such configuration.\n\nThe registry is *not* an arbitrary data store. For the most part, you can\nstore any Python primitive there, but not more complex data structures or\nobjects. This means that the registry cannot be broken by packages being\nuninstalled, and that it can provide a simple, generic user interface for\nediting values.\n\nThe registry is made up of *records*. A record consists of a *field*,\ndescribing the record, and a *value*.  Fields are based on the venerable\n``zope.schema``, although the standard allowable field types are defined in\nthe module ``plone.registry.field``. (This is partly because the field\ndefinitions are actually persisted with the record, and partly because\n``plone.registry`` performs some additional validation to ensure the integrity\nof the registry).\n\nA record can be created programmatically, though in a Plone context it is more\ncommon to install records using the ``records.xml`` GenericSetup syntax. Once\nthe record has been created, its value can be read and set using standard\nPython dictionary syntax. Accessing the record and field is just as easy.\n\nEach record has a unique name, which must be a *dotted name* prefixed by the\npackage owning the record. For example, a record owned by the package\n``my.package`` could have a name like ``my.package.myrecord``.\n\nAs of version 1.6, it is possible to split ``registry.xml`` into\nmultiple files; to import and export registry entries via the control\npanel; and to add and delete records via the control panel.\n\nNotes about versions\n====================\n\n- versions 1.3 and later are for Plone 5.\n\n- versions 1.2.x are for Plone 4.\n\nUsage\n=====\n\nThis section describes how the registry is most commonly used in a Plone\ncontext. For more details, please see the `plone.registry`_ documentation.\n\nUsing GenericSetup to manipulate the registry\n---------------------------------------------\n\nThe best way to create, modify and delete registry records when writing Plone\nadd-on products is normally to use GenericSetup.\n\nCreating records\n~~~~~~~~~~~~~~~~\n\nOnce you have decided that you need a particular record, you need to answer\ntwo questions:\n\n1. What should the record be called?\n2. What type of data should it hold?\n\nLet's say you wanted to create a record call ``my.package.timeout``, holding\nan integer. Integers are described by the field type\n``plone.registry.field.Int``. Almost all the standard fields you would find\nin ``zope.schema`` have an equivalent field in ``plone.registry.field``. The\nmain exception is ``Object``, which is unsupported. Also, ``Choice`` fields\nonly support vocabularies given by string name, or as a list of string values.\nFinally, you cannot use the ``constraint`` property to set a validator\nfunction, although other validation (such as min/max values) will work.\n\nTo install such a record, you could add a ``registry.xml`` step to the\nGenericSetup profile of your product like this::\n\n    <registry>\n\n        <record name=\"my.package.timeout\">\n            <field type=\"plone.registry.field.Int\">\n                <title>Timeout</title>\n                <min>0</min>\n            </field>\n            <value>100</value>\n        </record>\n\n    </registry>\n\nLet's look at this in more detail:\n\n* There is one record declared. The name is given in the ``name`` attribute.\n* In the record, we first define the field type, by giving the full dotted\n  name to the field class. Unless you have installed a third party package\n  providing additional persistent fields, this will be a class in\n  ``plone.registry.field`` mirroring a corresponding class in ``zope.schema``.\n* Inside the ``<field />`` element, we list any required or optional\n  attributes of the field. This uses `plone.supermodel`_ syntax. In essence,\n  each allowed field attribute is represented by a tag (so the ``title``\n  attribute can be set with the ``<title />`` tag), with the attribute value\n  given as the tag body. If an attribute is required for a field, the\n  corresponding tag is required here.\n* We then set the value. This must obviously be a valid value for the field\n  type.\n\nNote that the ``<value />`` is optional. If not given, the field will default\nto its ``missing_value`` until it is set. The ``<field />`` is optional if\nthe record has already been initialised elsewhere.\n\nMost field attributes are simple tags like the ones shown above, with the\nfield name used as the tag name, and a string representation of the value\nused as the contents of the tag. Collection fields are a little more involved,\nhowever. A collection field (like a ``List`` or ``Tuple``) has a\n``value_type`` property containing another field. Also, their values and\ndefaults are sequences. Let's look at an example::\n\n    <record name=\"my.package.animals\">\n        <field type=\"plone.registry.field.Tuple\">\n            <title>Animals</title>\n            <description>A list of cool animals</description>\n            <value_type type=\"plone.registry.field.TextLine\" />\n        </field>\n        <value>\n            <element>Dog</element>\n            <element>Cat</element>\n            <element>Elephant</element>\n        </value>\n    </record>\n\nNotice how the ``<value_type />`` tag takes a ``type`` attribute just like\nthe outer ``<field />`` tag. Here we have shown a value type with no options,\nbut if you need, you can put tags for additional field attributes inside the\n``<value_type />`` tag.\n\nAlso notice how the value is represented. Each element in the sequence (a\ntuple in this case) is given by an ``<element />`` tag, with the element\nvalue given as the body of that tag.\n\n``Dict`` fields also have a ``<key_type />`` and elements that are key/value\npairs. They can be configured like so::\n\n    <record name=\"my.package.animalFood\">\n        <field type=\"plone.registry.field.Dict\">\n            <title>Food eaten by animals</title>\n            <key_type type=\"plone.registry.field.TextLine\" />\n            <value_type type=\"plone.registry.field.TextLine\" />\n        </field>\n        <value>\n            <element key=\"Dog\">Dog food</element>\n            <element key=\"Cat\">Cat food</element>\n            <element key=\"Elephant\">Squirrels</element>\n        </value>\n    </record>\n\nUsing multiple registry XML files\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nInstead of storing registry entries in a single, large\n``registry.xml`` file, you can have Generic Setup load and process\nregistry entries from multiple files. This makes it easier to manage\nand organize the registry entries provided by your applications and\nadd-ons.\n\nYour add-on should include a folder named ``registry`` in its\nprofile(s) folders, e.g. ``profiles/default/registry``. Any XML files\nin that folder will be read and processed by the registry the same way\nit would have read and processed a single ``registry.xml`` file in\nthe ``profiles/default`` folder.\n\nAs an example, see how `Castle CMS\n<https://github.com/castlecms/castle.cms>`_ uses multiple XML files in\nits `profiles/default/registry\n<https://github.com/castlecms/castle.cms/tree/master/castle/cms/profiles/default/registry>`_\nfolder.\n\nThe registry will process both the ``registry.xml`` file and the\ncontents of a ``registry`` folder, if both exist.\n\n\nConditional records\n~~~~~~~~~~~~~~~~~~~\n\nImportable records in ``registry.xml`` can be marked conditional with\n``condition`` attribute, which supports the following condition values:\n\n* ``installed my.package``, which causes record to be imported only when\n  python module ``my.package`` is available to be imported.\n\n* ``not-installed my.package``, which causes record to be imported only when\n  python module ``my.package`` is *not* available to be imported:\n\n* ``have my-feature``, which causes record to be imported only when\n  ZCML feature flag ``my-feature`` has been registered (Zope2 only)\n\n* ``not-have my-feature``, which causes record to be imported only when\n  ZCML feature flag ``my-feature`` has *not* been registered (Zope2 only)\n\nFor example, the following ``registry.xml`` step at the GenericSetup profile of\nyour policy product, would only import records when module ``my.package`` is\navailable::\n\n    <registry>\n      <records interface=\"my.package.interfaces.IZooSettings\"\n               condition=\"installed my.package\">\n        <value key=\"entryPrice\">40</value>\n        <value key=\"messageOfTheDay\">We've got lions and tigers!</value>\n      </records>\n    </registry>\n\n\nField references\n~~~~~~~~~~~~~~~~\n\nIt is possible to define record to use another record's field. This is often\nuseful if you want one record to act as an optional override for another.\nFor example::\n\n    <registry>\n\n        <record name=\"my.package.timeout\">\n            <field type=\"plone.registry.field.Int\">\n                <title>Timeout</title>\n                <min>0</min>\n            </field>\n            <value>100</value>\n        </record>\n\n        <record name=\"my.package.timeout.slowconnection\">\n            <field ref=\"my.package.timeout\" />\n            <value>300</value>\n        </record>\n\n    </registry>\n\nIn this example, we have defined the ``my.package.timeout`` record with an\ninteger field. We then have a separate record, with a separate value,\ncalled ``my.package.timeout.slowconnection``, which uses the same field\n(with the same type, validation, title, description, etc). This avoids having\nto explicitly re-define a complete field.\n\nNote: The field in this case is actually a ``FieldRef`` object. See the\n`plone.registry`_ documentation for details.\n\nSetting values\n~~~~~~~~~~~~~~\n\nOnce a record has been defined, its value can be set or updated using\nGenericSetup like so::\n\n    <record name=\"my.package.animalFood\">\n        <value purge=\"false\">\n            <element key=\"Squirrel\">Nuts</element>\n            <element key=\"Piranha\">Other piranha</element>\n        </value>\n    </record>\n\nThis is often useful if you have a record defined in one package that is\nappended to or customised in another package.\n\nIn the example above, we used the ``purge`` attribute. When setting the value\nof a multi-valued field such as a tuple, list, set or dictionary, setting this\nattribute to ``false`` will cause the values listed to be added to the\nexisting collection, rather than overriding the collection entirely, as would\nhappen if the ``purge`` attribute was set to ``true`` or omitted.\n\nDeleting records\n~~~~~~~~~~~~~~~~\n\nTo delete a record, use the ``remove`` attribute::\n\n    <record name=\"my.package.animalFood\" remove=\"true\" />\n\nIf the record does not exist, a warning will be logged, but processing will\ncontinue.\n\nCreating records based on an interface\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIn the examples above, we created individual records directly in the registry.\nSometimes, however, it is easier to work with traditional schema interfaces\nthat group together several related fields. As we will see below,\n``plone.registry`` and ``plone.app.registry`` provide certain additional\nfunctionality for groups of records created from an interface.\n\nFor example, we could have an interface like this::\n\n    from zope.interface import Interface\n    from zope import schema\n\n    class IZooSettings(Interface):\n\n        entryPrice = schema.Decimal(title=u\"Admission charge\")\n        messageOfTheDay = schema.TextLine(title=u\"A banner message\", default=u\"Welcome!\")\n\nNotice how we are using standard ``zope.schema`` fields. These will be\nconverted to persistent fields (by adapting them to ``IPersistentField`` from\n``plone.registry``) when the registry is populated. If that is not possible,\nan error will occur on import.\n\nTo register these records, we simply add the following to ``registry.xml``::\n\n    <records interface=\"my.package.interfaces.IZooSettings\" />\n\n\nThis will create one record for each field. The record names are the full\ndotted names to the fields, so in this case they would be\n``my.package.interfaces.IZooSettings.entryPrice`` and\n``my.package.interfaces.IZooSettings.messageOfTheDay``.\n\nIf you just want to use the interface as a template you can supply a\n``prefix`` attribute::\n\n    <records interface=\"my.package.interfaces.IZooSettings\" prefix=\"my.zoo\" />\n\nwhich will generate fields named ``my.zoo.entryPrice`` and\n``my.zoo.messageOfTheDay``.\n\nIn order to set the values of the fields created by a <records /> directive\nyou must provide ``value`` entries with keys corresponding to the fields on\nthe interface, as follows::\n\n    <records interface=\"my.package.interfaces.IZooSettings\" prefix=\"my.zoo\">\n        <value key=\"entryPrice\">40</value>\n        <value key=\"messageOfTheDay\">We've got lions and tigers!</value>\n    </records>\n\nValues can be set as above using the full record name. However, we can also\nexplicitly state that we are setting a record bound to an interface, like so::\n\n    <record interface=\"my.package.interfaces.IZooSettings\" field=\"entryPrice\">\n        <value>10.0</value>\n    </record>\n\nThis is equivalent to::\n\n    <record name=\"my.package.interfaces.IZooSettings.entryPrice\">\n        <value>10.0</value>\n    </record>\n\nYou can also use the ``interface``/``field`` syntax to register a new record\nfrom an individual field.\n\nFinally, if the interface contains fields that cannot or should be set, they\nmay be omitted::\n\n    <records interface=\"my.package.interfaces.IZooSettings\">\n        <omit>someField</omit>\n    </records>\n\nThe ``<omit />`` tag can be repeated to exclude multiple fields.\n\nDeleting records based on an interface\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo delete a set of records, based on an interface use the ``remove``\nattribute::\n\n    <records interface=\"my.package.interfaces.IZooSettings\" remove=\"true\" />\n\nIf the record does not exist for any of the interface fields, a warning will\nbe logged, but processing will continue.\n\nIf you do not wish to delete, or wish to exclude certain fields, they may be\nomitted::\n\n    <records interface=\"my.package.interfaces.IZooSettings\" remove=\"true\">\n        <omit>someField</omit>\n    </records>\n\nThe ``<omit />`` tag can be repeated to exclude multiple fields.\n\nUsing the registry in Python code\n---------------------------------\n\nNow that we have seen how to manage records through GenericSetup, we can start\nusing values from the registry in our code.\n\nAccessing the registry\n~~~~~~~~~~~~~~~~~~~~~~\n\nTo get or set the value of a record, we must first look up the registry\nitself. The registry is registered as a local utility, so we can look it up\nwith::\n\n    from zope.component import getUtility\n    from plone.registry.interfaces import IRegistry\n\n    registry = getUtility(IRegistry)\n\nValues can now get read or set using simple dictionary syntax::\n\n    timeout = registry['my.package.timeout']\n\nWe can also use ``get()`` to get the value conditionally, and an ``in`` check\nto test whether the registry contains a particular record.\n\nThe returned value will by of a type consistent with the field for the record\nwith the given name. It can be set in the same manner::\n\n    registry['my.package.timeout'] = 120\n\nIf you need to access the underlying record, use the ``records`` attribute::\n\n    timeoutRecord = registry.records['my.package.timeout']\n\nThe record returned conforms to ``plone.registry.interfaces.IRecord`` and has\ntwo main attributes: ``value`` is the current record value, and ``field`` is\nthe persistent field instance. If the record was created from an interface,\nit will also provide ``IInterfaceAwareRecord`` and have three additional\nattributes: ``interfaceName``, the string name of the interface;\n``interface``, the interface instance itself, and ``fieldName``, the name of\nthe field in the interface from which this record was created.\n\nYou can delete the whole record programmatically with the Python ``del``\nstatement::\n\n    del registry.records['my.package.timeout']\n\nIn unit tests, it may be useful to create a new record programmatically.\nYou can do that like so::\n\n    from plone.registry.record import Record\n    from plone.registry import field\n\n    registry.records['my.record'] = Record(field.TextLine(title=u\"A record\"), u\"Test\")\n\nThe constructor takes a persistent field and the initial value as parameters.\n\nTo register records for an interface programmatically, we can do::\n\n    registry.registerInterface(IZooSettings)\n\nYou can omit fields by passing an ``omit`` parameter giving a sequence of\nomitted field names.\n\nSee ``plone.registry`` for more details about how to introspect and manipulate\nthe registry records programmatically.\n\nAccessing the registry in page templates\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can also access the registry from page templates. Example TALES expression::\n\n     python:context.portal_registry['plone.app.theming.interfaces.IThemeSettings.enabled']\n\nUsing the records proxy\n~~~~~~~~~~~~~~~~~~~~~~~\n\nAbove, we used dictionary syntax to access individual records and values. This\nwill always work, but for so-called interface-aware records - those which were\ncreated from an interface e.g. using the ``<records />`` syntax - we have\nanother option: the records proxy. This allows us to look up all the records\nthat belong to a particular interface at the same time, returning an object\nthat provides the given interface and can be manipulated like an object, that\nis still connected to the underlying registry.\n\nTo look up a records proxy for our ``IZooSettings`` interface, we can do::\n\n    zooSettings = registry.forInterface(IZooSettings)\n\nThe ``zooSettings`` object now provides ``IZooSettings``. Values may be\nread and set using attribute notation::\n\n    zooSettings.messageOfTheDay = u\"New message\"\n    currentEntryPrice = zooSettings.entryPrice\n\nWhen setting a value, it is immediately validated and written to the registry.\nA validation error exception may be raised if the value is not permitted by\nthe field for the corresponding record.\n\nWhen fetching the records proxy, ``plone.registry`` will by default verify\nthat records exists for each field in the interface, and will raise an error\nif this is not the case. To disable this check, you can do::\n\n    zooSettings = registry.forInterface(IZooSettings, check=False)\n\nThis is sometimes useful in cases where it is not certain that the registry\nhas been initialised. You can also omit checking for individual fields, by\npassing an ``omit`` parameter giving a tuple of field names.\n\nDelete records\n~~~~~~~~~~~~~~\n\nTo delete a record is as simple as::\n\n    del registry.records['plone.app.theming.interfaces.IThemeSettings.enabled']\n\nRegistry events\n~~~~~~~~~~~~~~~\n\nThe registry emits events when it is modified:\n\n* ``plone.registry.interfaces.IRecordAddedEvent`` is fired when a record has\n  been added to the registry.\n* ``plone.registry.interfaces.IRecordRemovedEvent`` is fired when a record\n  has been removed from the registry.\n* ``plone.registry.interfaces.IRecordModifiedEvent`` is fired when a record's\n  value is modified.\n\nYou can register subscribers for these to catch any changes to the registry.\nIn addition, you can register an event handler that only listens to changes\npertaining to records associated with specific interfaces. For example::\n\n    from zope.component import adapter\n    from plone.registry.interfaces import IRecordModifiedEvent\n\n    from logging import getLogger\n    log = getLogger('my.package')\n\n    @adapter(IZooSettings, IRecordModifiedEvent)\n    def detectPriceChange(settings, event):\n        if record.fieldName == 'entryPrice':\n            log.warning(\"Someone change the price from %d to %d\" % (event.oldValue, event.newValue,))\n\nSee `plone.registry`_ for details about these event types.\n\nCreating a custom control panel\n-------------------------------\n\nThe generic control panel is useful as a system administrator's tool for low-\nlevel configuration. If you are writing a package aimed more at system\nintegrators and content managers, you may want to provide a more user-friendly\ncontrol panel to manage settings.\n\nIf you register your records from an interface as shown above, this package\nprovides a convenience framework based on `plone.autoform`_ and `z3c.form`_\nthat makes it easy to create your own control panel.\n\nTo use it, create a module like this::\n\n    from plone.app.registry.browser.controlpanel import RegistryEditForm\n    from plone.app.registry.browser.controlpanel import ControlPanelFormWrapper\n\n    from my.package.interfaces import IZooSettings\n    from plone.z3cform import layout\n    from z3c.form import form\n\n    class ZooControlPanelForm(RegistryEditForm):\n        form.extends(RegistryEditForm)\n        schema = IZooSettings\n\n    ZooControlPanelView = layout.wrap_form(ZooControlPanelForm, ControlPanelFormWrapper)\n    ZooControlPanelView.label = u\"Zoo settings\"\n\nRegister the ``ZooControlPanelView`` as a view::\n\n    <browser:page\n        name=\"zoo-controlpanel\"\n        for=\"Products.CMFPlone.interfaces.IPloneSiteRoot\"\n        permission=\"cmf.ManagePortal\"\n        class=\".controlpanel.ZooControlPanelView\"\n        />\n\nThen install this in the Plone control panel using the ``controlpanel.xml``\nimport step in your GenericSetup profile::\n\n    <?xml version=\"1.0\"?>\n    <object\n        name=\"portal_controlpanel\"\n        xmlns:i18n=\"http://xml.zope.org/namespaces/i18n\"\n        i18n:domain=\"my.package\">\n\n        <configlet\n            title=\"Zoo settings\"\n            action_id=\"my.package.zoosettings\"\n            appId=\"my.package\"\n            category=\"Products\"\n            condition_expr=\"\"\n            url_expr=\"string:${portal_url}/@@zoo-controlpanel\"\n            icon_expr=\"string:${portal_url}/++resource++my.package/icon.png\"\n            visible=\"True\"\n            i18n:attributes=\"title\">\n                <permission>Manage portal</permission>\n        </configlet>\n\n    </object>\n\nThe ``icon_expr`` attribute should give a URL for the icon. Here, we have\nassumed that a resource directory called ``my.package`` is registered and\ncontains the file ``icon.png``. You may omit the icon as well.\n\nUsing the Configuration Registry control panel\n----------------------------------------------\n\nViewing and editing records through the control panel\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThis package provides the \"Configuration Registry\" control panel in\nPlone's Site Setup. Here, you can view all registry records, you can\nsearch for records using a case sensitive filter field, and you can\nselect sets of records according to their prefix\n(e.g. \"IDiscussionSettings\", \"plone.app.caching\").\n\nRegistry records' names, titles, descriptions, data types and current\nvalues are displayed.\n\n.. figure:: https://raw.githubusercontent.com/plone/plone.app.registry/master/docs/configuration_registry_screenshot.jpg\n\n\t    The Configuration Registry control panel\n\nIf you click on a record, an edit form appears that allows you to\nchange its value.\n\n.. figure:: https://raw.githubusercontent.com/plone/plone.app.registry/master/docs/configuration_registry_edit_record_screenshot.jpg\n\n\t    How to change the value of a registry record\n\n\nExporting and importing records through the control panel\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can use the Configuration Registry control panel's Export tab to\nexport the entire registry into a single XML file.  When you click the\nExport Now button, a file named ``registry.xml`` will be downloaded to\nyour computer.\n\n.. figure:: https://raw.githubusercontent.com/plone/plone.app.registry/master/docs/configuration_registry_export_screenshot.jpg\n\n\t    How to export the entire registry\n\nTo import registry entries, use the Configuration Registry control\npanel's Import tab, use the Choose File button to select an XML file\nfrom your computer containing the registry entries, then press the\nImport File button.\n\n.. figure:: https://raw.githubusercontent.com/plone/plone.app.registry/master/docs/configuration_registry_import_screenshot.jpg\n\n\t    How to import a registry file\n\n\nAdding and deleting records through the control panel\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can add individual registry records using the Configuration\nRegistry control panel's \"Add new record\" tab.\n\nEnter the registry record's name, (human readable) title, select a\ndata type, and optionally check the Required box if the record must\nhave a value. Then press the \"Add field\" button.\n\n.. figure:: https://raw.githubusercontent.com/plone/plone.app.registry/master/docs/configuration_registry_add_record_screenshot.jpg\n\n\nControl panel widget settings\n=============================\n\nplone.app.registry provides ``RegistryEditForm`` class which is a subclass of\n``z3c.form.form.Form``.\n\n``RegistryEditForm`` has two methods to override which and how widgets are going\nto be used in the control panel form.\n\n* ``updateFields()`` may set widget factories i.e. widget type to be used\n\n* ``updateWidgets()`` may play with widget properties and widget value\n  shown to the user\n\nExample (*collective.gtags* project controlpanel.py)::\n\n        class TagSettingsEditForm(controlpanel.RegistryEditForm):\n\n            schema = ITagSettings\n            label = _(u\"Tagging settings\")\n            description = _(u\"Please enter details of available tags\")\n\n            def updateFields(self):\n                super(TagSettingsEditForm, self).updateFields()\n                self.fields['tags'].widgetFactory = TextLinesFieldWidget\n                self.fields['unique_categories'].widgetFactory = TextLinesFieldWidget\n                self.fields['required_categories'].widgetFactory = TextLinesFieldWidget\n\n            def updateWidgets(self):\n                super(TagSettingsEditForm, self).updateWidgets()\n                self.widgets['tags'].rows = 8\n                self.widgets['tags'].style = u'width: 30%;'\n\nTroubleshooting\n===============\n\nThe following sections describe some commonly encountered problems, with\nsuggestions for how to resolve them.\n\nRequired dependency add-ons installed\n-------------------------------------\n\nBoth ``plone.app.z3cform`` (Plone z3c.form support) and ``plone.app.registry``\n(Configuration registry) add-ons must be installed at Plone site before you\ncan use any control panel configlets using plone.app.registry framework.\n\nKeyError: a field for which there is no record\n----------------------------------------------\n\nExample traceback::\n\n        Module plone.app.registry.browser.controlpanel, line 44, in getContent\n          Module plone.registry.registry, line 56, in forInterface\n        KeyError: 'Interface `mfabrik.plonezohointegration.interfaces.ISettings` defines a field `username`, for which there is no record.'\n\nThis means that\n\n* Your registry.xml does not define default values for your configuration keys\n* You have changed your configuration schema, but haven't rerun add-on\n  installer to initialize default values\n* You might need to use the same prefix as you use for the interface name in\n  your settings::\n\n        <records prefix=\"mfabrik.plonezohointegration.interfaces.ISettings\" interface=\"mfabrik.plonezohointegration.interfaces.ISettings\">\n\n.. _plone.registry: http://pypi.python.org/pypi/plone.registry\n.. _plone.supermodel: http://pypi.python.org/pypi/plone.supermodel\n.. _plone.autoform: http://pypi.python.org/pypi/plone.autoform\n.. _z3c.form: http://pypi.python.org/pypi/z3c.form\n\nChangelog\n=========\n\n.. You should *NOT* be adding new change log entries to this file.\n   You should create a file in the news directory instead.\n   For helpful instructions, please see:\n   https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst\n\n.. towncrier release notes start\n\n2.0.5 (2024-05-30)\n------------------\n\nBug fixes:\n\n\n- Removes duplicate `<article id=\"content\">`\n  [@szakitibi] (#84)\n- Fix misleading portal message when NOT deleting records @gforcada\n\n\n2.0.4 (2023-12-14)\n------------------\n\nBug fixes:\n\n\n- disable visibility of the right column in records template\n  [1letter] (#71)\n- Fix template error deleting registry record.\n  [maurits] (#76)\n\n\n2.0.3 (2023-10-18)\n------------------\n\nInternal:\n\n\n- Require ``setuptools`` 68.2+ for building the package.\n  [plone devs] (18d04723)\n- Update configuration files.\n  [plone devs] (cfffba8c)\n\n\n2.0.2 (2023-04-15)\n------------------\n\nInternal:\n\n\n- Update configuration files.\n  [plone devs] (5623f8b3)\n\n\n2.0.1 (2022-12-10)\n------------------\n\nBug fixes:\n\n\n- Fix responsive table.\n  [petschki] (#64)\n\n\n2.0.0 (2022-11-30)\n------------------\n\nBug fixes:\n\n\n- Final release.\n  [gforcada] (#600)\n\n\n2.0.0a9 (2022-05-09)\n--------------------\n\nBreaking changes:\n\n\n- isort, black, pyupgrade. Use plone.base and dependency cleanup.\n  [jensens] (#63)\n\n\nBug fixes:\n\n\n- Allow up to one dash in key when creating an a record ttw.\n  [pbauer] (#62)\n\n\n2.0.0a8 (2022-04-04)\n--------------------\n\nBreaking changes:\n\n\n- Remove registry.js, lives now in mockup [MrTango] (#57)\n\n\n2.0.0a7 (2022-01-25)\n--------------------\n\nBug fixes:\n\n\n- structured form description and explicit macro call\n  [petschki] (#60)\n\n\n2.0.0a6 (2022-01-19)\n--------------------\n\nBug fixes:\n\n\n- Ignoring dotted files in registry directories. [iham] (#3990)\n\n\n2.0.0a5 (2021-10-16)\n--------------------\n\nBug fixes:\n\n\n- Add missing i18n:translate tag\n  [erral] (#56)\n\n\n2.0.0a4 (2021-09-15)\n--------------------\n\nBug fixes:\n\n\n- Remove cyclic dependency with Products.CMFPlone\n  [sneridagh] (#54)\n\n\n2.0.0a3 (2021-09-01)\n--------------------\n\nBug fixes:\n\n\n- Fix an issue that was preventing the edit of a registry record containing a \"/\" in its name [ale-rt] (#51)\n\n\n2.0.0a2 (2021-08-04)\n--------------------\n\nNew features:\n\n\n- Add JSONField Handler for plone.registry.field.JSONField\n  - add component JSONFieldHandler\n  - add Tests for Import and Export JSONField\n  - add towncrier message\n  [1letter] (#48)\n\n\n2.0.0a1 (2021-04-20)\n--------------------\n\nBreaking changes:\n\n\n- Update for Plone 6 with Bootstrap markup\n  [jensens, petschki, agitator] (#45)\n\n\n1.7.8 (2021-01-08)\n------------------\n\nBug fixes:\n\n\n- Use better titles and descriptions for import and export steps.\n  [jensens] (#1)\n\n\n1.7.7 (2020-09-07)\n------------------\n\nBug fixes:\n\n\n- Make interface list on configuration export page visible. [jensens] (#41)\n\n\n1.7.6 (2020-04-20)\n------------------\n\nBug fixes:\n\n\n- Minor packaging updates. (#1)\n\n\n1.7.5 (2019-05-01)\n------------------\n\nBug fixes:\n\n\n- broken value in records table in Python 3\n  [petschki] (#36)\n\n\n1.7.4 (2019-03-03)\n------------------\n\nBug fixes:\n\n\n- Fix export of registry with Generic Setup. [pbauer] (#34)\n\n\n1.7.3 (2019-02-13)\n------------------\n\nBug fixes:\n\n\n- Fix some deprecation warnings. [gforcada] (#32)\n\n\n1.7.2 (2018-06-19)\n------------------\n\nNew features:\n\n- Added a pragmatic XML exporter for registry records in a format meant to be used in add-ons or policy profiles.\n  [jensens]\n\n\n1.7.1 (2018-04-08)\n------------------\n\nBug fixes:\n\n- Python 2 / 3 compatible imports.\n  [pbauer]\n\n\n1.7 (2018-02-04)\n----------------\n\nNew features:\n\n- Added traceback info of filename to importer in order to ease debugging.\n  [jensens]\n\nBug fixes:\n\n- Python 2 / 3 compatible imports.\n  [pbauer]\n\n- Minor refactoring of registry import (DRY).\n  [jensens]\n\n\n1.6.1 (2017-06-04)\n------------------\n\nBug fixes:\n\n- remove unittest2 dependency\n  [kakshay21]\n\n\n1.6 (2017-05-23)\n----------------\n\nNew features:\n\n- be able to split your registry.xml file into multiple files in a sub-directory `registry`\n  [vangheem]\n\n- Add ability to import/export records through control panel\n  [vangheem]\n\n- Add ability to add new record through control panel\n  [vangheem]\n\n- Add ability to delete record through control panel\n  [vangheem]\n\n- Document new features\n  [tkimnguyen]\n\n\n1.5 (2016-10-23)\n----------------\n\nNew features:\n\n- Add support for *have* and *have-not* import conditions in\n  registry.xml\n  [datakurre]\n\n\n1.4 (2016-09-14)\n----------------\n\nNew features:\n\n- Add support for optional condition attribute in registry.xml entries\n  to allow conditional importing of records. Conditions themselves are\n  not import (nor exported).\n  [datakurre]\n\n\n1.3.12 (2016-06-27)\n-------------------\n\nNew:\n\n- Add traceback info with record name to importer in order to ease debugging.\n  [jensens]\n\n\n1.3.11 (2016-03-31)\n-------------------\n\nNew:\n\n- For ``ControlPanelFormWrapper`` and ``@@configuration_registry``, construct the base url to the ``@@overview-controlpanel`` from the nearest site.\n  This gives more flexibility when calling controlpanels on sub sites with local registries while in standard Plone installations the controlpanel is still bound to the portal url.\n  [thet]\n\n\n1.3.10 (2016-02-27)\n-------------------\n\nFixes:\n\n- Saving registry value in modal no longer reloads whole page\n  [vangheem]\n\n\n1.3.9 (2016-02-20)\n------------------\n\nFixes:\n\n- Document how to remove a registry record with Python.\n  [gforcada]\n\n\n1.3.8 (2016-02-08)\n------------------\n\nNew:\n\n- Updated to work with new plone.batching ``pagination`` selector as\n  well as with old one.  [davilima6]\n\n\n1.3.7 (2015-11-28)\n------------------\n\nFixes:\n\n- Updated Site Setup link in all control panels.\n  Fixes https://github.com/plone/Products.CMFPlone/issues/1255\n  [davilima6]\n\n\n1.3.6 (2015-10-27)\n------------------\n\nNew:\n\n- Show loading icon in control panel when searching.\n  [vangheem]\n\nFixes:\n\n- Cleanup: pep8, utf8 headers, readability, etc.\n  [jensens]\n\n- Let our ``plone.app.registry`` import step depend on ``typeinfo``.\n  The portal types may be needed for vocabularies.  For example, you\n  could get an error when adding a not yet installed type to\n  ``types_not_searched``.\n  Fixes https://github.com/plone/Products.CMFPlone/issues/1118\n  [maurits]\n\n\n1.3.5 (2015-09-20)\n------------------\n\n- Fix styling alignment issues with the buttons.\n  [sneridagh]\n\n\n1.3.4 (2015-09-14)\n------------------\n\n- registry javascript fix to not auto-expand search field as it was\n  not working well\n  [vangheem]\n\n\n1.3.3 (2015-09-08)\n------------------\n\n- Fix modal in control panel\n  [vangheem]\n\n\n1.3.2 (2015-08-20)\n------------------\n\n- Added the `structure` keyword to the TALES expression that returns the description for registry entries.\n  This ensures that descriptions are properly escaped and HTML entities don't show up in descriptions.\n  [pigeonflight]\n\n\n1.3.1 (2015-07-18)\n------------------\n\n- Change the category of the configlet to 'plone-advanced'.\n  [sneridagh]\n\n- Make configlets titles consistent across the site, first letter capitalized.\n  [sneridagh]\n\n\n1.3.0 (2015-03-13)\n------------------\n\n- fix control panel filtering to work with plone 5 and patterns\n  [vangheem]\n\n\n1.2.3 (2013-05-23)\n------------------\n\n- Fix control panel filtering (https://dev.plone.org/ticket/13557)\n  [vangheem, danjacka]\n\n\n1.2.2 (2013-01-13)\n------------------\n\n- Acquisition-wrap value dictionary such that widgets get a useful\n  context.\n  [malthe]\n\n- Allow XML comments in registry.xml\n  [gweis]\n\n- allow using purge=false in dict.value_type == list registry\n  imports.\n  [vangheem]\n\n\n1.2.1 (2012-10-16)\n------------------\n\n- Unified the control panel html structure.\n  [TH-code]\n\n- Fix jquery selectors\n  [vangheem]\n\n- handle control panel prefixes for fields that do not\n  have interfaces better.\n  [vangheem]\n\n\n1.2 (2012-08-29)\n----------------\n\n- Control panel: Records without interface no longer cause\n  \"AttributeError: 'NoneType' object has no attribute 'split'\".\n  [kleist]\n\n- Allow deletion of records by interface in GenericSetup.\n  [mitchellrj]\n\n- Deprecated the 'delete' attribute of <record /> and <records /> nodes\n  in GenericSetup, in favor of 'remove'.\n  [mitchellrj]\n\n- Show 'Changes canceled.' message after control panel edit form is canceled\n  to comply with plone.app.controlpanel behavior.\n  [timo]\n\n- Redirect to the form itself on control panel edit form submit to comply with\n  plone.app.controlpanel behavior.\n  [timo]\n\n\n1.2a1 (2012-06-29)\n------------------\n\n- Use lxml instead of elementtree.\n  [davisagli]\n\n- Remove unused zope.app.component import.\n  [hannosch]\n\n- Better control panel view.\n  [vangheem]\n\n\n1.1 (2012-04-15)\n----------------\n\n- Add support for internationalization of strings imported into the\n  registry.\n  [davisagli]\n\n\n1.0.1 (2011-09-19)\n------------------\n\n- On the portal_registry configlet, enable the left-menu, to be more consistent\n  with all other configlets.\n  Fixes http://dev.plone.org/plone/ticket/11737\n  [WouterVH]\n\n- On the portal_registry configlet, add link to \"Site Setup\".\n  Fixes http://dev.plone.org/plone/ticket/11855\n  [WouterVH]\n\n\n1.0 - 2011-05-13\n----------------\n\n- 1.0 Final release.\n  [esteele]\n\n- Add MANIFEST.in.\n  [WouterVH]\n\n\n1.0b6 - 2011-04-06\n------------------\n\n- Add ``collectionOfInterface`` export/import support.\n  [elro]\n\n\n1.0b5 - 2011-02-04\n------------------\n\n- Declare Products.CMFCore zcml dependency to fix zcml loading under Zope\n  2.13.\n  [elro]\n\n- Add support for the <field ref=\"...\" /> syntax to import FieldRefs.\n  Requires plone.registry >= 1.0b4.\n  [optilude]\n\n\n1.0b4 - 2011-01-18\n------------------\n\n- Switch controlpanel slot to prefs_configlet_main.\n  [toutpt]\n\n\n1.0b3 - 2011-01-04\n------------------\n\n- Depend on ``Products.CMFPlone`` instead of ``Plone``.\n  [elro]\n\n- Show status messages and a back link in the control panel view.\n  [timo]\n\n- Use plone domain to translate messages of this package.\n  [vincentfretin]\n\n- Add a prefix support to controlpanel.RegistryEditForm\n  [garbas]\n\n\n1.0b2 - 2010-04-21\n------------------\n\n- Ensure fields that are imported from XML only (no interface) have a name.\n  This fixes a problem with edit forms breaking.\n  [optilude]\n\n- Capitalize the control panel link to match the Plone standard.\n  [esteele]\n\n- Overlay now reloads the registry listing on successful submit.\n  [esteele]\n\n- Pass the name of the interface, not the interface itself to the <records />\n  importer.\n  [esteele]\n\n- Modify JS overlay call to pull in the #content div.\n  [esteele]\n\n- Allow <value> elements inside <records> if they contain a key attribute.\n  This uses the record importer to set the values after creation.\n  [MatthewWilkes]\n\n- Add a prefix attribute to the <records /> importer to take advantage of the\n  interfaces-as-templates pattern from plone.registry\n  [MatthewWilkes]\n\n- Improved the look and feel of the registry records control panel.\n  [optilude]\n\n- Added explanation how to plug-in custom widgets for the registry [miohtama]\n\n\n1.0b1 - 2009-08-02\n------------------\n\n- Test with plone.registry 1.0b1\n  [optilude]\n\n\n1.0a3 - 2009-07-12\n------------------\n\n- Catch up with changes in plone.supermodel's API.\n  [optilude]\n\n\n1.0a2 - 2009-04-17\n------------------\n\n- Fixed typo in ZCML registration; tuple has a 'p' in it.  This fixes exportimport of tuple fields.\n  [MatthewWilkes]\n\n- Add missing handlers.zcml include\n  [MatthewWilkes]\n\n\n1.0a1 - 2009-04-17\n------------------\n\n- Initial release\n",
    "bugtrack_url": null,
    "license": "GPL",
    "summary": "Zope 2 and Plone  integration for plone.registry",
    "version": "2.0.5",
    "project_urls": {
        "Homepage": "https://pypi.org/project/plone.app.registry"
    },
    "split_keywords": [
        "plone",
        "registry",
        "settings",
        "configuration"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a5a76ed260477d3ccc719265ba6ac16dedc9e2e0f38cc48ce401f1d4c17f604c",
                "md5": "9c547b1205ce27fecd455bfe39faf9ea",
                "sha256": "637fbd96a2aa459fb5194c5a2a64796b40ae627e7f6628481d553ecec2cc8630"
            },
            "downloads": -1,
            "filename": "plone.app.registry-2.0.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9c547b1205ce27fecd455bfe39faf9ea",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 44961,
            "upload_time": "2024-05-30T18:32:10",
            "upload_time_iso_8601": "2024-05-30T18:32:10.087781Z",
            "url": "https://files.pythonhosted.org/packages/a5/a7/6ed260477d3ccc719265ba6ac16dedc9e2e0f38cc48ce401f1d4c17f604c/plone.app.registry-2.0.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "622fdbb80a2543bd72712694d608e23d76b9fe52ae01619190c878f5bd5583ee",
                "md5": "cf8b7381cabdacf462057c49cd1fb2da",
                "sha256": "816d0322b4d85161e2b8a131374b794c725c01600fae0d997e7f0e50137bf466"
            },
            "downloads": -1,
            "filename": "plone_app_registry-2.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "cf8b7381cabdacf462057c49cd1fb2da",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 369129,
            "upload_time": "2024-05-30T18:32:13",
            "upload_time_iso_8601": "2024-05-30T18:32:13.070712Z",
            "url": "https://files.pythonhosted.org/packages/62/2f/dbb80a2543bd72712694d608e23d76b9fe52ae01619190c878f5bd5583ee/plone_app_registry-2.0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-30 18:32:13",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "plone.app.registry"
}
        
Elapsed time: 0.32413s