You are here

function media_crop_help in Media crop 7

Implements hook_help().

File

./media_crop.module, line 16
Media crop primary module file.

Code

function media_crop_help($path, $args) {
  switch ($path) {
    case "admin/help#media_crop":
      $output = '';
      $output .= '<h3>' . t('About', array(), array(
        'context' => 'Media crop',
      )) . '</h3>';
      $output .= '<p>' . t("The Media Crop module allows users to crop, rotate, and scale images added with the WYSIWYG editor, CKeditor.  Crop, rotate, and scale actions are performed on copies (instances) of the source image, so the source image located in the media library is not affected.", array(), array(
        'context' => 'Media crop',
      )) . '</p>';
      $output .= '<p>' . t("This module provides control to manually override the following effects:", array(), array(
        'context' => 'Media crop',
      ));
      $output .= '<ul>';
      $output .= '<li>' . t("<strong>Positioning</strong> and <strong>dimensions</strong> of the image style's crop effect.", array(), array(
        'context' => 'Media crop',
      )) . '</li>';
      $output .= '<li>' . t("<strong>Degree</strong> of the image style's rotation effect.", array(), array(
        'context' => 'Media crop',
      )) . '</li>';
      $output .= '</ul></p>';
      $output .= '<p>' . t("If an image style also includes crop and rotation effects, users may experience unexpected results. For example, the image style’s rotation effect will be applied over any modifications performed real time by the <insert name> module.  Generally, an image style works transparently to end users when the image style effects do not change image dimensions, such as desaturation.", array(), array(
        'context' => 'Media crop',
      )) . '</p>';
      $output .= '<p>' . t("If crop and rotation are needed at the image-style level, the following effects result in predictable outcomes:", array(), array(
        'context' => 'Media crop',
      ));
      $output .= '<ul>';
      $output .= '<li>' . t("A <strong>single rotation</strong> (90, 180, 270 degrees in either direction) <em>OR</em>", array(), array(
        'context' => 'Media crop',
      )) . '</li>';
      $output .= '<li>' . t("A <strong>single</strong> crop <em>OR</em>", array(), array(
        'context' => 'Media crop',
      )) . '</li>';
      $output .= '<li>' . t("A <strong>single rotation</strong> followed by a single crop", array(), array(
        'context' => 'Media crop',
      )) . '</li>';
      $output .= '</ul></p>';
      return $output;
      break;
  }
}