function tac_lite_help in Taxonomy Access Control Lite 5

Same name and namespace in other branches

1. 8 tac_lite.module \tac_lite_help()
2. 6 tac_lite.module \tac_lite_help()
3. 7 tac_lite.module \tac_lite_help()

Implementation of hook_help

File

./tac_lite.module, line 12

Control access to site content based on taxonomy, roles and users.

Code

function tac_lite_help($section) {
  switch ($section) {
    case 'admin/help#tac_lite':
      $output .= '<p>' . t('This module allows you to restrict access to site content.  It uses a simple scheme based on Taxonomy, Users and Roles.  It uses the node_access table and other features built into Drupal to hide content from unauthorized users.') . "</p>\n";
      $output .= '<p>' . t('While this module has been designed to be as simple as possible to use, there are several steps required to set it up.') . "</p>\n";
      $output .= "<ol>\n";
      $output .= '<li>' . t('Define one or more vocabularies whose terms will control which users have access.  For example, you could define a vocabulary called \'Privacy\' with terms \'Public\' and \'Private\'.') . "</li>\n";
      $output .= '<li>' . t('Tell this module which vocabulary or vocabularies control privacy. (!link)', array(
        '!link' => l(t('administer -> access control -> tac_lite'), 'admin/user/tac_lite'),
      )) . "</li>\n";
      $output .= '<li>' . t('Grant access to individual users.  (See the tac_lite tab under user -> edit.)') . "</li>\n";
      $output .= '<li>' . t('Finally, if your site contains content, you will need to re-save all nodes.  This ensures that Drupal\'s node_access table is up-to-date.  Otherwise, content submitted before this module was configured will be hidden.') . "</li>\n";
      $output .= "</ol>\n";
      $output .= '<p>' . t('Currently, this module works with view grants only (no update or delete grants).') . "</p>\n";
      return $output;
      break;
  }
}