You are here

README.txt in AJAX Comments 7

Same filename and directory in other branches
  1. 5 README.txt
  2. 6 README.txt
This is the 7.x version of AJAX Comments.

This version is still in heavy development. See below for instructions for the 6.x version which will likely change.



Ajax Comments - http://drupal.org/project/ajax_comments

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

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

DEVELOPER NOTE
============
- Note on use of ajax_comments_init() in ajax_comments.module

  In ajax.js, the data can be posted one of two ways, using $.ajax() or if you're using a form, form.ajaxSubmit().
  The first sets $_POST['ajax_html_ids'] to an array of all the HTML ids, the latter sets it
  to an array of size 1 with all of the ids concatenated by commas.
  
  If you'd like to see how this affects us, do this:
  --------------------------------------------------
  1. Comment out ajax_comments_init().
  2. Click reply to reply to a specific comment.
  3. Notice your form id is now comment-form--2 because $_POST['ajax_html_ids'] were sent with $.ajax() and
     recieved properly enabling drupal_html_id to do it's job.
  4. Press save on your new comment without any text so that it fails validation. The form is submitted with
     form.ajaxSubmit() and $_POST['ajax_html_ids'] is set to an array of size 1 with the first entry being
     a concatenated list of ids.
  5. Since the ids weren't received properly, drupal_html_id thinks that comment-form is a good id.
  6. Your new form has the same id as the main comment form at the bottom of the page. 


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.

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

Drupal 7.x version by acouch

File

README.txt
View source
  1. This is the 7.x version of AJAX Comments.
  2. This version is still in heavy development. See below for instructions for the 6.x version which will likely change.
  3. Ajax Comments - http://drupal.org/project/ajax_comments
  4. INSTALLATION
  5. ============
  6. See Drupal module installation guidelines:
  7. http://drupal.org/getting-started/install-contrib/modules
  8. DEVELOPER NOTE
  9. ============
  10. - Note on use of ajax_comments_init() in ajax_comments.module
  11. In ajax.js, the data can be posted one of two ways, using $.ajax() or if you're using a form, form.ajaxSubmit().
  12. The first sets $_POST['ajax_html_ids'] to an array of all the HTML ids, the latter sets it
  13. to an array of size 1 with all of the ids concatenated by commas.
  14. If you'd like to see how this affects us, do this:
  15. --------------------------------------------------
  16. 1. Comment out ajax_comments_init().
  17. 2. Click reply to reply to a specific comment.
  18. 3. Notice your form id is now comment-form--2 because $_POST['ajax_html_ids'] were sent with $.ajax() and
  19. recieved properly enabling drupal_html_id to do it's job.
  20. 4. Press save on your new comment without any text so that it fails validation. The form is submitted with
  21. form.ajaxSubmit() and $_POST['ajax_html_ids'] is set to an array of size 1 with the first entry being
  22. a concatenated list of ids.
  23. 5. Since the ids weren't received properly, drupal_html_id thinks that comment-form is a good id.
  24. 6. Your new form has the same id as the main comment form at the bottom of the page.
  25. TROUBLESHOOTING
  26. ===============
  27. 1. If you have themed your comment output, make sure that everything is wrapped to the ".comment" class
  28. in your "comment.tpl.php".
  29. 2. IMPORTANT: If you have the "Comment Notify" module installed, please also install
  30. http://drupal.org/project/queue_mail to prevent server errors during comment submitting.
  31. 3. The module may conflict with Devel. It has been causing lags when a comment is submitting.
  32. 4. Try testing with Javascript Optimization disabled and see if it makes a
  33. difference. (/admin/settings/performance)
  34. 5. If you are using the FCKEditor with the wysiwyg module, you should upgrade
  35. to FCKEditor 2.x or higher. Anything less than 2.x will not work properly with
  36. the module.
  37. 6. If you have having issues, first try the module with a clean Drupal install
  38. with the default theme. As this is Javascript, it relies upon certain
  39. assumptions in the theme files. For example, there have been reports of issues
  40. where custom themes remove

    or

    tags which cause the module to become

  41. inoperable.
  42. 7. If you are using a 3rd party editor such as Wysiwug or CKeditor, try
  43. disabling them and first troubleshooting with just the textareas. That will
  44. help to narrow down any issues related to the editor.
  45. HELP AND ASSISTANCE
  46. ===================
  47. Help is available in the issue queue. If you are asking for help, please
  48. provide the following information with your request:
  49. - Version of Drupal you are using, or Pressflow version if you are using that
  50. - The comment settings for your node type
  51. - The ajax comments settings
  52. - The browsers you are testing with and version (Firefox 3.6.10, IE8, etc.)
  53. - Whether or not Javascript optimization is enabled or disabled
  54. - Any relevant information from the Firebug console or a similar Javascript debugger
  55. - Screenshots or screencast videos showing your errors are helpful
  56. - If you are using the default textareas or any 3rd party Javascript editors
  57. like CKeditor, etc.
  58. - Any additional details that the module authors can use to reproduce this
  59. with a default installation of Drupal with the Garland theme.
  60. ---
  61. Created by Alexandr Shvets, aka neochief
  62. http://drupaldance.com/
  63. Drupal 7.x version by acouch