function image_resize_filter_help in Image Resize Filter 7

Same name and namespace in other branches

1. 8 image_resize_filter.module \image_resize_filter_help()
2. 6 image_resize_filter.module \image_resize_filter_help()

Implements hook_help().

File

./image_resize_filter.module, line 16

After adding to a text format, this filter will parse the contents of submitted content and automatically scale image files to match the set dimensions of img tags.

Code

function image_resize_filter_help($path, $arg) {
  switch ($path) {
    case 'admin/help#image_resize_filter':
      $instructions = array(
        t('Visit the <a href="!url">Text formats</a> configuration page. Click "configure" next to the text format you want to enable the image resize filter on.', array(
          '!url' => 'admin/config/content/formats',
        )),
        t('Check the box for "Image resize filter" under the list of filters.'),
        t('<strong>Important</strong>: Re-order your enabled filters under "Filter processing order".') . '<p>' . t('If using the Image Resize Filter on the "Filtered HTML" text format, you <strong>must</strong> ensure A) that the &lt;img&gt; tag is in the list of allowed tags and B) The "Image resize filter" is run <strong>before</strong> the "HTML filter".') . '</p>' . '<p>' . t('If using the Image Resize Filter with BBCode or some other non-HTML filter, the "Image resize filter" must be run AFTER the BBCode filter.') . '</p>',
        t('Optional. Click the Image resize filter tab underneath "Filter settings" to set additional configuration for the the image resize filter.'),
      );
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The image resize filter module provides a <a href="!url">filter</a> that makes it easy to resize images, especially when combined with a WYSIWYG editor such as tinyMCE or FCKeditor. Users never have to worry about scaling image sizes again, just insert an image and set it\'s height and width properties in HTML and the image is resized on output. To use the image resize filter, follow these steps.', array(
        '!url' => url('admin/help/filter'),
      )) . '</p>';
      $output .= theme('item_list', array(
        'items' => $instructions,
        'type' => 'ol',
        'title' => t('Installation and use'),
      ));
      return $output;
  }
}