You are here

README.txt in Frequently Asked Questions 5.2

Same filename and directory in other branches
  1. 8 README.txt
  2. 5 README.txt
  3. 6 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
    - FAQ nodes not being created


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/access.
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
---------------------------------------------------
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.

FAQ nodes not being created
---------------------------
If using MySQL 5.0.* with STRICT_ALL_TABLES mode, then you may get errors about
the question text being too long to be inserted into the node and node_revisions
tables. The solution is to either not use the strict mode, or add the following
4 triggers:

CREATE TRIGGER node_shrtn_ttl_ins BEFORE INSERT ON node FOR EACH ROW SET NEW.title = SUBSTR(NEW.title,1,128);
CREATE TRIGGER node_shrtn_ttl_upd BEFORE UPDATE ON node FOR EACH ROW SET NEW.title = SUBSTR(NEW.title,1,128);
CREATE TRIGGER node_rev_shrtn_ttl_ins BEFORE INSERT ON node_revisions FOR EACH ROW SET NEW.title = SUBSTR(NEW.title,1,128);
CREATE TRIGGER node_rev_shrtn_ttl_upd BEFORE UPDATE ON node_revisions FOR EACH ROW SET NEW.title = SUBSTR(NEW.title,1,128);

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ----------------------
  3. * Introduction
  4. * Installation
  5. * Configuration
  6. * Known Issues
  7. - No FAQs appear after module upgrade
  8. -

    tags appear in FAQ question text

  9. - Clicking on category links takes user to front page
  10. - FAQ nodes not being created
  11. INTRODUCTION
  12. ------------
  13. Maintainer: Stella Power (http://drupal.org/user/66894)
  14. Documentation: http://drupal.org/node/129209
  15. The Frequently Asked Questions (faq) module allows users with the 'administer
  16. faq' permission to create question and answer pairs which they want displayed on
  17. the 'faq' page. The 'faq' page is automatically generated from the FAQ nodes
  18. configured and the layout of this page can be modified on the settings page.
  19. Users will need the 'view faq' permission to view the 'faq' page.
  20. There are 2 blocks included in this module, one shows a list of FAQ categories
  21. while the other can show a configurable number of recent FAQs added.
  22. Note the function theme_faq_highlights(), which shows the last X recently
  23. created FAQs, used by one of the blocks, can also be called in a php-filtered
  24. node if desired.
  25. INSTALLATION
  26. ------------
  27. 1. Copy faq folder to modules directory.
  28. 2. At admin/build/modules enable the faq module.
  29. 3. Enable permissions at admin/user/access.
  30. 4. Configure the module at admin/settings/faq.
  31. UPGRADE NOTICE
  32. ---------------
  33. When using categorized FAQ nodes, the disabling of the FAQ module causes the
  34. vocabulary to lose the association with the FAQ content type. This results in no
  35. FAQ nodes being displayed when you re-enable the FAQ module. Before opening an
  36. issue, please verify that this setting is still in place.
  37. CONFIGURATION
  38. -------------
  39. Once the module is activated, you can create your question and answer pairs by
  40. creating FAQ nodes (Create content >> FAQ). This allows you to edit the
  41. question and answer text. In addition, if the 'Taxonomy' module is enabled and
  42. there are some terms configured for the FAQ node type, it will also be possible
  43. to put the questions into different categories when editing.
  44. KNOWN ISSUES
  45. -------------
  46. No FAQs appear after module upgrade
  47. -----------------------------------
  48. When using categorized FAQ nodes, the disabling of the FAQ module causes the
  49. vocabulary to lose the association with the FAQ content type. This results in no
  50. FAQ nodes being displayed when you re-enable the FAQ module. Before opening an
  51. issue, please verify that this setting is still in place.
  52. tags appear in FAQ question text

  53. ------------------------------------
  54. When using WYSIWYG editors, such as TinyMCE and FCKeditor,

    and other HTML

  55. tags may appear in the displayed question text. This is because the faq title or
  56. question input box is a textarea and not a textfield, so the faq module can
  57. accommodate longer question texts. The p-tags come from the WYSIWYG editor used
  58. and not the FAQ module. This is because TinyMCE, and other WYSIWYG editors,
  59. attach themselves to all textareas on a given page. Details on how to prevent
  60. this can be found at http://drupal.org/node/294708
  61. Clicking on category links takes user to front page
  62. ---------------------------------------------------
  63. Instead of being taken to the categorized faq page, the front page is displayed
  64. when the user clicks on a faq category. This is something to do with the
  65. pathauto module and can be easily fixed by doing a bulk update of paths for the
  66. faq vocabulary.
  67. FAQ nodes not being created
  68. ---------------------------
  69. If using MySQL 5.0.* with STRICT_ALL_TABLES mode, then you may get errors about
  70. the question text being too long to be inserted into the node and node_revisions
  71. tables. The solution is to either not use the strict mode, or add the following
  72. 4 triggers:
  73. CREATE TRIGGER node_shrtn_ttl_ins BEFORE INSERT ON node FOR EACH ROW SET NEW.title = SUBSTR(NEW.title,1,128);
  74. CREATE TRIGGER node_shrtn_ttl_upd BEFORE UPDATE ON node FOR EACH ROW SET NEW.title = SUBSTR(NEW.title,1,128);
  75. CREATE TRIGGER node_rev_shrtn_ttl_ins BEFORE INSERT ON node_revisions FOR EACH ROW SET NEW.title = SUBSTR(NEW.title,1,128);
  76. CREATE TRIGGER node_rev_shrtn_ttl_upd BEFORE UPDATE ON node_revisions FOR EACH ROW SET NEW.title = SUBSTR(NEW.title,1,128);