quintagroup.plonecomments 4.0.1

Plone Comments

Introduction

Copyright (c) “Quintagroup”: http://quintagroup.com, 2004-2009

Plone Comments (quintagroup.plonecomments) is a Plone product developed to improve the site managers and editors expirience with standard commenting mechanism in Plone.

Contents

• Introduction

  • Features

  • Notes

  • Usage

  • Links

  • Requirements

  • License

  • Author

• Installation/Uninstallation

  • Installation

  • Uninstallation

• Changelog

  • 4.0.1 (2009-06-05)

  • 4.0.0 (2009-04-06)

  • 3.2.1 (unreleased)

  • 3.1.2 (unreleased)

  • 3.1.1 (2008-09-19)

  • 3.1.0 (2008-08-28)

Features

• Notify admin about comment posted

• Notify commentator about his comment aproval

• Notify author of parent comment about new follow up added

• Moderation of comments, approval of comments

• Anonymous commenting

• Added Name field to comment form, it is required for anonymous comments

• Article author can be notified about new comment after the approval by reviewer

• List of recent comments for more comfortable moderation

• Configlet that allow:

  o Turning on/off Moderation

  o Turning on/off Manager notification

  o Turning on/off Editor notification

  o Turning on/off Anonymous Commenting

  o Configure admin e-mail for notifications

  o Configure notification subject

• qPloneCaptcha integrated (needs the qPloneCaptcha to be installed)

Notes

Comments moderation is implemented with involvement of two stage workflow. Comments are created in “private” state and visible only to DiscussionManager group of users.

To differentiate between logged-in (registered) commentors and Anonymous commentors that pretend to be one person or other one, we use Boldness of name. The Comment author is in bold when posted by logged in member. The names provided when posting Anonymously are in plain text.

Notification subject control allows to enter custom prefix to disctinct notifications comming from different sites.

Usage

One of possible UseCases:

Moderation is enabled and authors notification is turned on.

• New comment posted in private state.

• Notification is sent to the emails entered in Plone Comments configlet.

• Moderator User with DiscussionManager role see the comment.

• The comment can be deleted or published on modaration stage.

• When comment is published notification is sent to Article Editor.

Links

• Download releases from Sourceforge.net “Plone Comments project area”:http://sf.net/projects/quintagroup

• Get latest development version from “SVN”:http://svn.quintagroup.com/products/quintagroup.plonecomments/trunk

Requirements

• Plone 3.x

• plone.browserlayer is required for Plone 3.0.x

License

Please find license in LICENSE.GPL.

Author

The product is developed and maintained by http://quintagroup.com team.

Authors:

• Volodymyr Cherepanyak

• Andriy Mylenkyy

• Mykola Kharechko

• Vitaliy Stepanov

Contributors:

• Gerry Kirk: product translations improvement and proofreading

• Dorneles Tremea: code cleanup and generic setup porting

Installation/Uninstallation

Installation

To install quintagroup.plonecomments into the global Python environment (or a workingenv), using a traditional Zope 2 instance, you can do this:

• When you’re reading this you have probably already run easy_install quintagroup.plonecomments. Find out how to install setuptools (and EasyInstall) here: http://peak.telecommunity.com/DevCenter/EasyInstall

• If you are using Zope 2.9 (not 2.10), get pythonproducts and install it via:

  python setup.py install --home /path/to/instance

into your Zope instance.

• Create a file called quintagroup.plonecomments-configure.zcml in the /path/to/instance/etc/package-includes directory. The file should only contain this:

  <include package="quintagroup.plonecomments" file="configure.zcml" />

• Create a file called quintagroup.plonecomments-overrides.zcml in the /path/to/instance/etc/package-includes directory. The file should only contain this:

  <include package="quintagroup.plonecomments" file="overrides.zcml" />

Alternatively, if you are using zc.buildout and the plone.recipe.zope2instance recipe to manage your project, you can do this:

• Add quintagroup.plonecomments to the list of eggs to install, e.g.:

  [buildout]
  ...
  eggs =
      ...
      quintagroup.plonecomments

• Tell the plone.recipe.zope2instance recipe to install a ZCML slug:

  [instance]
  recipe = plone.recipe.zope2instance
  ...
  zcml =
      quintagroup.plonecomments
      quintagroup.plonecomments-overrides

• Re-run buildout, e.g. with:

  $ ./bin/buildout

• Install quintagroup.plonecomments via ZMI portal_setup. Select quintagroup.plonecomments from the list of available profiles and press Import all steps.

  Atention: If you are using a Plone version before 3.1 you need to install “plone.browserlayer”:http://pypi.python.org/pypi/plone.browserlayer (which also requires a “GenericSetup”:http://pypi.python.org/pypi/Products.GenericSetup version greater than 1.4) in your Plone site. It shows up as Local browser layer support in the Plone Add-on Products Control Panel.

Uninstallation

• To uninstall quintagroup.plonecomments - select quintagroup.plonecomments uninstall profile from the list of available profiles and press Import all steps.

Changelog

4.0.1 (2009-06-05)

• Fixed links in the email messages. [liebster]

4.0.0 (2009-04-06)

• Plone 3.* compatibility release [liebster]

3.2.1 (unreleased)

• Added uninstall configlet and skins

• Converted a i18n layout to a locales layout

3.1.2 (unreleased)

• Fixed to use the username as the comment creator. That’s necessary whenever the user is authenticated. This fixes the problems where commenters weren’t receiving any notifications. [deo]

3.1.1 (2008-09-19)

• Fixed bug in registration of product also as a package. [liebster]

3.1.0 (2008-08-28)

• Added pt-br translation. [erico_andrei]

• Converted Extension/Install.py` into a complete GenericSetup profile. [deo]

• Added note about the browser.layer dependency for Plone 3.0.x. [deo]

• Updated tests to run with Plone 3.x. [deo]

• General code cleanup and modernization. [deo]

• Synchronized the discussion templates to match Plone 3.x versions. [deo]