elektrika.openx 1.3

OpenX invoication code, portlet, viewlets

Introduction

Package integrates open source OpenX ad server with Plone. It is possible to show banner from any OpenX “zone” in portlet, define custom viewlet and show banners in viewlet or invoke banner from any template using public openx_view Browser view.

Package supports Javascript invocation only.

Configuration

You must manually add new property openx_server to the Plone site root and set domain name of your OpenX server without scheme. ‘ad.domain.com’ is correct value, but ‘http://ad.domain.com’ is wrong!

Usage

Portlet

Use Manage portlets interface and add “OpenX portlet”. You must specify OpenX zone number and you may set additional properties.

Viewlet

You must define your own viewlet in your own product. There is no default viewlet available for end-users. Example viewlet registration code:

<browser:viewlet
    name="YOUR VIEWLET NAME EG. banner-top-468"
    for="*"
    manager="plone.app.layout.viewlets.interfaces.IPortalTop" - CHANGE MANAGER IPortalTop or IPortalHeader etc.
    class="elektrika.openx.browser.viewlets.OpenXBannerViewlet"
    template="banner.pt"  - change template, copy contents of banner.pt there and don't forget to set "ZONE" parameter inside template
    layer=".interfaces.IThemeSpecific"  - specify your Layer or remove this line
    permission="zope.Public"
    />

Common template

If you want to invoke OpenX banner from any other template, eg. customized main_template or customized footer etc., you may use openx_view Browser view:

<div tal:define="openx context/openx_view"
     tal:replace="structure python:openx.code(38)" />

‘code’ method supports parameters:

openx_view.code(zone, withText=False, target='_blank')

Changelog

1.3 - 2010-01-03

• make it work with older zope/plone instances

1.2 - 2009-09-02

• Do not use default server. There is no default server now.

• First public release

1.1.1 - 2009-07-13

• just re-release

1.1 - 2009-07-13

• just release

1.0.3 - 2009-03-09

• Renamed SMFBannerViewlet class to OpenXBannerViewlet (it was typo)

1.0.2 - 2009-03-07

• Added Plone site property openx_server which allows to set URI of the server. It accepts domain only!!! so “ad.elektrika.info’ or ‘ad.dms4u.cz’ is correct value. Do not use http:// prefix.

1.0 - Unreleased

• Initial release