Update wildly outdated information in the readme.

[ci skip]
This commit is contained in:
Maurits van Rees 2022-09-30 16:10:34 +02:00
parent f9536d5f3d
commit 4b96e0f480
No known key found for this signature in database
GPG Key ID: AAEC1E5318E6FCCE

View File

@ -2,132 +2,42 @@ 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).
plone.app.discussion is the commenting system used since Plone 4.1.
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/>`_
<https://pypi.org/project/collective.autoresizetextarea/>`_
(for auto-resizing the comment textarea while typing)
- `plone.formwidget.captcha
<http://pypi.python.org/pypi/plone.formwidget.captcha/>`_
<https://pypi.org/project/plone.formwidget.captcha/>`_
(for Captcha spam protection)
- `plone.formwidget.recaptcha
<http://pypi.python.org/pypi/plone.formwidget.recaptcha/>`_
<https://pypi.org/project/plone.formwidget.recaptcha/>`_
(for ReCaptcha spam protection)
- `collective.akismet
<http://pypi.python.org/pypi/collective.akismet/>`_
<https://pypi.org/project/collective.akismet/>`_
(for Akismet spam protection)
- `collective.z3cform.norobots
<http://pypi.python.org/pypi/collective.z3cform.norobots/1.1/>`_
<https://pypi.org/project/collective.z3cform.norobots/1.1/>`_
(provides a "human" captcha widget based on a list of questions/answers)
Note: not all of these may be compatible with the current version of ``plone.app.discussion`` and ``Plone`` itself.
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.
There is initial `documentation <https://pythonhosted.org/plone.app.discussion/>`_ but it is outdated.
You will still get a feel for how the package is structured though.
Credits