Same name and namespace in other branches
  1. 10 core/modules/contact/contact.module \contact_help()
  2. 4.6.x modules/contact.module \contact_help()
  3. 4.7.x modules/contact.module \contact_help()
  4. 5.x modules/contact/contact.module \contact_help()
  5. 7.x modules/contact/contact.module \contact_help()
  6. 8.9.x core/modules/contact/contact.module \contact_help()
  7. 9 core/modules/contact/contact.module \contact_help()

Implementation of hook_help().

File

modules/contact/contact.module, line 11
Enables the use of personal and site-wide contact forms.

Code

function contact_help($path, $arg) {
  switch ($path) {
    case 'admin/help#contact':
      $output = '<p>' . t('The contact module facilitates communication via e-mail, by allowing your site\'s visitors to contact one another (personal contact forms), and by providing a simple way to direct messages to a set of administrator-defined recipients (the <a href="@contact">contact page</a>). With either form, users specify a subject, write their message, and (optionally) have a copy of their message sent to their own e-mail address.', array(
        '@contact' => url('contact'),
      )) . '</p>';
      $output .= '<p>' . t("Personal contact forms allow users to be contacted via e-mail, while keeping recipient e-mail addresses private. Users may enable or disable their personal contact forms by editing their <em>My account</em> page. If enabled, a <em>Contact</em> tab leading to their personal contact form is available on their user profile. Site administrators have access to all personal contact forms (even if they have been disabled). The <em>Contact</em> tab is only visible when viewing another user's profile (users do not see their own <em>Contact</em> tab).") . '</p>';
      $output .= '<p>' . t('The <a href="@contact">contact page</a> provides a simple form for visitors to leave comments, feedback, or other requests. Messages are routed by selecting a category from a list of administrator-defined options; each category has its own set of e-mail recipients. Common categories for a business site include, for example, "Website feedback" (messages are forwarded to web site administrators) and "Product information" (messages are forwarded to members of the sales department). The actual e-mail addresses defined within a category are not displayed. Only users in roles with the <em>access site-wide contact form</em> permission may access the <a href="@contact">contact page</a>.', array(
        '@contact' => url('contact'),
      )) . '</p>';
      $output .= '<p>' . t('A link to your site\'s <a href="@contact">contact page</a> from the main <em>Navigation</em> menu is created, but is disabled by default. Create a similar link on another menu by adding a menu item pointing to the path "contact"', array(
        '@contact' => url('contact'),
      )) . '</p>';
      $output .= '<p>' . t('Customize the <a href="@contact">contact page</a> with additional information (like physical location, mailing address, and telephone number) using the <a href="@contact-settings">contact form settings page</a>. The <a href="@contact-settings">settings page</a> also provides configuration options for the maximum number of contact form submissions a user may perform per hour, and the default status of users\' personal contact forms.', array(
        '@contact-settings' => url('admin/build/contact/settings'),
        '@contact' => url('contact'),
      )) . '</p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@contact">Contact module</a>.', array(
        '@contact' => url('http://drupal.org/handbook/modules/contact/', array(
          'absolute' => TRUE,
        )),
      )) . '</p>';
      return $output;
    case 'admin/build/contact':
      $output = '<p>' . t('This page lets you set up <a href="@form">your site-wide contact form</a>. To do so, add one or more categories. You can associate different recipients with each category to route e-mails to different people. For example, you can route website feedback to the webmaster and direct product information requests to the sales department. On the <a href="@settings">settings page</a>, you can customize the information shown above the contact form. This can be useful to provide additional contact information such as your postal address and telephone number.', array(
        '@settings' => url('admin/build/contact/settings'),
        '@form' => url('contact'),
      )) . '</p>';
      if (!module_exists('menu')) {
        $menu_note = t('The menu item can be customized and configured only once the menu module has been <a href="@modules-page">enabled</a>.', array(
          '@modules-page' => url('admin/settings/modules'),
        ));
      }
      else {
        $menu_note = '';
      }
      $output .= '<p>' . t('The contact module also adds a <a href="@menu-settings">menu item</a> (disabled by default) to the navigation block.', array(
        '@menu-settings' => url('admin/build/menu'),
      )) . ' ' . $menu_note . '</p>';
      return $output;
  }
}