Go to file
Timo Stollenwerk 5f557323b1 buildout for Plone 4.1 added.
svn path=/plone.app.discussion/trunk/; revision=47878
2011-03-02 19:50:26 +00:00
dev plone.formwidget.recaptcha added to dev buildout. 2010-02-07 07:51:43 +00:00
docs Prepare 2.0a1 release. 2011-02-07 15:00:46 +00:00
plone minor code cleanup 2011-02-15 16:23:12 +00:00
pydev-plone4 revert, wrong commit 2010-11-07 22:01:47 +00:00
.gitignore added .mo files to git ignore 2010-08-19 14:38:22 +00:00
bootstrap.py Added a buildout to the package itself, for both Plone 3.x and 4.x. 2010-02-06 14:25:07 +00:00
buildout.cfg use plone 4 as default buildout. 2010-05-20 07:41:42 +00:00
CHANGES.txt Fixed test failure for the default user portrait, which changed from 2011-02-15 16:19:13 +00:00
dev-plone3.cfg collective.akismet added to dev plone3 buildout. 2010-06-21 09:13:19 +00:00
dev-plone4.cfg Pin Sphinx to 0.6.6 2010-12-09 10:57:02 +00:00
dexterity.cfg Use the 1.0-next KGS of dexterity instead of the outdated 2.0-next. 2010-11-23 19:25:03 +00:00
hudson.cfg hudson buildout added. 2010-11-28 10:20:51 +00:00
README.txt Fix typo. 2011-02-07 15:15:56 +00:00
setup.cfg Sphinx-based developer documentation added. 2010-03-24 07:56:53 +00:00
setup.py Prepare 2.0a2 release. 2011-02-08 09:30:18 +00:00
test-plone-3.3.x.cfg zope.i18n pinned down in Plone 3 KGS. 2010-11-03 13:54:57 +00:00
test-plone-4.0.x.cfg Remove jscoverage from buildout. 2010-10-30 11:23:45 +00:00
test-plone-4.1.x.cfg buildout for Plone 4.1 added. 2011-03-02 19:50:26 +00:00
TODO-Plone4.x.txt todo update. 2011-01-20 20:58:40 +00:00
versions.plone3.cfg plone3 dump-picked-versions file added. 2010-04-04 17:30:14 +00:00
versions.plone4.cfg Versions updated. 2010-12-09 08:19:03 +00:00

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

plone.app.discussion aims to be the new commenting system for Plone. It was 
initially developed as part of the Google Summer of Code 2009 by Timo 
Stollenwerk (student) and Martin Aspeli (mentor).

plone.app.discussion is an add-on product for Plone 3.3.x and 4.0.x and will be
shipped as part of Plone 4.1. Make sure you pin down plone.app.discussion to
versions < 2.0 if installed 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.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.x 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>`_.


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)