collective.jsconfiguration 0.1.1

Introduction

This product is targeted to developer who need to distribute JavaScript configuration data or i18n strings with their Plone products.

Data injected in the page could be taken from whatever server side configuration setting you want but most of the time you want to read application configuration from the Plone registry and translations from page templates.

How it works

A new viewlet will be registered in the HTML head of the site. This viewlet is normally empty and will do nothing until a 3rd party product will register new IJSDataProvider adapters.

There are three subtypes of adapters, choosing one of them depends on what you want to reach in your add-on.

Registering named adapters is recommended, in that way override the registration with a more specific ones will be possible. In the case of IJSObjectDataProvider the name is required because it’s used as name of the defined variable (see below).

<script type="text/collective.jsconfiguration.json"
        id="your_adapter_name_if_any">
    {"foo": ... }
</script>

var configuration = $.parseJSON($('#your_adapter_name_if_any').text());

<script type="text/collective.jsconfiguration.xml"
        id="your_adapter_name_if_any">
    <foo data-i18n-label1="Benvenuto"
         data-i18n-label2="Questo è un esempio di traduzione">
         ...
    </foo>
</script>

var label1 = $($('#your_adapter_name_if_any').text()).attr('data-i18n-label1');
var label2 = $($('#your_adapter_name_if_any').text()).attr('data-i18n-label2');

<script type="text/javascript">
if (typeof foo==='undefined') {
    foo = {};
}

foo.bar = {"baz": "Hello World"};
</script>

alert(foo.bar.baz); // whil be "Hello World"

Registering a new configuration

Whatever is your choice, you simply need to register an adapter that adapts the current context, the request and the current view.

An example:

<adapter
    factory="your.package.adapter.YourXMLAdapter"
    provides="collective.jsconfiguration.interfaces.IDOMDataProvider"
    for="* * *"
    name="your_zml_configuration"
    />

In the example above the configuration will be added to every page of the site.

<adapter
    factory="your.package.adapter.AnotherXMLAdapter"
    provides="collective.jsconfiguration.interfaces.IDOMDataProvider"
    for="Products.CMFPlone.interfaces.siteroot.IPloneSiteRoot
         your.package.browser.interfaces.IYourProductLayer
         your.package.browser.interfaces.IYourSpecialView"
    name="your_zml_configuration"
    />

In the last example another configuration will only added to the site root, only when a 3rd party browser layers is registered (commonly: your add-on product is installed) and only when a specific view is called.

As far as the adapter registration is using the same name of the first example, the last registration will override the first when applicable.

Finally, there’s the adapter class:

class YourXMLAdapter(object):
    implements(IDOMDataProvider)

    def __init__(self, context, request, view):
        self.context = context
        self.request = request
        self.view = view

    def __call__(self):
        ...

When using IJSONDataProvider or IJSObjectDataProvider and you want to directly read data from the Plone registry, you can rely on collective.regjsonify package, that can quickly help you in this task:

from collective.regjsonify.interfaces import IJSONifier
from collective.jsconfiguration.interfaces import IJSONDataProvider
from plone.registry.interfaces import IRegistry
from zope.interface import implements

class YourXMLAdapter(object):
    implements(IJSONDataProvider)

    def __init__(self, context, request, view):
        self.context = context
        self.request = request
        self.view = view

    def __call__(self):
        registry = queryUtility(IRegistry)
        settings = registry.forInterface(IMyRegistrySettings)
        return IJSONifier(settings).json()

Example application

You can find all those features in action in the collective.externalizelink Plone add-on.

Changelog