Poi

Installation and dependencies

Best is to use zc.buildout. Just add Products.Poi to your eggs, rerun buildout and you are done. Optionally add Products.PloneSoftwareCenter (and Products.ArchAddOn).

Poi requires:

• Plone 3 on Zope 2.10.x (tested with Plone 3.0.6, 3.1.7 and 3.2.1)
• DataGridField
• AddRemoveWidget
• intelligenttext (but this is installed by default in Plone 3) Note: when going from Plone 2.5 to 3.0, please first uninstall intelligenttext, then create a new zope instance with Plone 3. Then run the portal_migration, which will install the new plone.intelligenttext library for you.
• For PloneSoftwareCenter integration, PloneSoftwareCenter is required. See http://plone.org/products/plonesoftwarecenter Tested with PloneSoftwareCenter 1.5.

For new installations, install using Add/Remove Products as normal. If you want PloneSoftwareCenter configuration to be automatically configured, install PSC first.

Upgrading

Re-install Poi from the Add/Remove Products control panel or the portal_quickinstaller in the ZMI.

Poi 1.2 gets rid of old Archetypes based PoiResponses and introduces new light weight zope-3-style responses; this needs a migration. In the ZMI go to portal_setup, then the Upgrades tab and run any upgrade steps that are available for Poi. Backup your Data.fs first!

NOTE: the upgrade steps can take a long time. Try to run the upgrade when traffic on your site is low or take the site off-line for best results. When someone is editing content during the upgrade step, a ConflictError can occur, which means the upgrade will start all over. On sites with a lot of Poi content (like plone.org) that can mean that the upgrade stops after a while without being complete. After the upgrade check if there are still old-style PoiResponses in your site by going to <yoursiteurl>/search?portal_type=PoiResponse. If this still gives back results, simply run the upgrade again (running it multiple times is safe). You may need to click the 'Show' button to show old upgrades as portal_setup may think the upgrade has been completed.

After any upgrade, you may need to run an Archetypes schema update. Go to 'archetype_tool' in the ZMI, select the 'Update Schema' tab, and see if any of the 'Poi.*' types (or any other type actually) are selected. If some are selected, click 'Update schema'. It is probably a good idea to choose 'All objects' from the drop-down as well, although this will take slightly longer. When coming from Plone 2.5, be sure to select 'Remove schema attributes from instances.'

Usage

Add a Tracker, and use the "state" menu to open it for submissions.

The tracker front pages allows you to browse for issues by release, state or area, as well as search for issues. Note that if you are not tracking software releases, you can leave the list of "releases" empty, and organisation by release will be turned off. The fields for areas and issue types come pre-configured with simple values that presume you are tracking software bugs. You can change these to whatever you want.

Once you have set up the tracker, add Issues inside, and Responses inside Issues. Anyone can add responses to issues with the default workflow. Responses from tracker managers (as configured on the root tracker object) and the original submitter are colour coded to make them easier to pick out. When adding a response as a tracker manager, you can change the state, importance or assignment of an issue.

If email notification is enabled in the root tracker object, managers will get an email when there are new issues and responses, optionally via a mailing list. Issue submitters will also get emails upon issue responses. Additionally, when an issue is marked as "resolved" by a tracker manager, the submitter will receive an email asking him or her to mark the issue as confirmed closed.

To use with the PloneSoftwareCenter, install PSC and then install Poi. This will ensure PoiPscTracker is added to the list of allowed content types in portal_types/PSCProject. You can then add Trackers inside a project in the software center. The trackers will function in the same way as regular trackers, but will use releases from the software center project instead of a manually defined list.

For a look at how the various workflow states of an issue are connected, take a look at the attachment added by bethor to this issue: http://plone.org/products/poi/issues/179

Using HTML/kupu and other markups for issue text:

Please see notes about migration above!

Before version 1.0b2 Poi used to support kupu/rich text fields with HTML in the issue and response body. This was removed in favour of "intelligenttext", a plain-text markup that preserves whitespace and makes links clickable.

This was found to work very well on plone.org and for the type of simple trackers that Poi was intended for. However, a lot of users wanted kupu back.

To get kupu back, you will need to edit Poi/config.py:

ISSUE_MIME_TYPES = ('text/x-web-intelligent', 'text/html')
DEFAULT_ISSUE_MIME_TYPE = 'text/html'

You may also need to re-install Poi, and perform an Archetypes schema update, by going to archetypes_tool, and the Schema Update tab in the ZMI.

Please note one very important thing:

• If you upgrade Poi, you're likely to have to make this change again!

Credits

If you have contributed to Poi in some fashion, be sure to add yourself in the hall of fame here!

o Design and development by Martin Aspeli <optilude@gmx.net>

o Bug fixes and general critiquing by Rocky Burt <rocky@serverzen.com>

o Icons by Vidar Andersen, Black Tar, originally created for CMFCollector.

o Log-view for Poi trackers by Malthe Borch

o Link detection, additions to the search interface and other fixes

by Daniel Nouri.

o Plone 3 support by Alexander Limi and Maurits van Rees.

o Bug fixes, modernizing of responses, maintenance by Maurits van

Rees