function faq_help in Frequently Asked Questions 5

Same name and namespace in other branches

1. 8 faq.module \faq_help()
2. 5.2 faq.module \faq_help()
3. 6 faq.module \faq_help()
4. 7.2 faq.module \faq_help()
5. 7 faq.module \faq_help()

Display help and module information

Parameters

section which section of the site we're displaying help:

Return value

help text for section

File

./faq.module, line 8

Code

function faq_help($section = '') {
  $output = '';
  switch ($section) {
    case "admin/help#faq":
      $output .= '<p>' . t("This module allows users with the 'administer faq' permission to create question and answer pairs which will be displayed on the 'faq' page.  The 'faq' page is automatically generated from the FAQ nodes configured and the layout of this page can be modified on the settings page.  Users will need the 'view faq' permission in order to view the 'faq' page.") . '</p>' . '<p>' . t("To create a question and answer, the user must create a 'FAQ' node (Create content >> FAQ).  This screen allows the user to edit the question and answer text.  If the 'Taxonomy' module is enabled and there are some terms configured for the FAQ node type, it will also be possible to put the questions into different categories when editing.") . '</p>' . '<p>' . t("The 'Frequently Asked Questions' settings configuration screen will allow users with 'administer faq' permissions to specify different layouts of the questions and answers.") . '</p>' . '<p>' . t("All users with 'view faq' permissions will be able to view the generated FAQ page at 'www.example.com/faq'.") . '</p>';
      return $output;
    case "admin/modules#description":
      return t("Allows the user to configure the layout of questions and answers on a FAQ page.");
    case "node/add#faq":
      return t("Add a question and answer to a FAQ list.");
  }
}