Zope 2 and PLlone integration for plone.registry
Project description
Introduction
This package provides Plone UI integration for plone.registry. Specifically, it:
creates a version of the Registry class that will show up in the ZMI
installs this to the site root and registers it as a local utility providing IRegistry.
registers a GenericSetup handler for registry.xml to create new records or change values
provides a GUI to modify the settings registry through the web
GenericSetup format
The registry.xml GenericSetup format looks like this:
<registry>
<records interface="plone.registry.tests.ITestSchema1" />
<records interface="plone.registry.tests.ITestSchema2">
<omit>field1</omit>
</records>
<record name="plone.app.registry.tests.dummy1">
<field type="plone.registry.field.TextLine">
<title>Dummy one</title>
</field>
<value>New value</value>
</record>
<record interface="plone.registry.tests.ITestSchema3" field="test1">
<value>Some value</value>
</record>
<record name="plone.app.registry.tests.dummy3">
<value>Another value</value>
</record>
<record name="plone.app.registry.tests.listelement">
<value>
<element>One</element>
<element>Two</element>
</value>
</record>
<record name="plone.app.registry.tests.dictelement">
<value purge="false">
<element key="1">One</element>
<element key="2">Two</element>
</value>
</record>
<record name="plone.app.registry.tests.dummy4" delete="true" />
</registry>
In brief:
The root element is <registry />, containing zero or more <record /> elements and zero or more <records /> elements.
A <record /> element will usually have a name attribute.
A <record /> element may instead have an interface and a field attribute. If so, the name is ${interface}.${field}.
A <record /> element may have a <field /> child element that specifies the field of the record.
A <field /> element must have a type attribute giving the dotted name to the field class. It contains child elements based on the allowed options for that field. This is based on plone.supermodel.
A <record /> element may contain a <value /> element. This should contain a string representation of the value of the field, and will be validated.
For list, tuple, set, or frozenset fields, the <value /> element should contain a list of <element /> elements, one per element in the sequence.
For dict fields, the <value /> element should contain a list of <element /> elements with a key attribute. The value of the key attribute will be the dictionary key. The contents of the element will be the value.
For sequence and dict fields, the <value /> element may contain an attribute purge=”false”. If this is given, the existing record’s value will be extended/updated rather than replaced.
A <record /> element may have a delete attribute. If this is set to ‘true’, the record will be deleted.
If a <records /> element is provided, it must have an interface attribute containing the full dotted name to a schema interface. Records will be created for each field in this interface.
A <records /> element may contain zero or more <omit /> elements. These should list the names of fields that will be omitted.
Changelog
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
