Skip to main content

A portlet that provides the links of an action category

Project description

collective.portlet.actions

By Alter Way Solutions.

Show in a portlet of a Plone site the links and (maybe translated) titles of the actions of a selected category.

Compared with the static text portlet, action URLs are computed and links may be protected by a TALES condition and permissions, such the same portlet may provide different links to various users or in various contexts.

Requirements

collective.portlet.actions requires Plone 3.x. It has been tested with Plone 3.0, Plone 3.1 and Plone 3.2 and may or may not work with future Plone versions.

Install

Usual install

collective.portlet.actions is a Python egg with a ZCML slug, such you just need to add these lines in your zc.buildout config file:

[instance]
recipe = plone.recipe.zope2instance
...
eggs =
  ...
  collective.portlet.actions
  ...
zcml =
  ...
  collective.portlet.actions

As of Plone 3.2, you don’t need to add collective.portlet.actions to the zcml option.

Then re-run your buildout config.

See docs/INSTALL.txt for other installation methods.

Development

Please read the comments on top of buildout.cfg that comes with the subversion checkout.

Add a portlet

Of course, if an existing actions category doesn’t fit what you need, you may add your own actions category in the portal_actions tool and add actions in it. Action titles may be translated if you provide an i18n domain.

You may add an icon directly in the action definition, as a TAL expression that provides the icon object. e.g. portal/book_icon.gif.

You may associate an icon to each action using the portal_actionicons tool too if you prefer the old way.

When done, add an ‘Actions portlet’ anywhere you want. Give a title and select the appropriate actions category.

If you choose to show action icons, you may change the default icon for actions that have no icon from their own or through the portal_actionicons tool. The value for the default icon is evaluated from the context when publishing the portlet.

You’re done.

License

This component is protected by the terms of the GPL v2 license. Please read the docs/LICENSE.\* files.

Further documentation

Please read the docs directory, as well as other specific README.txt in other places of this component.

Home page

You may find further informations, a tracker and support resources from the home page at plone.org.

Subversion repository

https://svn.plone.org/svn/collective/collective.portlet.actions

Credits

Development

Translations

See collective/portlet/actions/locales/README.txt if you need to translate this component into another language.

Changelog

Please use following format for further changes (latest first):

1.1.0

  • Fixing tests and adding new tests for portal_tabs [glenfant]

  • Optims for portal_tabs rendering (same invariant stuffs were computed twice) [glenfant]

  • Special case for “portal_tabs” actions category that may rely on items available in the Plone content root. [kroman0]

1.0.1

  • 2009/05/20: fixed caching of actionLinks renderer’s method, caching is still applied but this is possible now to have more than one actions portlet with a different settings on the same page, appropriate test added [piv]

1.0.0

Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective.portlet.actions-1.1.0.tar.gz (21.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page