function print_help in Printer, email and PDF versions 7.2

Same name and namespace in other branches

1. 5.4 print.module \print_help()
2. 5.2 print.module \print_help()
3. 5.3 print.module \print_help()
4. 6 print.module \print_help()
5. 7 print.module \print_help()
6. 5.x print.module \print_help()

Implements hook_help().

File

./print.module, line 233

Displays Printer-friendly versions of Drupal pages.

Code

function print_help($path, $arg) {
  $ret = '';
  switch ($path) {
    case 'admin/help#print':
      $ret = t("<p>This module allows you to generate printer-friendly versions of any node:</p>\n<ul>\n<li>Web page printer-friendly version at www.example.com/print/nid</li>\n<li>PDF version at www.example.com/printpdf/nid</li>\n<li>Send by-email at www.example.com/printmail/nid</li>\n</ul>\n<p>where nid is the node id of content to render.</p>\n<p>A link is inserted in each node (configurable in the content type settings), that opens a version of the page with no sidebars, search boxes, navigation pages, etc.</p>\n<h3>Configuration settings</h3>\n<p>There are several settings that can be configured in the following places:</p>\n<ul>\n<li>Administration &gt; Modules (admin/modules)<br>Enable or disable the module and submodules. (default: disabled)</li>\n<li>Administration &gt; People &gt; Permissions (admin/people/permissions)<br>\nPermissions to access print friendly content and administer print module.</li>\n<li>Administration &gt; Structure &gt; Content types (admin/structure/types)<br>\nFor each content type enable or disable the PF link.<br>\nAlso enable or disable the PF link for individual comments (default: disabled).</li>\n</ul>\n<h3>Module Specific Configuration settings</h3>\n<ul>\n<li>Administration &gt; Configuration &gt; User interface &gt; Printer, email and PDF versions (admin/config/user-interface/print)<br>\nFor Web page options.</li>\n<li>Administration &gt; Configuration &gt; User interface &gt; Print &gt; Settings (admin/config/user-interface/print/common)<br>\nFor Common settings.</li>\n</ul>\n<p>When the Printer-friendly pages UI (print_ui) module is enabled additional settings for printer friendly links will be available.</p>\n<ul>\n<li>Administration &gt; Configuration &gt; User interface &gt; Print &gt; Links (admin/config/user-interface/print/ui)<br>\nFor Link options.<br>This includes options for link style and position.</li>\n</ul>\n<p>The link options also include an option to use the URL alias instead of node ID. It may be important to check this option to create printer friendly pages of panel layouts and other enhanced layouts instead of simply the node itself.</p>\n<h3>Custom template files</h3>\n<p>To modify the template of printer friendly pages, simply edit the print.tpl.php or the css/print.css files.</p>\n<p>It is possible to set per-content-type and/or theme-specific templates which are searched for in the following order:</p>\n<ol>\n<li>print--[format]--node--[type].tpl.php in the theme directory</li>\n<li>print--[format].tpl.php in the theme directory</li>\n<li>print--node--[type].tpl.php in the theme directory</li>\n<li>print.tpl.php in the theme directory</li>\n<li>print.tpl.php in the module directory (supplied by the module)</li>\n</ol>\n<p>format is either html, mail or pdf, and type is Drupal's node content type e.g. article, page etc.</p>\n<p>For more information, consult the !documentlink at www.drupal.org and see the README.txt and INSTALL.txt files.</p>", array(
        '!documentlink' => l(t('Print module documentation'), 'http://drupal.org/node/190171'),
      ));
  }
  return $ret;
}