diff options
Diffstat (limited to 'modules/comment')
| -rw-r--r-- | modules/comment/comment.module | 124 |
1 files changed, 62 insertions, 62 deletions
diff --git a/modules/comment/comment.module b/modules/comment/comment.module index 9150a9806..7bd5b5240 100644 --- a/modules/comment/comment.module +++ b/modules/comment/comment.module @@ -6,68 +6,68 @@ function comment_help($section = "admin/help#comment") { switch ($section) { case 'admin/help#comment': - $output .= "<p>When enabled, the Drupal comment module creates a discussion board for each Drupal node. Users can post comments to discuss a forum topic, weblog post, collaborative book page, etc.</p>"; - $output .= "<h3>User control of comment display</h3>"; - $output .= "<p>Attached to each comment board is a control panel for customizing the way that comments are displayed. Users can control the chronological ordering of posts (newest or oldest first) and the number of posts to display on each page. Additional settings include:</p>"; - $output .= "<ul>"; - $output .= "<li><strong>Threaded</strong> -- Displays the posts grouped according to conversations and subconversations, much like the subject view of an email client.</li>"; - $output .= "<li><strong>Flat</strong> -- Displays the posts in chronological order, in the order in which they are posted.</li>"; - $output .= "<li><strong>Expanded</strong> -- Displays the title and text for each post.</li>"; - $output .= "<li><strong>Collapsed</strong> -- Displays only the title for each post.</li>"; - $output .= "</ul>"; - $output .= "<p>When a user chooses <i>save settings</i>, the comments are then redisplayed using the user's new choices. Administrators can set the default settings for the comment control panel, along with other comment defaults, in <a href=\"%comment-config\">administer » configuration » modules » comment</a>.</p>"; - $output .= "<p>NOTE: When comment moderation is enabled, users will have another control panel option to control thresholds (see below).</p>"; - - $output .= "<h3>Additional comment configurations</h3>"; - $output .= "<p>Comments behave like other user submissions in Drupal. Filters, smileys and HTML that work in nodes will also work with content. To prevent a single user from spamming the web site with too many comments, administrators can set a comment throttle in <a href=\"%site-config\">administer » configuration</a> under <i>Submission settings</i>.</p>"; - $output .= "<p>Administrators can control access to various comment module functions through <a href=\"%user-permissions\">administer » accounts » permissions</a>. Know that in a new Drupal installation, all comment permissions are disabled by default. The choice of which permissions to grant to which roles (groups of users) is left up to the site administrator.</p>"; - $output .= "<p>The following permissions can be enabled for anonymous users, authenticated users, or any other user roles that the administrator chooses to define:</p>"; - $output .= "<ul>"; - $output .= "<li><strong>Access comments</strong> -- Allows users to view comments.</li>"; - $output .= "<li><strong>Administrate comments</strong> -- Allows users complete control over configuring, editing and deleting all comments on the site. Best reserved for <strong>very</strong> trusted users.</li>"; - $output .= "<li><strong>Moderate comments</strong> -- Allows users to rate comment postings (see more on moderation below).</li>"; - $output .= "<li><strong>Post comments</strong> -- Allows users to post comments into an administrator moderation queue. Administrators then post the comment to the site.</li>"; - $output .= "<li><strong>Post comments without approval</strong> -- Allows users to directly post comments. This bypasses the administrator moderation queue.</li>"; - $output .= "</ul>"; - - $output .= "<h3>Notification of new comments</h3>"; - $output .= "<p>Drupal provides specific features to inform site members when new comments have been posted:</p>"; - $output .= "<ul>"; - $output .= "<li>On the home page, Drupal displays the total number of comments attached to each node, and tracks comments read by individual site members. Members which have logged in will see a notice accompanying nodes which contain comments that they have not read.</li>"; - $output .= "<li>The <i>tracker</i> module, disabled by default, displays all the site's recent posts. There is a link to the <a href=\"%tracker\">recent posts</a> page in the navigation block. This page is a useful way to browse new or updated nodes and comments. Content which the user has not yet read is tagged with a red star (this graphic depends on the current theme). Visit the comment board for any node, and Drupal will display a red <i>new</i> label beside the text of unread comments.</li>"; - $output .= "<li>Some administrators may want to <a href=\"%download-notify\">download</a>, install and configure the notify module. Users can then request that Drupal send them an email when new comments are posted (the notify module requires that cron.php be configured properly).</li>"; - $output .= "</ul>"; - - $output .= "<h3>Comment moderation</h3>"; - $output .= "<p>On sites with active commenting from users, the administrator can turn over comment moderation to the community. </p>"; - $output .= "<p>With comment moderation, each comment is automatically assigned an initial rating. As users read comments, they can apply a vote which affects the comment rating. At the same time, users have an additional option in the control panel which allows them to set a threshold for the comments they wish to view. Those comments with ratings lower than the set threshold will not be shown.</p>"; - $output .= "<p>To enable moderation, the administrator must grant <a href=\"%permission\">moderate comments</a> permissions. Then, a number of options in <a href=\"%comment-moderation\">administer » comments » moderation</a> must be configured.</p>"; - - $output .= "<h4>Moderation votes</h4>"; - $output .= "<p>The first step is to create moderation labels which allow users to rate a comment. Go to <a href=\"%comment-votes\">administer » comments » moderation » votes</a>. In the <i>vote</i> field, enter the textual labels which users will see when casting their votes. Some examples are</p>"; - $output .= "<ul>"; - $output .= "<li>Excellent +3</li>"; - $output .= "<li>Insightful +2</li>"; - $output .= "<li>Caught My Attention +1</li>"; - $output .= "<li>Useful +1</li>"; - $output .= "<li>Redundant -1</li>"; - $output .= "<li>Flame -3</li>"; - $output .= "</ul>"; - $output .= "<p>So that users know how their votes affect the comment, these examples include the vote value as part of the label, although that is optional.</p>"; - $output .= "<p>Using the weight option, you can control the order in which the votes appear to users. Setting the weight heavier (positive numbers) will make the vote label appear at the bottom of the list. Lighter (a negative number) will push it to the top. To encourage positive voting, a useful order might be higher values, positive votes, at the top, with negative votes at the bottom.</p>"; - - $output .= "<h4>Moderator vote/values matrix</h4>"; - - $output .= "<p>Next go to <a href=\"%comment-matrix\">administer » comments » moderation » matrix</a>. Enter the values for the vote labels for each permission role in the vote matrix. The values entered here will be used to create the rating for each comment.</p>"; - $output .= "<p>NOTE: Comment ratings are calculated by averaging user votes with the initial rating.</p>"; - $output .= "<h4>Creating comment thresholds</h4>"; - $output .= "<p>In <a href=\"%comment-thresholds\">administer » comments » moderation » thresholds</a>, you'll have to create some comment thresholds to make the comment rating system useful. When comment moderation is enabled and the thresholds are created, users will find another comment control panel option for selecting their thresholds. They'll use the thresholds you enter here to filter out comments with low ratings. Consequently, you'll probably want to create more than one threshold to give users some flexibility in filtering comments.</p>"; - $output .= "<p>When creating the thresholds, note that the <i>Minimum score</i> is asking you for the lowest rating that a comment can have in order to be displayed.</p>"; - $output .= "<p>To see a common example of how thresholds work, you might visit <a href=\"%slashdot\">Slashdot</a> and view one of their comment boards associated with a story. You can reset the thresholds in their comment control panel.</p>"; - - $output .= "<h4>Initial comment scores</h4>"; - $output .= "<p>Finally, you may want to enter some <i>initial comment scores</i>. In <a href=\"%comment-initial\">administer » comments » initial comment scores</a> you can assign a beginning rating for all comments posted by a particular permission role. If you do not assign any initial scores, Drupal will assign a rating of <strong>0</strong> as the default.</p>"; - $output = t($output, array("%comment-config" => url("admin/system/modules/comment"), "%site-config" => url("admin/system"), "%user-permissions" => url("admin/user/permission"), "%tracker" => url("tracker"), "%download-notify" => "http://drupal.org/project/releases", "%permission" => url("admin/user/permission"), "%comment-moderation" => url("admin/comment/moderation"), "%comment-votes" => url("admin/comment/moderation/votes"), "%comment-matrix" => url("admin/comment/moderation/matrix"), "%comment-thresholds" => url("admin/comment/moderation/filters"), "%slashdot" => " http://slashdot.org", "%comment-initial" => url("admin/comment/moderation/roles"))); + $output = t(" + <p>When enabled, the Drupal comment module creates a discussion board for each Drupal node. Users can post comments to discuss a forum topic, weblog post, collaborative book page, etc.</p> + <h3>User control of comment display</h3> + <p>Attached to each comment board is a control panel for customizing the way that comments are displayed. Users can control the chronological ordering of posts (newest or oldest first) and the number of posts to display on each page. Additional settings include:</p> + <ul> + <li><strong>Threaded</strong> -- Displays the posts grouped according to conversations and subconversations, much like the subject view of an email client.</li> + <li><strong>Flat</strong> -- Displays the posts in chronological order, in the order in which they are posted.</li> + <li><strong>Expanded</strong> -- Displays the title and text for each post.</li> + <li><strong>Collapsed</strong> -- Displays only the title for each post.</li> + </ul> + <p>When a user chooses <i>save settings</i>, the comments are then redisplayed using the user's new choices. Administrators can set the default settings for the comment control panel, along with other comment defaults, in <a href=\"%comment-config\">administer » configuration » modules » comment</a>.</p> + <p>NOTE: When comment moderation is enabled, users will have another control panel option to control thresholds (see below).</p> + + <h3>Additional comment configurations</h3> + <p>Comments behave like other user submissions in Drupal. Filters, smileys and HTML that work in nodes will also work with content. To prevent a single user from spamming the web site with too many comments, administrators can set a comment throttle in <a href=\"%site-config\">administer » configuration</a> under <i>Submission settings</i>.</p> + <p>Administrators can control access to various comment module functions through <a href=\"%user-permissions\">administer » accounts » permissions</a>. Know that in a new Drupal installation, all comment permissions are disabled by default. The choice of which permissions to grant to which roles (groups of users) is left up to the site administrator.</p> + <p>The following permissions can be enabled for anonymous users, authenticated users, or any other user roles that the administrator chooses to define:</p> + <ul> + <li><strong>Access comments</strong> -- Allows users to view comments.</li> + <li><strong>Administrate comments</strong> -- Allows users complete control over configuring, editing and deleting all comments on the site. Best reserved for <strong>very</strong> trusted users.</li> + <li><strong>Moderate comments</strong> -- Allows users to rate comment postings (see more on moderation below).</li> + <li><strong>Post comments</strong> -- Allows users to post comments into an administrator moderation queue. Administrators then post the comment to the site.</li> + <li><strong>Post comments without approval</strong> -- Allows users to directly post comments. This bypasses the administrator moderation queue.</li> + </ul> + + <h3>Notification of new comments</h3> + <p>Drupal provides specific features to inform site members when new comments have been posted:</p> + <ul> + <li>On the home page, Drupal displays the total number of comments attached to each node, and tracks comments read by individual site members. Members which have logged in will see a notice accompanying nodes which contain comments that they have not read.</li> + <li>The <i>tracker</i> module, disabled by default, displays all the site's recent posts. There is a link to the <a href=\"%tracker\">recent posts</a> page in the navigation block. This page is a useful way to browse new or updated nodes and comments. Content which the user has not yet read is tagged with a red star (this graphic depends on the current theme). Visit the comment board for any node, and Drupal will display a red <i>new</i> label beside the text of unread comments.</li> + <li>Some administrators may want to <a href=\"%download-notify\">download</a>, install and configure the notify module. Users can then request that Drupal send them an email when new comments are posted (the notify module requires that cron.php be configured properly).</li> + </ul> + + <h3>Comment moderation</h3> + <p>On sites with active commenting from users, the administrator can turn over comment moderation to the community. </p> + <p>With comment moderation, each comment is automatically assigned an initial rating. As users read comments, they can apply a vote which affects the comment rating. At the same time, users have an additional option in the control panel which allows them to set a threshold for the comments they wish to view. Those comments with ratings lower than the set threshold will not be shown.</p> + <p>To enable moderation, the administrator must grant <a href=\"%permission\">moderate comments</a> permissions. Then, a number of options in <a href=\"%comment-moderation\">administer » comments » moderation</a> must be configured.</p> + + <h4>Moderation votes</h4> + <p>The first step is to create moderation labels which allow users to rate a comment. Go to <a href=\"%comment-votes\">administer » comments » moderation » votes</a>. In the <i>vote</i> field, enter the textual labels which users will see when casting their votes. Some examples are</p> + <ul> + <li>Excellent +3</li> + <li>Insightful +2</li> + <li>Caught My Attention +1</li> + <li>Useful +1</li> + <li>Redundant -1</li> + <li>Flame -3</li> + </ul> + <p>So that users know how their votes affect the comment, these examples include the vote value as part of the label, although that is optional.</p> + <p>Using the weight option, you can control the order in which the votes appear to users. Setting the weight heavier (positive numbers) will make the vote label appear at the bottom of the list. Lighter (a negative number) will push it to the top. To encourage positive voting, a useful order might be higher values, positive votes, at the top, with negative votes at the bottom.</p> + + <h4>Moderator vote/values matrix</h4> + + <p>Next go to <a href=\"%comment-matrix\">administer » comments » moderation » matrix</a>. Enter the values for the vote labels for each permission role in the vote matrix. The values entered here will be used to create the rating for each comment.</p> + <p>NOTE: Comment ratings are calculated by averaging user votes with the initial rating.</p> + <h4>Creating comment thresholds</h4> + <p>In <a href=\"%comment-thresholds\">administer » comments » moderation » thresholds</a>, you'll have to create some comment thresholds to make the comment rating system useful. When comment moderation is enabled and the thresholds are created, users will find another comment control panel option for selecting their thresholds. They'll use the thresholds you enter here to filter out comments with low ratings. Consequently, you'll probably want to create more than one threshold to give users some flexibility in filtering comments.</p> + <p>When creating the thresholds, note that the <i>Minimum score</i> is asking you for the lowest rating that a comment can have in order to be displayed.</p> + <p>To see a common example of how thresholds work, you might visit <a href=\"%slashdot\">Slashdot</a> and view one of their comment boards associated with a story. You can reset the thresholds in their comment control panel.</p> + + <h4>Initial comment scores</h4> + <p>Finally, you may want to enter some <i>initial comment scores</i>. In <a href=\"%comment-initial\">administer » comments » initial comment scores</a> you can assign a beginning rating for all comments posted by a particular permission role. If you do not assign any initial scores, Drupal will assign a rating of <strong>0</strong> as the default.</p>", array("%comment-config" => url("admin/system/modules/comment"), "%site-config" => url("admin/system"), "%user-permissions" => url("admin/user/permission"), "%tracker" => url("tracker"), "%download-notify" => "http://drupal.org/project/releases", "%permission" => url("admin/user/permission"), "%comment-moderation" => url("admin/comment/moderation"), "%comment-votes" => url("admin/comment/moderation/votes"), "%comment-matrix" => url("admin/comment/moderation/matrix"), "%comment-thresholds" => url("admin/comment/moderation/filters"), "%slashdot" => " http://slashdot.org", "%comment-initial" => url("admin/comment/moderation/roles"))); break; case 'admin/system/modules#description': $output = t("Enables user to comment on content (nodes)."); |