<!-- $Id: README.txt,v 1.1.2.4 2008/10/15 18:08:28 LasseP Exp $ -->
<h2>Overview</h2>

With GB Comment Revisions you get a revision system for comments, like Drupal already offers for nodes.

<h2>Features</h2>
  - Creation of revisions for comments <br />
  - Configure the maximum amount of allowed revisions <br />
  - List the revisions for a comment <br />
  - Visually identify the changes between two revisions by putting them side by side, highlighting <br />
    the changes (using the Diff module) <br />

<h2>Requirements</h3>
comment.module <br />
diff.module <br />

<h2>Installation</h3>
<ol>
  <li>Copy comment_revisions folder to sites/all/modules</li>
  <li>Enable comment_revisions module</li>
  <li>Edit permissions and settings</li>
</ol>

<h2>About Nearyan's patch</h2>
After installing this patch, <strong>you need to run <a href="/update.php">update.php</a>!</strong><br/>
The purpose of this patch is to use the Diff module to enable diffs for comments, so that you can easily
see the differences between two comment revisions. When clicking on the 'view revisions' link, a form
gets shown in which you select two revisions for comparison. Then they appear side by side on the screen,
highlighting the differences between them, and showing the latest revision at the bottom.<br/>
This patch changes the directory structure originally defined by Comment Revisions, to be as similar as
possible to the one for nodes:
<ul>
  <li>comment/<em>x</em></li>
  <li>comment/<em>x</em>/revisions/list</li>
  <li>comment/<em>x</em>/revisions/<em>y</em>/revert</li>
  <li>comment/<em>x</em>/revisions/<em>y</em>/delete</li>
  <li>comment/<em>x</em>/revisions/view/<em>y</em>/<em>z</em></li>
  <li>comment/<em>x</em>/revisions/<em>y</em>/view</li>
  <li>comment/<em>x</em>/revisions/view/latest</li>
  <li>comment/<em>x</em>/revisions/<em>y</em>/hide</li>
  <li>comment/<em>x</em>/revisions/<em>y</em>/unhide</li>
</ul>
In this list, <em>x</em> must be a comment ID and <em>y</em> and <em>z</em> comment revision IDs.
For all of these, in addition to the appropriate permissions defined by this module, the user needs
to have the permission 'access comments'.<br/>
This patch also incorporates <a href="http://drupal.org/node/361826">the one by linksunten</a>, which
introduces the concept of hidden revisions - if a revision is hidden, and a user doesn't have the
'view hidden comment revisions' permission, then he won't be able to see it. (Note that even if you
already had this patch installed, you still need to run update.php after installing this one.)<br/>
Note that the permissions that this module defines were thoroughly changed - some were removed, some
were added, and nearly all were renamed to be more clear (and to not clash with the ones defined by
the node module). So after this patch, please <a href="/admin/user/permissions#module-comment_revisions">
review your permissions</a>.<br/>
This patch also addresses <a href="http://drupal.org/node/336022">issue 336022</a> and
<a href="http://drupal.org/node/276937">issue 276937</a>.
<br/>

<h2>The Setup</h3>
After installing the Comment Revisions module, you can edit the settings here:
<a href="/admin/settings/commentrevisions">Administer -> Site Configuration -> GB Comment Revisions</a>.<br />

You can set the following options:
<ul>
<li>Maximum number of automatic revisions:
     When you enabled the automatic creation of revisions, set this to your needs. The revisions will be deleted when limit is reached. This way you only have the
     newest revisions. I.e. if you set this to 5, only the 5 newest revisions will be stored in the database.</li>
<li>Disable log messages:
     Disables the text field that allows you to describe what you did when creating a new revision, and prevent the log messages from being showed when looking
     at the revision list of a comment.</li>
</ul>

<h2>Role types</h3>
Comment Revisions offers the following permissions.
<ul>
 <li>administer comment revisions:
     This is the one who can control the settings page.</li>
 <li>control creating comment revisions:
     When checked, the user can choose if he wants to create a new revision or not.</li>
 <li>create revisions for own comments:
     When editing one's own comment, specifies wether a new revision should be created.
     If "control creating revisions" is checked, then this permission acts as the default
     value for the 'Create Revision' textbox when editing a comment.</li>
 <li>create revisions for comments of others:
     When editing comments of others, specifies wether a new revision should be created.
     If "control creating revisions" is checked, then this permission acts as the default
     value for the 'Create Revision' textbox when editing a comment.</li>
 <li>hide comment revisions:
     This permission is needed for users to be allowed to hide a revision.</li>
 <li>unhide comment revisions:
     This permission is needed for users to be allowed to unhide a revision.</li>
 <li>view hidden comment revisions:
     This permission is needed for users to be allowed to view invisible revisions.</li>
 <li>revert comment revisions:
     This permission is needed for users to be allowed to revert to a revision. Note:
     reverting a hidden revision unhides it first (if the user has the 'unhide revisions'
     permission).</li>
 <li>delete comment revisions:
     This permission is needed for users who should be allowed to delete revisions.</li>
 <li>view comment revisions:
     This permission is needed for users to view revisions (of all comments).</li>
 <li>view own comment revisions:
     Can view revisions for his own comments.</li>
 <li>see creators of comment revisions:
     Specifies wether the user can see who the creator of a revision is (if he can see revisions
     at all).</li>
</ul>

<h2>Credits</h3>
LasseP: Thanks to everyone who ever posted something at drupal.org or other support sites. Also thanks to everyone willing to help in #drupal and drupal-support<br/>
Nearyan: Lots of thanks to <a href="http://drupal.org/user/8841"/>roderik</a>, for letting me read his book on Drupal, and his explanations, help, and patience.
And of course kudos to the guys of the Diff module, for their excellent work!
