function forum_help in Drupal 4

Same name and namespace in other branches

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

Implementation of hook_help().

File

modules/forum.module, line 11

Enable threaded discussions about general topics.

Code

function forum_help($section) {
  switch ($section) {
    case 'admin/help#forum':
      $output = '<p>' . t('The forum module lets you create threaded discussion forums for a particular topic on your site. This is similar to a message board system such as phpBB. Forums are very useful because they allow community members to discuss topics with one another, and they are archived for future reference.') . '</p>';
      $output .= '<p>' . t('Forums can be organized under what are called <em>containers</em>. Containers hold forums and, in turn, forums hold threaded discussions. Both containers and forums can be placed inside other containers and forums. By planning the structure of your containers and forums well, you make it easier for users to find a topic area of interest to them.  Forum topics can be moved by selecting a different forum and can be left in the existing forum by selecting <em>leave a shadow copy</em>.  Forum topics can also have their own URL.') . '</p>';
      $output .= '<p>' . t('Forums module <strong>requires Taxonomy and Comments module</strong> be enabled.') . '</p>';
      $output .= t('<p>You can</p>
<ul>
<li>administer forums at <a href="%admin-forum">administer &gt;&gt; forums</a>.</li>
<li>enable the required comment and taxonomy modules at <a href="%admin-modules">administer &gt;&gt; modules</a>.</li>
<li>read about the comment module at <a href="%admin-help-comment">administer &gt;&gt; help &gt;&gt; comment</a>.</li>
<li>read about the taxonomy module at <a href="%admin-help-taxonomy">administer &gt;&gt; help &gt;&gt; taxonomy</a>.</li>
</ul>
', array(
        '%admin-forum' => url('admin/forum'),
        '%admin-modules' => url('admin/modules'),
        '%admin-help-comment' => url('admin/help/comment'),
        '%admin-help-taxonomy' => url('admin/help/taxonomy'),
      ));
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="%forum">Forum page</a>.', array(
        '%forum' => 'http://drupal.org/handbook/modules/forum/',
      )) . '</p>';
      return $output;
    case 'admin/modules#description':
      return t('Enables threaded discussions about general topics.');
    case 'admin/forum':
      return t('<p>This is a list of existing containers and forums that you can edit. Containers hold forums and, in turn, forums hold threaded discussions. Both containers and forums can be placed inside other containers and forums. By planning the structure of your containers and forums well, you make it easier for users to find a topic area of interest to them.</p>');
    case 'admin/forum/add/container':
      return t('<p>Containers help you organize your forums. The job of a container is to hold, or contain, other forums that are related. For example, a container named "Food" might hold two forums named "Fruit" and "Vegetables".</p>');
    case 'admin/forum/add/forum':
      return t('<p>A forum holds discussion topics that are related. For example, a forum named "Fruit" might contain topics titled "Apples" and "Bananas".</p>');
    case 'admin/forum/configure':
      return t('This is where you can configure system-wide options for how your forums act and display.');
    case 'node/add#forum':
      return t('Create a new topic for discussion in the forums.');
  }
}