function filter_help in Drupal 6

Same name and namespace in other branches

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

Implementation of hook_help().

File

modules/filter/filter.module, line 19

Framework for handling filtering of content.

Code

function filter_help($path, $arg) {
  switch ($path) {
    case 'admin/help#filter':
      $output = '<p>' . t("The filter module allows administrators to configure text input formats for use on your site. An input format defines the HTML tags, codes, and other input allowed in both content and comments, and is a key feature in guarding against potentially damaging input from malicious users. Two input formats included by default are <em>Filtered HTML</em> (which allows only an administrator-approved subset of HTML tags) and <em>Full HTML</em> (which allows the full set of HTML tags). Additional input formats may be created by an administrator.") . '</p>';
      $output .= '<p>' . t('Each input format uses filters to manipulate text, and most input formats apply several different filters to text in a specific order. Each filter is designed for a specific purpose, and generally either adds, removes or transforms elements within user-entered text before it is displayed. A filter does not change the actual content of a post, but instead, modifies it temporarily before it is displayed. A filter may remove unapproved HTML tags, for instance, while another automatically adds HTML to make links referenced in text clickable.') . '</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.') . '</p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@filter">Filter module</a>.', array(
        '@filter' => 'http://drupal.org/handbook/modules/filter/',
      )) . '</p>';
      return $output;
    case 'admin/settings/filters':
      $output = '<p>' . t('<em>Input formats</em> define a way of processing user-supplied text in Drupal. Each input format uses filters to manipulate text, and most input formats apply several different filters to text, in a specific order. Each filter is designed to accomplish a specific purpose, and generally either removes elements from or adds elements to text before it is displayed. Users can choose between the available input formats when submitting content.') . '</p>';
      $output .= '<p>' . t('Use the list below to configure which input formats are available to which roles, as well as choose a default input format (used for imported content, for example). The default format is always available to users. All input formats are available to users in a role with the "administer filters" permission.') . '</p>';
      return $output;
    case 'admin/settings/filters/%':
      return '<p>' . t('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. If you notice some filters are causing conflicts in the output, you can <a href="@rearrange">rearrange them</a>.', array(
        '@rearrange' => url('admin/settings/filters/' . $arg[3] . '/order'),
      )) . '</p>';
    case 'admin/settings/filters/%/configure':
      return '<p>' . t('If you cannot find the settings for a certain filter, make sure you have enabled it on the <a href="@url">view tab</a> first.', array(
        '@url' => url('admin/settings/filters/' . $arg[3]),
      )) . '</p>';
    case 'admin/settings/filters/%/order':
      $output = '<p>' . t('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 to a clickable link. When this happens, rearrange the order of the filters.') . '</p>';
      $output .= '<p>' . t("Filters are executed from top-to-bottom. To change the order of the filters, modify the values in the <em>Weight</em> column or grab a drag-and-drop handle under the <em>Name</em> column and drag filters to new locations in the list. (Grab a handle by clicking and holding the mouse while hovering over a handle icon.) Remember that your changes will not be saved until you click the <em>Save configuration</em> button at the bottom of the page.") . '</p>';
      return $output;
  }
}