README.txt 3.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. CONTENTS OF THIS FILE
  2. ----------------------
  3. * Introduction
  4. * Installation
  5. * Configuration
  6. * Known Issues
  7. - No FAQs appear after module upgrade
  8. - <p> tags appear in FAQ question text
  9. - Clicking on category links takes user to front page
  10. INTRODUCTION
  11. ------------
  12. Maintainer: Stella Power (http://drupal.org/user/66894)
  13. Documentation: http://drupal.org/node/129209
  14. The Frequently Asked Questions (faq) module allows users with the 'administer
  15. faq' permission to create question and answer pairs which they want displayed on
  16. the 'faq-page' page. The 'faq-page' page is automatically generated from the
  17. FAQ nodes configured and the layout of this page can be modified on the settings
  18. page. Users will need the 'view faq page' permission to view the 'faq-page'
  19. page.
  20. An alternative to the built-in 'faq-page' is to use one of the example Views
  21. layouts provided which you can easily customise to your needs using the Views
  22. UI. Note, the configuration settings for the module do not apply to the Views
  23. layouts.
  24. INSTALLATION
  25. ------------
  26. 1. Copy faq folder to modules directory.
  27. 2. At admin/modules enable the faq module.
  28. 3. Enable permissions at admin/people/permissions.
  29. 4. Configure the module at admin/config/content/faq - not used for Views
  30. layouts.
  31. 5. You can use the default faq page at "faq-page" or enable one of the page
  32. layouts in the example Views. For the Views pages you can change the url if
  33. needed, but if you wish to change the url for the built-in page (faq-page)
  34. you need to create a url alias at admin/config/search/path.
  35. UPGRADE NOTICE
  36. ---------------
  37. When using categorized FAQ nodes, the disabling of the FAQ module causes the
  38. vocabulary to lose the association with the FAQ content type. This results in no
  39. FAQ nodes being displayed when you re-enable the FAQ module. Before opening an
  40. issue, please verify that this setting is still in place.
  41. CONFIGURATION
  42. -------------
  43. Once the module is activated, you can create your question and answer pairs by
  44. creating FAQ nodes (Create content >> FAQ). This allows you to edit the
  45. question and answer text. In addition, if the 'Taxonomy' module is enabled and
  46. there are some terms configured for the FAQ node type, it will also be possible
  47. to put the questions into different categories when editing.
  48. KNOWN ISSUES
  49. -------------
  50. No FAQs appear after module upgrade
  51. -----------------------------------
  52. When using categorized FAQ nodes, the disabling of the FAQ module causes the
  53. vocabulary to lose the association with the FAQ content type. This results in no
  54. FAQ nodes being displayed when you re-enable the FAQ module. Before opening an
  55. issue, please verify that this setting is still in place.
  56. <p> tags appear in FAQ question text
  57. ------------------------------------
  58. When using WYSIWYG editors, such as TinyMCE and FCKeditor, <p> and other HTML
  59. tags may appear in the displayed question text. This is because the faq title or
  60. question input box is a textarea and not a textfield, so the faq module can
  61. accommodate longer question texts. The p-tags come from the WYSIWYG editor used
  62. and not the FAQ module. This is because TinyMCE, and other WYSIWYG editors,
  63. attach themselves to all textareas on a given page. Details on how to prevent
  64. this can be found at http://drupal.org/node/294708
  65. Clicking on category links takes user to front page
  66. ---------------------------------------------------
  67. Reported for Drupal 5, unconfirmed for Drupal 6.
  68. Instead of being taken to the categorized faq page, the front page is displayed
  69. when the user clicks on a faq category. This is something to do with the
  70. pathauto module and can be easily fixed by doing a bulk update of paths for the
  71. faq vocabulary.