plone.app.discussion

Go to file

Katja Suess 3d3c638565 Notification moderator: email of commentator added. Link as is but request to log in for moderating comment added. New moderator notification with email and link to commented page and request to login. No links to approve and delete: due to CSRF direct links to modification of Plone objects result in request to confirm. So page with comments is presented to moderator. If already logged in, moderator is on comment to moderate. If not logged in, moderator is on login page with came_from.		2019-12-01 19:47:08 +01:00
docs	add plone.resource dependency and change to plone:static	2019-06-27 19:43:27 +02:00
news	changelog	2019-11-29 16:23:43 +01:00
plone	Notification moderator: email of commentator added. Link as is but request to log in for moderating comment added.	2019-12-01 19:47:08 +01:00
.gitattributes	Allowed union merge strategy in CHANGES.rst.	2015-10-25 00:00:19 +02:00
.gitignore	Updated .gitignore file	2015-05-31 13:40:31 -04:30
CHANGES.rst	Fixed indentation in changelog.	2019-11-25 15:44:06 +01:00
CONTRIBUTING.rst	Added CONTRIBUTING.rst.	2015-11-14 00:25:54 +01:00
MANIFEST.in	Initialize towncrier	2019-02-08 13:36:13 +01:00
README.rst	Revert "Jenkins test 3."	2015-02-27 15:15:03 +01:00
pyproject.toml	Initialize towncrier	2019-02-08 13:36:13 +01:00
setup.cfg	Create universal wheel when releasing with zest.releaser.	2017-05-31 19:10:17 +02:00
setup.py	Back to development: 3.3.2	2019-11-25 15:41:02 +01:00

README.rst

Introduction
============


plone.app.discussion replaces the old commenting system in Plone 4.1 and is also
available as an add-on product for Plone 3 and 4. It was initially developed as
part of the Google Summer of Code 2009 by Timo Stollenwerk (student) and Martin
Aspeli (mentor).

.. note::

  Make sure you pin down plone.app.discussion to versions < 2.0 if you want to
  install it as an add-on product (see install instructions below for more
  details).

Please report bugs to the `Plone bug tracker`_.

.. _`Plone bug tracker`: http://dev.plone.org/plone/


For the roadmap of the project see our `Pivotal Tracker`_.

.. _`Pivotal Tracker`: http://www.pivotaltracker.com/projects/15135


Requirements
============

Plone 3.3 or later.


Plone 3.3.x Buildout Installation
=================================

To install plone.app.discussion, add the following code to your buildout.cfg::

    [buildout]
    ...
    extends =
        ...
        http://good-py.appspot.com/release/plone.app.discussion/1.0

    ...

    [versions]
    plone.app.discussion = 1.0

    ...

    [instance]
    ...
    eggs =
        ...
        plone.app.discussion

    ...


Plone 4.0 Buildout Installation
===============================

To install plone.app.discussion, add the following code to your buildout.cfg::

    [buildout]

    ...

    versions = versions

    [versions]
    plone.app.discussion = 1.0
    zope.schema = 3.6.4

    ...

    [instance]
    ...
    eggs =
        ...
        plone.app.discussion

    ...


Add-on Products
===============

- `collective.autoresizetextarea
  <http://pypi.python.org/pypi/collective.autoresizetextarea/>`_
  (for auto-resizing the comment textarea while typing)

- `plone.formwidget.captcha
  <http://pypi.python.org/pypi/plone.formwidget.captcha/>`_
  (for Captcha spam protection)

- `plone.formwidget.recaptcha
  <http://pypi.python.org/pypi/plone.formwidget.recaptcha/>`_
  (for ReCaptcha spam protection)

- `collective.akismet
  <http://pypi.python.org/pypi/collective.akismet/>`_
  (for Akismet spam protection)

- `collective.z3cform.norobots
  <http://pypi.python.org/pypi/collective.z3cform.norobots/1.1/>`_
  (provides a "human" captcha widget based on a list of questions/answers)


Documentation
=============

- For developer documentation see
  `http://packages.python.org/plone.app.discussion
  <http://packages.python.org/plone.app.discussion>`_.

- For integrator/end-user documentation see
  `http://plone.org/products/plone.app.discussion/documentation
  <http://plone.org/products/plone.app.discussion/documentation>`_.


Known Issues
============

- **ImportError: No module named owner**: You are trying to install
  plone.app.discussion 2.x on Plone < 4.1. Pin plone.app.discussion to a version
  < 2.0.

- **KeyError: 'Interface `plone.app.discussion.interfaces.IDiscussionSettings`
  defines a field `moderator_email`, for which there is no record.'**: An
  upgrade step was unsuccessful. Reinstall plone.app.discussion to fix this.


Credits
=======

- Timo Stollenwerk
- Martin Aspeli

Many thanks to:

- Jon Stahl (for acting as "the customer" during GSoC)
- David Glick (for technical expertise and advice during GSoC)
- Lennart Regebro (for writing the portal_discussion tool and initial unit tests)
- Carsten Senger (for fixing the comment z3c.form form and pizza)
- Hanno Schlichting (for making p.a.d work with Zope 2.12)
- Alan Hoey (for providing fixes)
- Maik Roeder (for providing and setting up a buildbot)