plone.app.toolbar 1.0

Installation

To install toolbar drop following lines to your buildout.cfg:

[instance]
eggs =
    ...
    plone.app.toolbar

[versions]
plone.app.jquery = 1.7.2
plone.app.jquerytools = 1.4
plone.tiles = 1.0b2
Products.ResourceRegistries = 2.1.1
plone.app.toolbar = 1.0

In case this document gets outdated use latest versions of eggs in versions section.

Make sure you install the “Plone Toolbar” profile when creating your Plone site or include plone.app.toolbar:default profile in your metadata.xml..

To start developing plone.app.toolbar you can find buildout at buildout.deco repository.:

https://github.com/plone/buildout.deco/blob/master/toolbar-2.0.cfg

How it works

Registers toolbar tile which creates toolbar html on every page in twitter bootstrap structure and is hidden by default. Toolbar tile also lists resources from toolbar skin in data-iframe-resources attribute of top element.

<div style="display: none;"
     data-iframe="example"
     data-iframe-resources="resource1.js;resource2.css;...">
  <div class="navbar">
    ...
  </div>
</div>

Elements with data-iframe attribute are picked by iframed.js and inserts resources found in data-iframe-resources attribute. iframed.js script also takes care that dropdown in toolbar which goes outside iframe area stretches it in transparent way so that user doesn’t even notice it.

Same transparent stretching of iframe is used when overlay is opened. This is done by plone.overlay.js script. Example of how to open overlay when user click on Edit action in toolbar would be:

$('#plone-toolbar ul.nav > li#plone-action-edit > a').ploneOverlay({
  after_load: function(overlay) {
    $.plone.cmsui.bootstrapOverlayTransform(overlay.el, overlay.loaded_data);
  }
});

More examples of this can be found in plone.cmsui.js script.

Since in current Plone we’re not using plone.app.blocks to render tiles we provide plone toolbar viewlet which renders toolbar tile. This is done by bbb code that also makes sure that plone.app.toolbar is nicely integrated into current Plone, eg: hidding old green edit bar, …

Diazo rules

First we need to copy toolbar’s html code, which will be picked by iframed.js:

<append theme="/html/body"
    content="//div[@data-iframe='toolbar']" />

Then in case we are not copying all resources from Plone to theme we have to include iframed.js:

<append theme="/html/head">
    <script type="text/javascript"
        src="++resource++plone.app.toolbar/src/iframed.js"></script>
</append>

Above 2 rules should be enought so that your theme will support plone.app.toolbar

More on plone.overlay.js

TODO: once jquery.form.js is integrated into $.plone.Overlay write documentation for it.

More on plone.cmsui.js

TODO: once it gets fairly working some documentation would be nice.