function comment_help in Drupal 4

Same name and namespace in other branches

1. 8 core/modules/comment/comment.module \comment_help()
2. 5 modules/comment/comment.module \comment_help()
3. 6 modules/comment/comment.module \comment_help()
4. 7 modules/comment/comment.module \comment_help()
5. 9 core/modules/comment/comment.module \comment_help()

Implementation of hook_help().

File

modules/comment.module, line 69

Enables users to comment on published content.

Code

function comment_help($section) {
  switch ($section) {
    case 'admin/help#comment':
      $output = '<p>' . 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 community dialogue.') . '</p>';
      $output .= '<p>' . 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.') . '</p>';
      $output .= t('<p>You can</p>
<ul>
<li>control access for various comment module functions through access permissions <a href="%admin-access">administer &gt;&gt; access control</a>.</li>
<li>administer comments <a href="%admin-comment-configure"> administer &gt;&gt; comments &gt;&gt; configure</a>.</li>
</ul>
', array(
        '%admin-access' => url('admin/access'),
        '%admin-comment-configure' => url('admin/comment/configure'),
      ));
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="%comment">Comment page</a>.', array(
        '%comment' => 'http://drupal.org/handbook/modules/comment/',
      )) . '</p>';
      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("<p>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.</p>");
    case 'admin/comment/approval':
      return t("<p>Below is a list of the comments posted to your site that need approval. To approve a comment, click on \"edit\" and then change its \"moderation status\" to Approved. 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.</p>");
    case 'admin/comment/configure':
    case 'admin/comment/configure/settings':
      return t("<p>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.</p>");
  }
}