function simplify_help in Simplify 7.3

Same name and namespace in other branches

1. 7.2 simplify.module \simplify_help()

Implements hook_help().

File

./simplify.module, line 10

Simplifies the user interface by hiding particular fields.

Code

function simplify_help($path, $arg) {
  switch ($path) {
    case 'admin/help#simplify':
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t("The Simplify module allows particular fields to be hidden from the user interface. This helps to de-clutter forms and present a more user-friendly experience to content editors.") . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Field types') . '</dt>';
      $output .= '<dd>' . t("Different types of fields can be hidden with the Simplify module. Currently supported field types include:");
      $output .= theme('item_list', array(
        'items' => array(
          t('Nodes (e.g., publishing options)'),
          t('Users (e.g., contact settings)'),
          t('Comments (e.g., text format selection)'),
          t('Taxonomy (e.g., relations)'),
          t('Blocks (e.g., text format selection)'),
        ),
        'type' => 'ul',
      )) . '</dd>';
      $output .= '<dt>' . t('Global configuration') . '</dt>';
      $output .= '<dd>' . t("Fields can be hidden globally on the <a href=\"@global\">Simplify administration page</a>. Globally hidden fields are hidden from all forms of that field type throughout the site. For example, if the Publishing Options field is selected on the global configuration page, that field will be hidden from <em>all</em> node forms (articles, pages, etc.).", array(
        '@global' => url('admin/config/user-interface/simplify'),
      )) . '</dd>';
      $output .= '<dt>' . t('Type-specific configuration') . '</dt>';
      $output .= '<dd>' . t("Fields can also be hidden more specifically based on their field type:");
      $output .= theme('item_list', array(
        'items' => array(
          t("Node fields can be hidden per <a href=\"@type\">content type</a>", array(
            '@type' => url('admin/structure/types'),
          )),
          t("Comment fields can be hidden per <a href=\"@type\">content type</a>", array(
            '@type' => url('admin/structure/types'),
          )),
          t("Taxonomy fields can be hidden per <a href=\"@type\">vocabulary</a>", array(
            '@type' => url('admin/structure/taxonomy'),
          )),
        ),
        'type' => 'ul',
      ));
      $output .= t("For example, if the Menu Settings field is selected for the Article content type, that field will be hidden from <em>Article</em> node forms, but will remain visible for <em>Page</em> node forms.");
      $output .= '<br />' . t("Note that if a field is selected on the global configuration page, that field will be disabled on the type-specific configuration page.") . '</dd>';
      $output .= '<dt>' . t('Example use case') . '</dt>';
      $output .= '<dd>' . t("The global and type-specific configurations can be used together. Say you weren't using node revisions at all on your site; you would select the Revision Information field on the global configuration page so that it was hidden from all node forms (articles, pages, etc.). Say that you then wanted to allow content editors to create menu items for Page nodes, but not for Article nodes; you would select the Menu Settings field for just the Article content type (not for the Page content type nor on the global configuration page) so that it was hidden from just the Article node forms.") . '</dd>';
      $output .= '</dl>';
      return $output;
  }
}