function intlinks_help in Internal Links 6

Same name and namespace in other branches

1. 8 intlinks.module \intlinks_help()
2. 7.2 intlinks.module \intlinks_help()
3. 7 intlinks.module \intlinks_help()

Implements hook_help().

File

./intlinks.module, line 34

Input filters which rewrite internal links and/or unlink unpublished nodes.

Code

function intlinks_help($path, $arg) {
  switch ($path) {
    case 'admin/help#intlinks':
      $output = '<p>' . t('To use the Internal links filter, simply enable the Internal links title filter for one or more of your <a href="@text_formats">input formats</a>.', array(
        '@text_formats' => url('admin/settings/filters/list'),
      )) . '</p><p>';
      $output .= t('If you like, you can also enable the Internal links "hide bad" filter, which hides internal links to pages not yet published or to bad internal paths, rather than displaying links which would simply yield a "page not found" error.') . '</p><p>';
      $output .= t('If you enable both filters, be sure to move the action of the "hide bad" filter before the "title" filter. There would not be much use in wasting queries on getting titles and re-writing links to unpublished content, only to remove the links with the "hide bad" filter, before display output.') . '</p><p>';
      $output .= t('Note: For best performance, sites which uses these filters should cache the output. Use of these filters on each page load will add significant additional load in terms of database queries and processing. Caching output is especially recommended for high-volume sites with a lot of cross-linking between articles.') . '</p>';
      return $output;
  }
}