From a8b218827a400cf5ced7db133be0a0f9e2180875 Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Tue, 1 Nov 2005 10:17:34 +0000 Subject: - Patch #26139 by webchick / Kieran / documentation team: improved admin help of core modules! / --- modules/comment/comment.module | 38 +++++++++++++------------------------- 1 file changed, 13 insertions(+), 25 deletions(-) (limited to 'modules/comment/comment.module') diff --git a/modules/comment/comment.module b/modules/comment/comment.module index 0b4aeb3c0..864b47ae3 100644 --- a/modules/comment/comment.module +++ b/modules/comment/comment.module @@ -19,31 +19,21 @@ /** * Implementation of hook_help(). */ -function comment_help($section = "admin/help#comment") { +function comment_help($section) { switch ($section) { case 'admin/help#comment': - return 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, story, collaborative book page, etc. An administrator can give comment permissions to user groups, and users can (optionally) edit their last comment, assuming no others have been posted since.

- -

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 » comments » configure.

- -

Additional comment configurations

-

Comments behave like other user submissions in Drupal. Filters, smileys and HTML that work in nodes will also work with comments. Administrators can control access to various comment module functions through administer » access control » 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:

- - -

Notification of new comments

-

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

-

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 they have not read. Some administrators may want to download, install and configure the notify module. Users can then request that Drupal send them an e-mail when new comments are posted (the notify module requires that cron.php be configured properly).

-

The tracker module, disabled by default, displays all the site's recent posts. There is a link to the recent posts 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 \"new\" label beside the text of unread comments.

", array('%comment-config' => url('admin/comment/configure'), '%permissions' => url('admin/access/permissions'), '%tracker' => url('tracker'), '%download-notify' => 'http://drupal.org/project/releases', '%comment-initial' => url('admin/comment/configure/roles'))); + $output = '

'. t('The comment module creates a discussion board for each post. Users can post comments to discuss a forum topic, weblog post, story, collaborative book page, etc. The ability to comment is an important part of involving members in a communtiy dialogue.') .'

'; + $output .= '

'. t('An administrator can give comment permissions to user groups, and users can (optionally) edit their last comment, assuming no others have been posted since. 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. Comments behave like other user submissions. Filters, smileys and HTML that work in nodes will also work with comments. The comment module provides specific features to inform site members when new comments have been posted. On sites with active commenting from users, the administrator can turn over comment moderation to the community.') .'

'; + $output .= t('

You can

+ +', array('%admin-access' => url('admin/access'), '%admin-comment-configure' => url('admin/comment/configure'))); + $output .= '

'. t('For more information please read the configuration and customization handbook Comment page.', array('%comment' => 'http://www.drupal.org/handbook/modules/comment/')) .'

'; + return $output; + case 'admin/modules#description': + return t('Allows users to comment on and discuss published content.'); case 'admin/comment': case 'admin/comment/new': return t("

Below is a list of the latest comments posted to your site. Click on a subject to see the comment, the author's name to edit the author's user information , \"edit\" to modify the text, and \"delete\" to remove their submission.

"); @@ -52,8 +42,6 @@ function comment_help($section = "admin/help#comment") { case 'admin/comment/configure': case 'admin/comment/configure/settings': return t("

Comments can be attached to any node, and their settings are below. The display comes in two types: a \"flat list\" where everything is flush to the left side, and comments come in chronological order, and a \"threaded list\" where replies to other comments are placed immediately below and slightly indented, forming an outline. They also come in two styles: \"expanded\", where you see both the title and the contents, and \"collapsed\" where you only see the title. Preview comment forces a user to look at their comment by clicking on a \"Preview\" button before they can actually add the comment.

"); - case 'admin/modules#description': - return t('Allows users to comment on and discuss published content.'); } } -- cgit v1.2.3