Changeset 1135

Show
Ignore:
Timestamp:
06/27/08 10:34:45
Author:
deo
Message:

Reformated to matches the expected format.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • qPloneComments/branches/plone-3.0/README.txt

    r1103 r1135  
    11Plone Comments 
    22 
    3 Plone Comments (qPloneComments) is a Plone product developed developed to improve the site managers and editors expirience with standard commenting mechanism in Plone. 
     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. 
    46 
    57Features 
    68 
    7     * Notify admin about comment posted 
    8     * Notify commentator about his comment aproval 
    9     * Notify author of parent comment about new follow up added 
    10     * Moderation of comments, approval of comments 
    11     * Anonymous commenting 
    12     * Added Name field to comment form, it is required for anonymous comments 
    13     * Article author can be notified about new comment after the approval by reviewer 
    14     * List of recent comments for more comfortable moderation 
    15     * Configlet that allow: 
    16           o Turning on/off Moderation 
    17           o Turning on/off Manager notification 
    18           o Turning on/off Editor notification 
    19           o Turning on/off Anonymous Commenting 
    20           o Configure admin e-mail for notifications 
    21           o Configure notification subject 
    22     * qPloneCaptcha integrated (needs the qPloneCaptcha to be installed) 
     9  * Notify admin about comment posted 
    2310 
    24 Comments moderation is implemented with involvement of two stage workflow. Comments are created in "private" state and visible only to DiscussionManager group of users. 
     11  * Notify commentator about his comment aproval 
    2512 
    26 To 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. 
     13  * Notify author of parent comment about new follow up added 
    2714 
    28 Notification subject control allows to enter custom prefix to disctinct notifications comming from different sites. 
     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. 
    2954 
    3055Usage 
    3156 
    32 One of possible UseCases: 
     57  One of possible UseCases: 
    3358 
    34 Moderation is enabled and authors notification is turned on. 
     59  Moderation is enabled and authors notification is turned on. 
    3560 
    3661    * New comment posted in private state. 
     62 
    3763    * Notification is sent to the emails entered in Plone Comments configlet. 
     64 
    3865    * Moderator User with DiscussionManager role see the comment. 
     66 
    3967    * The comment can be deleted or published on modaration stage. 
    40     * When comment is published notification is sent to Article Editor.  
     68 
     69    * When comment is published notification is sent to Article Editor. 
    4170 
    4271Links 
    4372 
    44     * Download releases from  Sourceforge.net Plone comments project area http://sf.net/projects/quintagroup/ 
    45     * Get latest development version from SVN http://svn.quintagroup.com/products/qPloneComments/trunk 
     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 
    4676 
    4777Installation 
    4878 
    4979   1. Unpack into /Products folder of your Zope instance. 
     80 
    5081   2. Install qPloneComments with Quick Installer. 
    5182 
    5283Requirements 
    5384 
    54     * Plone 3.0.x 
     85  * Plone 3.x 
    5586 
    5687License 
    5788 
    58 Please find license in LICENSE.GPL 
     89  Please find license in LICENSE.GPL 
    5990 
    6091Author 
    6192 
    62 The product is developed and maintained by quintagoup.com team. 
     93  The product is developed and maintained by quintagoup.com team. 
    6394 
    64 Authors - Volodymyr Cherepanyak, Andriy Mylenkyy, Mykola Kharechko. 
     95  Authors: 
    6596 
    66 Thanks for Gerry Kirk for product translations improvement and proofreading. 
     97    * Volodymyr Cherepanyak 
     98 
     99    * Andriy Mylenkyy 
     100 
     101    * Mykola Kharechko 
     102 
     103  Contributors 
     104 
     105    * Gerry Kirk: product translations improvement and proofreading 
     106 
     107    * Dorneles Tremea: code cleanup and generic setup porting