function image_style_warmer_help in Image Style Warmer 8

Implements hook_help().

File

./image_style_warmer.module, line 16

ISW Module file creates image styles on image upload and via queue.

Code

function image_style_warmer_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.image_style_warmer':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Image Style Warmer module provides options to create image styles during upload or via queue worker. So configured image derivates already exists when they are requested.. For more information, see the <a href=":image_style_warmer">online documentation for the Image Style Warmer module</a>.', [
        ':image_style_warmer' => 'https://www.drupal.org/documentation/modules/image_style_warmer',
      ]) . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Configuration of Image Style Warmer module') . '</dt>';
      $output .= '<dd>' . t('Go to <em>Manage > Configuration > Development > Performance > Image Style Warmer</em>.') . '<br>';
      $output .= t('Select image styles which should be created during upload.') . '<br>';
      $output .= t('Select image style which should be created via queue worker.') . '<br>';
      $output .= t('Save Image Style Warmer settings.') . '</dd>';
      $output .= '<dt>' . t('Image Style Warmer queue') . '</dt>';
      $output .= '<dd>' . t('Enable queue worker via <em>drush queue-run image_style_warmer_pregenerator</em>.') . '</dd>';
      $output .= '</dl>';
      return $output;
  }
}