source: products/qPloneComments/trunk/README.txt @ 2284

Last change on this file since 2284 was 104, checked in by crchemist, 18 years ago
  • Property svn:eol-style set to native
File size: 3.1 KB
Line 
1Plone Comments
2
3  Plone Comments (qPloneComments) is a Plone product developed developed
4  to improve the site managers and editors expirience with standard
5  commenting mechanism in Plone.
6
7Features
8
9  * Notify admin about comment posted
10
11  * Notify commentator about his comment aproval
12
13  * Notify author of parent comment about new follow up added
14
15  * Moderation of comments, approval of comments
16
17  * Anonymous commenting
18
19  * Added Name field to comment form, it is required for anonymous comments
20
21  * Article author can be notified about new comment after the approval by reviewer
22
23  * List of recent comments for more comfortable moderation
24
25  * Configlet that allow:
26
27    o Turning on/off Moderation
28
29    o Turning on/off Manager notification
30
31    o Turning on/off Editor notification
32
33    o Turning on/off Anonymous Commenting
34
35    o Configure admin e-mail for notifications
36
37    o Configure notification subject
38
39  * qPloneCaptcha integrated (needs the qPloneCaptcha to be installed)
40
41Notes
42
43  Comments moderation is implemented with involvement of two stage workflow.
44  Comments are created in "private" state and visible only to DiscussionManager
45  group of users.
46
47  To differentiate between logged-in (registered) commentors and Anonymous
48  commentors that pretend to be one person or other one, we use Boldness of
49  name. The Comment author is in bold when posted by logged in member. The
50  names provided when posting Anonymously are in plain text.
51
52  Notification subject control allows to enter custom prefix to disctinct
53  notifications comming from different sites.
54
55Usage
56
57  One of possible UseCases:
58
59  Moderation is enabled and authors notification is turned on.
60
61    * New comment posted in private state.
62
63    * Notification is sent to the emails entered in Plone Comments configlet.
64
65    * Moderator User with DiscussionManager role see the comment.
66
67    * The comment can be deleted or published on modaration stage.
68
69    * When comment is published notification is sent to Article Editor.
70
71Links
72
73  * Download releases from Sourceforge.net "Plone Comments project area":http://sf.net/projects/quintagroup
74
75  * Get latest development version from "SVN":http://svn.quintagroup.com/products/qPloneComments/trunk
76
77Requirements
78
79  * Plone 3.0.x (with plone.browserlayer) or Plone 3.1.x.
80
81Installation
82
83   1. Unpack into the **Products** folder of your Zope instance.
84
85   2. Install *qPloneComments* with Quick Installer.
86
87  **Atention**: If you are using a Plone version **before** 3.1 you need to install
88  "plone.browserlayer":http://pypi.python.org/pypi/plone.browserlayer (which also
89  requires a "GenericSetup":http://pypi.python.org/pypi/Products.GenericSetup version
90  greater than 1.4) in your Plone site. It shows up as **Local browser layer support**
91  in the Plone Add-on Products Control Panel.
92
93License
94
95  Please find license in *LICENSE.GPL*.
96
97Author
98
99  The product is developed and maintained by http://quintagroup.com team.
100
101  Authors:
102
103    * Volodymyr Cherepanyak
104
105    * Andriy Mylenkyy
106
107    * Mykola Kharechko
108
109  Contributors
110
111    * Gerry Kirk: product translations improvement and proofreading
112
113    * Dorneles Tremea: code cleanup and generic setup porting
Note: See TracBrowser for help on using the repository browser.