You are here

Home » API reference » Frequently Asked Questions 6

README.txt in Frequently Asked Questions 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 5.2 README.txt
  3. 5 README.txt
  4. 7.2 README.txt
  5. 7 README.txt
CONTENTS OF THIS FILE
----------------------

  * Introduction
  * Installation
  * Configuration
  * Known Issues
    - No FAQs appear after module upgrade
    - <p> tags appear in FAQ question text
    - Clicking on category links takes user to front page


INTRODUCTION
------------
Maintainer: Stella Power (http://drupal.org/user/66894)

Documentation: http://drupal.org/node/129209

The Frequently Asked Questions (faq) module allows users with the 'administer
faq' permission to create question and answer pairs which they want 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 to view the 'faq' page.

There are 2 blocks included in this module, one shows a list of FAQ categories
while the other can show a configurable number of recent FAQs added.

Note the function theme_faq_highlights(), which shows the last X recently
created FAQs, used by one of the blocks, can also be called in a php-filtered
node if desired.


INSTALLATION
------------
1. Copy faq folder to modules directory.
2. At admin/build/modules enable the faq module.
3. Enable permissions at admin/user/permissions.
4. Configure the module at admin/settings/faq.


UPGRADE NOTICE
---------------
When using categorized FAQ nodes, the disabling of the FAQ module causes the
vocabulary to lose the association with the FAQ content type. This results in no
FAQ nodes being displayed when you re-enable the FAQ module. Before opening an
issue, please verify that this setting is still in place.


CONFIGURATION
-------------
Once the module is activated, you can create your question and answer pairs by
creating FAQ nodes (Create content >> FAQ).  This allows you to edit the
question and answer text.  In addition, 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.


KNOWN ISSUES
-------------
No FAQs appear after module upgrade
-----------------------------------
When using categorized FAQ nodes, the disabling of the FAQ module causes the
vocabulary to lose the association with the FAQ content type. This results in no
FAQ nodes being displayed when you re-enable the FAQ module. Before opening an
issue, please verify that this setting is still in place.

<p> tags appear in FAQ question text
------------------------------------
When using WYSIWYG editors, such as TinyMCE and FCKeditor, <p> and other HTML
tags may appear in the displayed question text. This is because the faq title or
question input box is a textarea and not a textfield, so the faq module can
accommodate longer question texts. The p-tags come from the WYSIWYG editor used
and not the FAQ module. This is because TinyMCE, and other WYSIWYG editors,
attach themselves to all textareas on a given page.  Details on how to prevent
this can be found at http://drupal.org/node/294708

Clicking on category links takes user to front page
---------------------------------------------------
Reported for Drupal 5, unconfirmed for Drupal 6.
Instead of being taken to the categorized faq page, the front page is displayed
when the user clicks on a faq category. This is something to do with the
pathauto module and can be easily fixed by doing a bulk update of paths for the
faq vocabulary.

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ----------------------

  3. 

  4.   * Introduction

  5.   * Installation

  6.   * Configuration

  7.   * Known Issues

  8.     - No FAQs appear after module upgrade

  9.     - 
     tags appear in FAQ question text

  10.     - Clicking on category links takes user to front page

  11. 

  12. 

  13. INTRODUCTION

  14. ------------

  15. Maintainer: Stella Power (http://drupal.org/user/66894)

  16. 

  17. Documentation: http://drupal.org/node/129209

  18. 

  19. The Frequently Asked Questions (faq) module allows users with the 'administer

  20. faq' permission to create question and answer pairs which they want displayed on

  21. the 'faq' page.  The 'faq' page is automatically generated from the FAQ nodes

  22. configured and the layout of this page can be modified on the settings page.

  23. Users will need the 'view faq' permission to view the 'faq' page.

  24. 

  25. There are 2 blocks included in this module, one shows a list of FAQ categories

  26. while the other can show a configurable number of recent FAQs added.

  27. 

  28. Note the function theme_faq_highlights(), which shows the last X recently

  29. created FAQs, used by one of the blocks, can also be called in a php-filtered

  30. node if desired.

  31. 

  32. 

  33. INSTALLATION

  34. ------------

  35. 1. Copy faq folder to modules directory.

  36. 2. At admin/build/modules enable the faq module.

  37. 3. Enable permissions at admin/user/permissions.

  38. 4. Configure the module at admin/settings/faq.

  39. 

  40. 

  41. UPGRADE NOTICE

  42. ---------------

  43. When using categorized FAQ nodes, the disabling of the FAQ module causes the

  44. vocabulary to lose the association with the FAQ content type. This results in no

  45. FAQ nodes being displayed when you re-enable the FAQ module. Before opening an

  46. issue, please verify that this setting is still in place.

  47. 

  48. 

  49. CONFIGURATION

  50. -------------

  51. Once the module is activated, you can create your question and answer pairs by

  52. creating FAQ nodes (Create content >> FAQ).  This allows you to edit the

  53. question and answer text.  In addition, if the 'Taxonomy' module is enabled and

  54. there are some terms configured for the FAQ node type, it will also be possible

  55. to put the questions into different categories when editing.

  56. 

  57. 

  58. KNOWN ISSUES

  59. -------------

  60. No FAQs appear after module upgrade

  61. -----------------------------------

  62. When using categorized FAQ nodes, the disabling of the FAQ module causes the

  63. vocabulary to lose the association with the FAQ content type. This results in no

  64. FAQ nodes being displayed when you re-enable the FAQ module. Before opening an

  65. issue, please verify that this setting is still in place.

  66. 

  67.  tags appear in FAQ question text

  68. ------------------------------------

  69. When using WYSIWYG editors, such as TinyMCE and FCKeditor, 
     and other HTML

  70. tags may appear in the displayed question text. This is because the faq title or

  71. question input box is a textarea and not a textfield, so the faq module can

  72. accommodate longer question texts. The p-tags come from the WYSIWYG editor used

  73. and not the FAQ module. This is because TinyMCE, and other WYSIWYG editors,

  74. attach themselves to all textareas on a given page.  Details on how to prevent

  75. this can be found at http://drupal.org/node/294708

  76. 

  77. Clicking on category links takes user to front page

  78. ---------------------------------------------------

  79. Reported for Drupal 5, unconfirmed for Drupal 6.

  80. Instead of being taken to the categorized faq page, the front page is displayed

  81. when the user clicks on a faq category. This is something to do with the

  82. pathauto module and can be easily fixed by doing a bulk update of paths for the

  83. faq vocabulary.

  84.