plone.app.discussion

Go to file

Timo Stollenwerk 7bdf340c88 Fix restructured text. svn path=/plone.app.discussion/trunk/; revision=40511		2010-10-04 19:19:34 +00:00
dev	plone.formwidget.recaptcha added to dev buildout.	2010-02-07 07:51:43 +00:00
docs	Workflow documentation added (first rough draft).	2010-09-24 13:35:21 +00:00
plone	German translations updated.	2010-10-04 18:59:42 +00:00
pydev-plone4	update pydev plone4 buildout to 4.0a4.	2010-02-15 11:27:11 +00:00
.gitignore	added .mo files to git ignore	2010-08-19 14:38:22 +00:00
CHANGES.txt	Fix restructured text.	2010-10-04 19:19:34 +00:00
README.txt	collective.z3cform.norobots added to add-on section.	2010-09-16 10:03:33 +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
dev-plone3.cfg	collective.akismet added to dev plone3 buildout.	2010-06-21 09:13:19 +00:00
dev-plone4.cfg	Remove unused parts.	2010-09-24 19:37:01 +00:00
setup.cfg	Sphinx-based developer documentation added.	2010-03-24 07:56:53 +00:00
setup.py	Back to development: 1.0b9	2010-10-04 19:11:16 +00:00
test-plone-3.3.x.cfg	Use 1.0b6 KGS from good-py.	2010-09-06 10:05:18 +00:00
test-plone-4.0.x.cfg	Fetch the testing dependencies.	2010-09-28 16:36:50 +00:00
versions.plone3.cfg	plone3 dump-picked-versions file added.	2010-04-04 17:30:14 +00:00
versions.plone4.cfg	Preparing release 1.0b7	2010-09-15 11:38:20 +00:00

README.txt

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).

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

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

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

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


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.0b7

    ...

    [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]
    zope.schema = 3.6.0
    
    ...
    
    [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)