You are here

README.txt in AJAX Comments 6

Same filename and directory in other branches
  1. 5 README.txt
  2. 7 README.txt
Ajax Comments - http://drupal.org/project/ajax_comments

INSTALLATION
============

See Drupal module installation guidelines:
http://drupal.org/getting-started/install-contrib/modules

Prerequisite: This module requires comment_bonus_api. You must first install that module
from: http://drupal.org/project/comment_bonus_api

1. Unpack module to your /sites/all/modules directory.
2. Visit your module management page at /admin/build/modules. Enable Ajax
Comments. The comment_bonus_api module is also required.
3. Configure the module via /admin/settings/ajax_comments. At the very least
you will want to enable it for one or more of your content types.
4. For each content type you are enabling for Ajax Comments, visit the Content
Management admin page (/admin/content/node-type/mynodetype) and configure your
comment settings "Location of comment submission form" to "Display below post or comments". 


TROUBLESHOOTING
===============

1. If you have themed your comment output, make sure that everything is wrapped to the ".comment" class
in your "comment.tpl.php".

2. IMPORTANT: If you have the "Comment Notify" module installed, please also install
http://drupal.org/project/queue_mail to prevent server errors during comment submitting.

3. The module may conflict with Devel. It has been causing lags when a comment is submitting.

4. Try testing with Javascript Optimization disabled and see if it makes a
difference. (/admin/settings/performance)

5. If you are using the FCKEditor with the wysiwyg module, you should upgrade
to FCKEditor 2.x or higher. Anything less than 2.x will not work properly with
the module.

6. If you have having issues, first try the module with a clean Drupal install
with the default theme. As this is Javascript, it relies upon certain
assumptions in the theme files. For example, there have been reports of issues
where custom themes remove <h2> or <h3> tags which cause the module to become
inoperable. 

7. If you are using a 3rd party editor such as Wysiwug or CKeditor, try
disabling them and first troubleshooting with just the textareas. That will
help to narrow down any issues related to the editor.


HELP AND ASSISTANCE
===================

Help is available in the issue queue. If you are asking for help, please
provide the following information with your request:

- Version of Drupal you are using, or Pressflow version if you are using that
- The comment settings for your node type
- The ajax comments settings
- The browsers you are testing with and version (Firefox 3.6.10, IE8, etc.)
- Whether or not Javascript optimization is enabled or disabled
- Any relevant information from the Firebug console or a similar Javascript debugger
- Screenshots or screencast videos showing your errors are helpful
- If you are using the default textareas or any 3rd party Javascript editors
	like CKeditor, etc.
- Any additional details that the module authors can use to reproduce this
	with a default installation of Drupal with the Garland theme.


TIPS & TRICKS
=============

1. If you need to remove a lot of comments and you're bored with the confirmation dialog, just
hold one ctrl key and press the needed "Delete" links. It will force removal.


---
Created by Alexandr Shvets, aka neochief
http://drupaldance.com/

File

README.txt
View source
  1. Ajax Comments - http://drupal.org/project/ajax_comments
  2. INSTALLATION
  3. ============
  4. See Drupal module installation guidelines:
  5. http://drupal.org/getting-started/install-contrib/modules
  6. Prerequisite: This module requires comment_bonus_api. You must first install that module
  7. from: http://drupal.org/project/comment_bonus_api
  8. 1. Unpack module to your /sites/all/modules directory.
  9. 2. Visit your module management page at /admin/build/modules. Enable Ajax
  10. Comments. The comment_bonus_api module is also required.
  11. 3. Configure the module via /admin/settings/ajax_comments. At the very least
  12. you will want to enable it for one or more of your content types.
  13. 4. For each content type you are enabling for Ajax Comments, visit the Content
  14. Management admin page (/admin/content/node-type/mynodetype) and configure your
  15. comment settings "Location of comment submission form" to "Display below post or comments".
  16. TROUBLESHOOTING
  17. ===============
  18. 1. If you have themed your comment output, make sure that everything is wrapped to the ".comment" class
  19. in your "comment.tpl.php".
  20. 2. IMPORTANT: If you have the "Comment Notify" module installed, please also install
  21. http://drupal.org/project/queue_mail to prevent server errors during comment submitting.
  22. 3. The module may conflict with Devel. It has been causing lags when a comment is submitting.
  23. 4. Try testing with Javascript Optimization disabled and see if it makes a
  24. difference. (/admin/settings/performance)
  25. 5. If you are using the FCKEditor with the wysiwyg module, you should upgrade
  26. to FCKEditor 2.x or higher. Anything less than 2.x will not work properly with
  27. the module.
  28. 6. If you have having issues, first try the module with a clean Drupal install
  29. with the default theme. As this is Javascript, it relies upon certain
  30. assumptions in the theme files. For example, there have been reports of issues
  31. where custom themes remove

    or

    tags which cause the module to become

  32. inoperable.
  33. 7. If you are using a 3rd party editor such as Wysiwug or CKeditor, try
  34. disabling them and first troubleshooting with just the textareas. That will
  35. help to narrow down any issues related to the editor.
  36. HELP AND ASSISTANCE
  37. ===================
  38. Help is available in the issue queue. If you are asking for help, please
  39. provide the following information with your request:
  40. - Version of Drupal you are using, or Pressflow version if you are using that
  41. - The comment settings for your node type
  42. - The ajax comments settings
  43. - The browsers you are testing with and version (Firefox 3.6.10, IE8, etc.)
  44. - Whether or not Javascript optimization is enabled or disabled
  45. - Any relevant information from the Firebug console or a similar Javascript debugger
  46. - Screenshots or screencast videos showing your errors are helpful
  47. - If you are using the default textareas or any 3rd party Javascript editors
  48. like CKeditor, etc.
  49. - Any additional details that the module authors can use to reproduce this
  50. with a default installation of Drupal with the Garland theme.
  51. TIPS & TRICKS
  52. =============
  53. 1. If you need to remove a lot of comments and you're bored with the confirmation dialog, just
  54. hold one ctrl key and press the needed "Delete" links. It will force removal.
  55. ---
  56. Created by Alexandr Shvets, aka neochief
  57. http://drupaldance.com/