function glossify_help in Glossify 7.4

Same name and namespace in other branches

1. 8 glossify.module \glossify_help()

Implements hook_help().

File

./glossify.module, line 11

Glossify module.

Code

function glossify_help($path, $arg) {
  switch ($path) {
    case 'admin/help#glossify':
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Glossify module provides filters that scan and parse content and replace terms in the text with links to their pages. It consists of 2 filters:') . '</p>';
      $items = array();
      $items[] = array(
        'data' => t('Glossify with taxonomy'),
        'children' => array(
          t('links taxonomy terms appearing in content to their taxonomy term page.'),
          t('select which taxonomy vocabularies to use as the source for the terms.'),
          t('indicate whether or not the match is case sensitive.'),
          t('indicate whether or not every match should be linked or just the first occurrence.'),
          t('display the term definition as a tooltip while hovering the glossified link.'),
        ),
      );
      $items[] = array(
        'data' => t('Glossify with content'),
        'children' => array(
          t('links node titles of content appearing in other content to their node page'),
          t('select which content types to use as the source for the terms.'),
          t('indicate whether or not matching is case sensitive.'),
          t('indicate whether or not every match should be linked or just the first occurrence.'),
          t('display the text from a selected field on the linked node as a tooltip while hovering the glossified link.'),
        ),
      );
      $output .= theme('item_list', array(
        'items' => $items,
        'type' => 'ul',
      ));
      $items = array();
      $items[] = t('Navigate to the <a href="!url">Text formats</a> configuration page. Click "configure" next to the text format you upon which you want to enable the Glossify filter.', array(
        '!url' => '/admin/config/content/formats',
      ));
      $items[] = t('Check the box for "Glossify with taxonomy" and/or "Glossify with content" under the list of filters in the "Enabled filters" section.');
      $items[] = t('Check the boxes for the desired taxonomy vocabularies and/or content types you wish to use the source of terms to link.');
      $items[] = t('Set any other options as desired.');
      $output .= '<h3>' . t('Configuration/Usage') . '</h3>';
      $output .= theme('item_list', array(
        'items' => $items,
        'type' => 'ol',
      ));
      $output .= '<h3>' . t('Theming') . '</h3>';
      $output .= '<p>' . t('The module provides a theme function (theme_glossify_links), some basic css, and 2 icons to format the links. Override and customize as desired. See <a href="!url">Beginners guide to overriding themable output</a> for more detailed instructions.', array(
        '!url' => 'https://drupal.org/node/457740',
      )) . '</p>';
      return $output;
  }
}