View and viewlet helper modules for Plone theme and five.grok developers
collective.fastview provides framework level helper code for Plone view and template management. It is intended to be used to give some workarounds some rough corners on these Zope 3 and five.grok viewlewt frameworks.
Add collective.fastview to buildout.cfg eggs list:
eggs = ... collective.fastview
You can directly put in viewlet call to any page template code using a viewlet traverser. collective.fastview registers a view with name @@viewlets which you can use to traverse to render any viewlet code:
<div id="header"> <div tal:replace="structure context/@@viewlets/plone.logo" /> </div>
Note that you still need to register viewlets against some (any) viewlet manager, but it can be a dummy one, which is never rendered using syntax:
<div tal:replace="structure provider:myarghyetanotherviewletmanagername" />
Example of dummy viewlet manager:
class MainViewletManager(grok.ViewletManager): """ This viewlet manager is responsible for all gomobiletheme.basic viewlet registrations. Viewlets are directly referred in main_template.pt by viewlet name, thus overriding Plone behavior to go through ViewletManager render step. """ grok.name('gomobiletheme.basic.viewletmanager') # Set viewlet manager default to all following viewlets grok.viewletmanager(MainViewletManager)
This fixes grok 1.0 problem that view and viewlets template are not inheritable between packages. E.g. if you subclass a view you need to manually copy over the view template also.
We hope to get rid of this in the future.
from collective.fastview.utilities import fix_grok_template_inheritance from gomobiletheme.basic import viewlets as base from gomobiletheme.basic.viewlets import MainViewletManager from plonecommunity.app.interfaces import IThemeLayer # Viewlets are on all content by default. grok.context(Interface) # Use templates directory to search for templates. grok.templatedir("templates") # Viewlets are active only when gomobiletheme.basic theme layer is activated grok.layer(IThemeLayer) grok.viewletmanager(MainViewletManager) class Head(base.Head): """ My inherited viewlet. """ # Fix for grok 1.0 template inheritance # https://bugs.launchpad.net/grok/+bug/255005 # This will force Head viewlet to use its parent class template fix_grok_template_inheritance(Head, base.Head)
This code is mainly used with gomobiletheme.basic package to provide simple mobile themes without need to construct viewlet manager around every viewlet.
These Python packages use this code
- Fixed debug statement left in the code [miohtama]
- Try to be smarter handling the cases where viewlet raises an exception on update() or render() [miohtama]
- Cleaned up some docs [miohtama]
- Plone 4 compatibility
- Removed global defines special handlers - they were used for Plone 3, but Plone 4 is now out solving the problem itself
- Added special exception type for the cases viewlet is not found by name. It was bad idea to return NotFound as Zope has special meaning for this exception (you get 404).
- Initial release