You are here

README.txt in Frequently Asked Questions 7.2

Same filename and directory in other branches
  1. 8 README.txt
  2. 5.2 README.txt
  3. 5 README.txt
  4. 6 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)
Sudev Pradhan (https://drupal.org/user/701164)

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' page.  The 'faq-page' 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 page' permission to view the 'faq-page'
page.

An alternative to the built-in 'faq-page' is to use one of the example Views
layouts provided which you can easily customise to your needs using the Views
UI.  Note, the configuration settings for the module do not apply to the Views
layouts.


INSTALLATION
------------
1. Copy faq folder to modules directory.
2. At admin/modules enable the faq module.
3. Enable permissions at admin/people/permissions.
4. Configure the module at admin/config/content/faq - not used for Views
   layouts.
5. You can use the default faq page at "faq-page" or enable one of the page
   layouts in the example Views.  For the Views pages you can change the url if
   needed, but if you wish to change the url for the built-in page (faq-page)
   you need to create a url alias at admin/config/search/path.


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. * 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. INTRODUCTION
  11. ------------
  12. Maintainer: Stella Power (http://drupal.org/user/66894)
  13. Sudev Pradhan (https://drupal.org/user/701164)
  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' page. The 'faq-page' page is automatically generated from the
  18. FAQ nodes configured and the layout of this page can be modified on the settings
  19. page. Users will need the 'view faq page' permission to view the 'faq-page'
  20. page.
  21. An alternative to the built-in 'faq-page' is to use one of the example Views
  22. layouts provided which you can easily customise to your needs using the Views
  23. UI. Note, the configuration settings for the module do not apply to the Views
  24. layouts.
  25. INSTALLATION
  26. ------------
  27. 1. Copy faq folder to modules directory.
  28. 2. At admin/modules enable the faq module.
  29. 3. Enable permissions at admin/people/permissions.
  30. 4. Configure the module at admin/config/content/faq - not used for Views
  31. layouts.
  32. 5. You can use the default faq page at "faq-page" or enable one of the page
  33. layouts in the example Views. For the Views pages you can change the url if
  34. needed, but if you wish to change the url for the built-in page (faq-page)
  35. you need to create a url alias at admin/config/search/path.
  36. UPGRADE NOTICE
  37. ---------------
  38. When using categorized FAQ nodes, the disabling of the FAQ module causes the
  39. vocabulary to lose the association with the FAQ content type. This results in no
  40. FAQ nodes being displayed when you re-enable the FAQ module. Before opening an
  41. issue, please verify that this setting is still in place.
  42. CONFIGURATION
  43. -------------
  44. Once the module is activated, you can create your question and answer pairs by
  45. creating FAQ nodes (Create content >> FAQ). This allows you to edit the
  46. question and answer text. In addition, if the 'Taxonomy' module is enabled and
  47. there are some terms configured for the FAQ node type, it will also be possible
  48. to put the questions into different categories when editing.
  49. KNOWN ISSUES
  50. -------------
  51. No FAQs appear after module upgrade
  52. -----------------------------------
  53. When using categorized FAQ nodes, the disabling of the FAQ module causes the
  54. vocabulary to lose the association with the FAQ content type. This results in no
  55. FAQ nodes being displayed when you re-enable the FAQ module. Before opening an
  56. issue, please verify that this setting is still in place.
  57. tags appear in FAQ question text

  58. ------------------------------------
  59. When using WYSIWYG editors, such as TinyMCE and FCKeditor,

    and other HTML

  60. tags may appear in the displayed question text. This is because the faq title or
  61. question input box is a textarea and not a textfield, so the faq module can
  62. accommodate longer question texts. The p-tags come from the WYSIWYG editor used
  63. and not the FAQ module. This is because TinyMCE, and other WYSIWYG editors,
  64. attach themselves to all textareas on a given page. Details on how to prevent
  65. this can be found at http://drupal.org/node/294708
  66. Clicking on category links takes user to front page
  67. ---------------------------------------------------
  68. Reported for Drupal 5, unconfirmed for Drupal 6.
  69. Instead of being taken to the categorized faq page, the front page is displayed
  70. when the user clicks on a faq category. This is something to do with the
  71. pathauto module and can be easily fixed by doing a bulk update of paths for the
  72. faq vocabulary.