function filter_help in Drupal 4

Same name and namespace in other branches

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

Implementation of hook_help().

File

modules/filter.module, line 19

Framework for handling filtering of content.

Code

function filter_help($section) {
  switch ($section) {
    case 'admin/help#filter':
      $output = '<p>' . t('The filter module allows administrators to configure  text input formats for the site.  For example, an administrator may want a filter to strip out malicious HTML from user\'s comments.  Administrators may also want to make URLs linkable even if they are only entered in an unlinked format.') . '</p>';
      $output .= '<p>' . t('Users can choose between the available input formats when creating or editing content.  Administrators can configure which input formats are available to which user roles, as well as choose a default input format.  Administrators can also create new input formats.  Each input format can be configured to use a selection of filters.') . '</p>';
      $output .= t('<p>You can</p>
<ul>
<li>administer input format permissions and settings  at <a href="%admin-filters">administer &gt;&gt; input formats</a>.</li>
<li>configure the filters for each input format at <a href="%admin-filters">administer &gt;&gt; input formats &gt;&gt; configure</a>.</li>
</ul>
', array(
        '%admin-filters' => url('admin/filters'),
      ));
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="%filter">Filter page</a>.', array(
        '%filter' => 'http://drupal.org/handbook/modules/filter/',
      )) . '</p>';
      return $output;
    case 'admin/modules#description':
      return t('Handles the filtering of content in preparation for display.');
    case 'admin/filters':
      return t('
<p><em>Input formats</em> define a way of processing user-supplied text in Drupal. Every input format has its own settings of which <em>filters</em> to apply. Possible filters include stripping out malicious HTML and making URLs clickable.</p>
<p>Users can choose between the available input formats when submitting content.</p>
<p>Below you can configure which input formats are available to which roles, as well as choose a default input format (used for imported content, for example).</p>
<p>Note that (1) the default format is always available to all roles, and (2) all filter formats can always be used by roles with the "administer filters" permission even if they are not explicitly listed in the Roles column of this table.</p>');
    case 'admin/filters/' . arg(2):
      return t('
<p>Every <em>filter</em> performs one particular change on the user input, for example stripping out malicious HTML or making URLs clickable. Choose which filters you want to apply to text in this input format.</p>
<p>If you notice some filters are causing conflicts in the output, you can <a href="%rearrange">rearrange them</a>.</p>', array(
        '%rearrange' => check_url(url('admin/filters/' . arg(2) . '/order')),
      ));
    case 'admin/filters/' . arg(2) . '/configure':
      return t('
<p>If you cannot find the settings for a certain filter, make sure you\'ve enabled it on the <a href="%url">view tab</a> first.</p>', array(
        '%url' => check_url(url('admin/filters/' . arg(2))),
      ));
    case 'admin/filters/' . arg(2) . '/order':
      return t('
<p>Because of the flexible filtering system, you might encounter a situation where one filter prevents another from doing its job. For example: a word in an URL gets converted into a glossary term, before the URL can be converted in a clickable link. When this happens, you will need to rearrange the order in which filters get executed.</p>
<p>Filters are executed from top-to-bottom. You can use the weight column to rearrange them: heavier filters \'sink\' to the bottom.</p>');
  }
}