From b85eb11e113396490720572d11d30cd83c772ba1 Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Fri, 23 Jan 2004 18:42:43 +0000 Subject: Patch 5287 by Stefan: multiline help texts should become inside a single $output. --- modules/comment.module | 124 ++++++++++++++++++++++++------------------------- 1 file changed, 62 insertions(+), 62 deletions(-) (limited to 'modules/comment.module') diff --git a/modules/comment.module b/modules/comment.module index 9150a9806..7bd5b5240 100644 --- a/modules/comment.module +++ b/modules/comment.module @@ -6,68 +6,68 @@ function comment_help($section = "admin/help#comment") { switch ($section) { case 'admin/help#comment': - $output .= "

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.

"; - $output .= "

User control of comment display

"; - $output .= "

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:

"; - $output .= ""; - $output .= "

When a user chooses save settings, 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 administer » configuration » modules » comment.

"; - $output .= "

NOTE: When comment moderation is enabled, users will have another control panel option to control thresholds (see below).

"; - - $output .= "

Additional comment configurations

"; - $output .= "

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 administer » configuration under Submission settings.

"; - $output .= "

Administrators can control access to various comment module functions through administer » accounts » permissions. 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.

"; - $output .= "

The following permissions can be enabled for anonymous users, authenticated users, or any other user roles that the administrator chooses to define:

"; - $output .= ""; - - $output .= "

Notification of new comments

"; - $output .= "

Drupal provides specific features to inform site members when new comments have been posted:

"; - $output .= ""; - - $output .= "

Comment moderation

"; - $output .= "

On sites with active commenting from users, the administrator can turn over comment moderation to the community.

"; - $output .= "

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.

"; - $output .= "

To enable moderation, the administrator must grant moderate comments permissions. Then, a number of options in administer » comments » moderation must be configured.

"; - - $output .= "

Moderation votes

"; - $output .= "

The first step is to create moderation labels which allow users to rate a comment. Go to administer » comments » moderation » votes. In the vote field, enter the textual labels which users will see when casting their votes. Some examples are

"; - $output .= ""; - $output .= "

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.

"; - $output .= "

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.

"; - - $output .= "

Moderator vote/values matrix

"; - - $output .= "

Next go to administer » comments » moderation » matrix. 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.

"; - $output .= "

NOTE: Comment ratings are calculated by averaging user votes with the initial rating.

"; - $output .= "

Creating comment thresholds

"; - $output .= "

In administer » comments » moderation » thresholds, 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.

"; - $output .= "

When creating the thresholds, note that the Minimum score is asking you for the lowest rating that a comment can have in order to be displayed.

"; - $output .= "

To see a common example of how thresholds work, you might visit Slashdot and view one of their comment boards associated with a story. You can reset the thresholds in their comment control panel.

"; - - $output .= "

Initial comment scores

"; - $output .= "

Finally, you may want to enter some initial comment scores. In administer » comments » initial comment scores 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 0 as the default.

"; - $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(" +

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.

+

User control of comment display

+

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:

+ +

When a user chooses save settings, 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 administer » configuration » modules » comment.

+

NOTE: When comment moderation is enabled, users will have another control panel option to control thresholds (see below).

+ +

Additional comment configurations

+

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 administer » configuration under Submission settings.

+

Administrators can control access to various comment module functions through administer » accounts » permissions. 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.

+

The following permissions can be enabled for anonymous users, authenticated users, or any other user roles that the administrator chooses to define:

+ + +

Notification of new comments

+

Drupal provides specific features to inform site members when new comments have been posted:

+ + +

Comment moderation

+

On sites with active commenting from users, the administrator can turn over comment moderation to the community.

+

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.

+

To enable moderation, the administrator must grant moderate comments permissions. Then, a number of options in administer » comments » moderation must be configured.

+ +

Moderation votes

+

The first step is to create moderation labels which allow users to rate a comment. Go to administer » comments » moderation » votes. In the vote field, enter the textual labels which users will see when casting their votes. Some examples are

+ +

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.

+

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.

+ +

Moderator vote/values matrix

+ +

Next go to administer » comments » moderation » matrix. 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.

+

NOTE: Comment ratings are calculated by averaging user votes with the initial rating.

+

Creating comment thresholds

+

In administer » comments » moderation » thresholds, 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.

+

When creating the thresholds, note that the Minimum score is asking you for the lowest rating that a comment can have in order to be displayed.

+

To see a common example of how thresholds work, you might visit Slashdot and view one of their comment boards associated with a story. You can reset the thresholds in their comment control panel.

+ +

Initial comment scores

+

Finally, you may want to enter some initial comment scores. In administer » comments » initial comment scores 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 0 as the default.

", 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)."); -- cgit v1.2.3