Changeset 630

Show
Ignore:
Timestamp:
11/16/06 09:34:47
Author:
crchemist
Message:

Wrote readme.txt.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • qPloneComments/trunk/README.txt

    r629 r630  
     1Plone Comments 
     2 
     3Plone Comments (qPloneComments) is a Plone product developed developed to improve the site managers and editors expirience with standard commenting mechanism in Plone. 
     4Features 
     5 
     6    * Notify admin about comment posted 
     7    * Moderation of comments, approval of comments 
     8    * Anonymous commenting 
     9    * Added Name field to comment form, it is required for anonymous comments 
     10    * Article author can be notified about new comment after the approval by reviewer 
     11    * List of recent comments for more comfortable moderation 
     12    * Configlet that allow: 
     13          o Turning on/off Moderation 
     14          o Turning on/off Manager notification 
     15          o Turning on/off Editor notification 
     16          o Turning on/off Anonymous Commenting 
     17          o Configure admin e-mail for notifications 
     18          o Configure notification subject  
     19 
     20Comments moderation is implemented with involvement of two stage workflow. Comments are created in "private" state and visible only to DiscussionManager group of users. 
     21 
     22To differentiate between logged-in (registered) commentors and Anonymous commentors that pretend to be one person or other one, we use Boldness of name. The Comment author is in bold when posted by logged in member. The names provided when posting Anonymously are in plain text. 
     23 
     24Notification subject control allows to enter custom prefix to disctinct nofifications comming from different sites. 
     25Usage 
     26 
     27One of possible UseCases: 
     28 
     29Moderation is enabled and authors notification is turned on. 
     30 
     31    * New comment posted in private state. 
     32    * Notification is sent to the emails entered in Plone Comments configlet. 
     33    * Moderator User with DiscussionManager role see the comment. 
     34    * The comment can be deleted or published on modaration stage. 
     35    * When comment is published notification is sent to Article Editor.  
     36 
     37Links 
     38 
     39    * Download releases from  Sourceforge.net Plone comments project area . 
     40    * Get latest development version from SVN 
     41    * Documentation repository 
     42 
     43Installation 
     44 
     45   1. Unpack into /Products folder of your Zope instance. 
     46   2. Install qPloneComments with Quick Installer. 
     47 
     48Requirements 
     49 
     50    * Plone 2.0.5 
     51    * Plone 2.1 - 2.1.2 
     52    * Plone 2.5 
     53 
     54Licence 
     55 
     56ZPL licence 
     57Author 
     58 
     59Volodymyr Cherepanyak, Andriy Mylenkyj, Mykola Kharechko.