function _menu_block_help in Menu Block 5.2

Same name and namespace in other branches

1. 6.2 menu_block.pages.inc \_menu_block_help()
2. 7.3 menu_block.pages.inc \_menu_block_help()
3. 7.2 menu_block.pages.inc \_menu_block_help()

Implements hook_help().

1 call to _menu_block_help()

menu_block_help in ./menu_block.module

Implements hook_help().

File

./menu_block.pages.inc, line 11

Provides infrequently used pages for menu_block.

Code

function _menu_block_help($section) {
  $output = '';
  switch ($section) {
    case 'admin/build/block':
      $output = '<p>' . t('Use the <a href="@url">add menu block page</a> to create a customizable menu block. You will then be able to configure your menu block before adding it.', array(
        '@url' => url('admin/build/block/add-menu-block'),
      )) . '</p>' . theme('more_help_link', url('admin/help/menu_block'));
      break;
    case 'admin/help#menu_block':
      $output = '<h3>' . t('Adding menu blocks') . '</h3>' . '<p>' . t('To add new menu blocks, use the "Add menu block" tab (or button) on the <a href="@url">administer blocks page</a>. You will then be able to configure your menu block before adding it.', array(
        '@url' => url('admin/build/block'),
      )) . '</p>' . '<h3>' . t('Configuring menu blocks') . '</h3>' . '<p>' . t('When adding or configuring a menu block, several configuration options are available:') . '</p>' . '<dl>' . '<dt><strong>' . t('Block title') . '</strong></dt>' . '<dd>' . t('For menu trees that start with the 1st level, the default block title will be the menu name. For menu trees that start with the 2nd level or deeper, the default block title will be the title for the parent menu item of the specified level.') . '<p>' . t('For example, if the active menu trail for the Navigation menu is: Administer › Site building › Menus › Primary links, then a menu block configured to start with the 1st level of the Navigation will display a block title of “Navigation”. And a menu block configured to start with the 3rd level of the Navigation menu will display a block title of “Site building”.') . '</p></dd>' . '<dt><strong>' . t('Menu') . '</strong></dt>' . '<dd>' . t('The tree of links will be taken from this menu.') . '</dd>' . '<dt><strong>' . t('Starting level of menu tree') . '</strong></dt>' . '<dd>' . t('Blocks that start with the 1st level will always be visible. Blocks that start with the 2nd level or deeper will only be visible when the trail to the active menu item is in the block’s tree.') . '</dd>' . '<dt><strong>' . t('Maximum depth of menu tree') . '</strong></dt>' . '<dd>' . t('From the starting level, specify the maximum depth of the tree. Blocks with a maximum dpeth of 1 will just be a single un-nested list of links with none of those links’ children displayed.') . '</dd>' . '<dt><strong>' . t('Expand all children') . '</strong></dt>' . '<dd>' . t('All sub-menus of this menu will be expanded.') . '</dd>' . '</dl>' . '<h3>' . t('Styling menu blocks') . '</h3>' . '<p>' . t('Themers should look at the myriad of classes added to the %div, %li and %a elements.', array(
        '%div' => '<div>',
        '%li' => '<li>',
        '%a' => '<a>',
      )) . '</p>' . '<h3>' . t('Menu block API') . '</h3>' . '<p>' . t('Developers can use the API of this module to create their own menu trees outside the confines of blocks. All of the publicly available API functions are documented in the menu_block.module file.') . '</p>';
      break;
  }
  return $output;
}