collective.relateditems 0.1.0

Guide for 3rd party products

If you want to fix a 3rd party product that is already using the Plone 4 related items style, so you don’t see related anymore when using it on Plone 3, you simply need fix your buildout:

• add collective.relateditems to you eggs

• add to a .zcml this piece of code (explicitly in one of yours packages, or using zcml-additional):

  <include package="collective.relateditems" />
  <class class="your.product.content.YourContentClass">
      <implements interface="collective.relateditems.interfaces.IRelatedItemsEnabledContent"/>
  </class>

Note that you don’t need to change anything inside the 3rd party code.

Guide for products you own

If you are a product developer and you want to make your product fully compatible with Plone 4 but also Plone 3, your can also choose to hide to your users all configuration difficulties. You need to change something in your code.

First of all, you need to make your product based on collective.relateditems only when you are in a Plone 3 environment. The common way is to check the Python version in your setup.py:

>>> import os, sys
...
>>> install_requires = ['setuptools',
...                     'Products.CMFPlone',
...                     # other dependencies
...                     ]
...
>>> if sys.version_info < (2, 6):
...     install_requires.append('collective.relateditems')

Then the product definition:

>>> setup(name='your.product',
...     # more
...     install_requires=install_requires,
...     #more
... )

After that you need to proper define your configure.zcml:

<configure zcml:condition="installed collective.relateditems">
    <include package="collective.relateditems" />
        <class class="your.product.content.YourContentClass">
        <implements interface="collective.relateditems.interfaces.IRelatedItemsEnabledContent"/>
    </class>
</configure>

You can also make your YourContentClass Python class implementing the IRelatedItemsEnabledContent but you still need to remember that Plone 4 environment will not have this interface available.

That’s all.