source: products/quintagroup.plonecomments/trunk/README.txt @ 1178

Last change on this file since 1178 was 1178, checked in by olha, 10 years ago

README.txt updated

File size: 3.2 KB
Line 
1Introduction
2============
3
4Copyright (c) "Quintagroup": http://quintagroup.com, 2004-2009
5
6Plone Comments (quintagroup.plonecomments) is a Plone product developed
7to improve the site managers and editors expirience with standard
8commenting mechanism in Plone.
9
10
11Features
12--------
13
14Plone Comments alows to:
15
16* Notify admin about comment posted
17* Notify commentator about his comment aproval
18* Notify author of parent comment about new follow up added
19* Moderation of comments, approval of comments
20* Anonymous commenting
21* Added Name field to comment form, it is required for anonymous comments
22* Article author can be notified about new comment after the approval by reviewer
23* List of recent comments for more comfortable moderation
24
25Plone Comments Configlet allows:
26
27* Turning on/off Moderation
28* Turning on/off Manager notification
29* Turning on/off Editor notification
30* Turning on/off Anonymous Commenting
31* Configure admin e-mail for notifications
32* Configure notification subject
33
34Plone Comments can be integrated with Plone Captchas (requires quintagroup.plonecaptchas to be installed)
35
36
37Notes
38-----
39
40Comments moderation is implemented with involvement of two stage workflow.
41Comments are created in "private" state and visible only to DiscussionManager
42group of users.
43
44To differentiate between logged-in (registered) commentors and Anonymous
45commentors that pretend to be one person or other one, we use Boldness of
46name. The Comment author is in bold when posted by logged in member. The
47names provided when posting Anonymously are in plain text.
48
49Notification subject control allows to enter custom prefix to disctinct
50notifications comming from different sites.
51
52
53Usage
54-----
55
56One of possible UseCases:
57
58Moderation is enabled and authors notification is turned on.
59
60- New comment posted in private state.
61- Notification is sent to the emails entered in Plone Comments configlet.
62- Moderator User with DiscussionManager role see the comment.
63- The comment can be deleted or published on modaration stage.
64- When comment is published notification is sent to Article Editor.
65
66
67Links
68-----
69
70* Get latest development version from "SVN": http://svn.quintagroup.com/products/quintagroup.plonecomments/trunk
71* Watch Plone Comments Screencast (http://quintagroup.com/cms/screencasts/plone-comments) to learn how to install and set up Plone Comments on your buildout-based Plone instance for Plone 3.2 or above. You will also find one of the possible use cases of using Plone Comments Plone add-on included.
72* Watch Plone Comments Use Cases Screencast (http://quintagroup.com/cms/screencasts/plone-comments/use-cases) to learn about integration of Plone Comments with Plone Captchas, see 2 examples of possible use cases: anonymous and registered users commenting.
73
74Requirements
75------------
76
77* Plone 3.x
78* plone.browserlayer is required for Plone 3.0.x
79
80
81License
82-------
83
84Please find license in *LICENSE.GPL*.
85
86
87Authors
88-------
89
90The product is developed and maintained by http://quintagroup.com team.
91
92Authors:
93
94* Volodymyr Cherepanyak
95* Andriy Mylenkyy
96* Mykola Kharechko
97* Vitaliy Stepanov
98
99Contributors:
100 
101* Gerry Kirk: product translations improvement and proofreading
102* Dorneles Tremea: code cleanup and generic setup porting
Note: See TracBrowser for help on using the repository browser.