function book_access_help in Book access 5

Same name and namespace in other branches

1. 6 book_access.module \book_access_help()

Implements hook_help()

File

./book_access.module, line 18

Allows access control for Drupal book nodes.

Code

function book_access_help($section) {
  switch ($section) {
    case 'admin/content/book/access':
      return '<p>' . t('
        Configures the access control per books based on user roles. Settings
        affect all pages within the given book. If a page is moved into a
        different book, it will assume that book access control settings.</p>
        <p><em>Important:</em> If you are going to manage access control here,
        please disable the <q>edit book pages</q> and <q>edit own book pages</q>
        permissions in the <a href="@access-control">access control</a> page or
        else you may see unexpected behavior.</p>
        <p>These settings will have no effect for roles with <q>administer nodes</q>
        permission.</p>
        <p>For more information, see the <a href="@book-access-help">Book Access help</a> page.
      ' . '</p>', array(
        '@book-access-help' => url('admin/help/book_access'),
        '@access-control' => url('admin/user/access'),
      ));
      break;
    case 'admin/help#book_access':
      return '<p>' . t('
        Allows fine grained access control for books.</p>
        <p>Permissions enabled in the <a href="@access-control-settings">access control settings page</a> will
        override the <a href="@book-access-settings">book access settings</a>. So, for example, if you would like a role to be
        able to edit all book pages, regardless, enable <q>edit pages</q> in
        the access control settings page. However, if you would like to control edit
        permission on a per book basis, disable that permission in
        the access control settings page and configure the book access settings
        accordingly.
        <p>Certain access control modules can impact functionality of this
        module. Broad reaching modules such as <q>taxonomy access</q> and <q>content
        access</q> can override the values set in the <a href="@book-access-settings">book access settings</a> page.
        You must turn off all enabled access controls in such modules.
        ' . '</p>', array(
        '@book-access-settings' => url('admin/content/book/access'),
        '@access-control-settings' => url('admin/user/access'),
      ));
      break;
  }
}