You are here

function image_help in Image 6

Same name and namespace in other branches
  1. 5.2 image.module \image_help()
  2. 5 image.module \image_help()

Implementation of hook_help().

File

./image.module, line 14

Code

function image_help($path, $arg) {
  switch ($path) {
    case 'admin/help#image':
      $output = '<p>' . t('The Image module is used to create and administer images for your site. Each image is stored as a post, with thumbnails of the original generated automatically. There are two default derivative image sizes, "thumbnail" and "preview". The "thumbnail" size is shown as preview image in posts and when browsing image galleries. The "preview" size is the default size when viewing an image node page.') . '</p>';
      $output .= '<p>' . t('The settings page for Image module allows the image directory and the image sizes to be configured.') . '</p>';
      $output .= '<p>' . t('Image module ships with contributed modules. Their settings can be accessed from the image settings page.') . '</p>';
      $output .= '<ul>';
      $output .= '<li>' . t('Image attach is used to add an existing or new image to a node. The selected image will show up in a predefined spot on the selected node.') . '</li>';
      $output .= '<li>' . t('Image gallery is used to organize and display images in galleries. The list tab allows users to edit existing image gallery names, descriptions, parents and relative position, known as a weight. The add galleries tab allows you to create a new image gallery defining name, description, parent and weight. If the <a href="@views-url">Views module</a> is installed, then the Image gallery module settings are mostly replaced by settings of the view.', array(
        '@views-url' => 'http://drupal.org/project/views',
      )) . '</li>';
      $output .= '<li>' . t('Image import is used to import batches of images. The administration page lets you define the folder from which images will be imported.') . '</li>';
      $output .= '<li>' . t('The separate <a href="@img-assist-url">Image assist module</a> can be installed to upload and insert images into posts.', array(
        '@img-assist-url' => 'http://drupal.org/project/img_assist',
      )) . '</li>';
      $output .= '</ul>';
      $output .= '<p>' . t('You can:') . '</p>';
      $output .= '<ul>';
      $output .= '<li>' . t('Configure image sizes and file directories at <a href="@image-settings-url">Administer &raquo; Site configuration &raquo; Image</a>.', array(
        '@image-settings-url' => url('admin/settings/image'),
      )) . '</li>';
      $output .= '</ul>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@image-url">Image module</a>.', array(
        '@image-url' => 'http://drupal.org/handbook/modules/image',
      )) . '</p>';
      return $output;
  }
}