You are here

Home » API reference » Comment Upload 6

README.txt in Comment Upload 6

Same filename and directory in other branches
  1. 5 README.txt
Non-displayable characters.

File

README.txt
View source 
  1. 

  2. Comment upload provides the ability to upload "file attachments" to comments.

  3. 

  4. Compared to Comment upload 5.x, the 6.x version still lacks views integration.

  5. 

  6. Comment upload requires at least Drupal 6.4.

  7. 

  8. INSTALLATION

  9. ============

  10. - Copy the comment_upload folder from the archive to sites/all/modules.

  11. 

  12. - Visit Administer >> Site building >> Modules (admin/build/modules) and enable

  13.   the comment upload module (under Other).

  14. 

  15. - Configure permission on Administer >> User management >> Permissions 

  16.   (admin/user/permissions)

  17. 

  18. - Enable attachments for specific content types on the edit pages of specific

  19.   content types reached via the edit links on Administer >> Content management >> 

  20.   Content types (admin/content/node-type).

  21. 

  22. 

  23. CONFIGURATION

  24. =============

  25. 

  26. - You can enable uploads per content type on the edit pages of specific content

  27.   types. Use the edit links on Administer >> Content management >> Content types 

  28.   (admin/content/node-type) to access these pages.

  29. 

  30. - Display of images is governed by the Image attachments on comments setting.

  31.   

  32.   - Display as attachments will include images in the attachments table.

  33.   - Display as full image will add the entire image below the comment.

  34.   

  35.   If you install imagecache (http://drupal.org/project/imagecache) you will see

  36.   additional 'Display via imagecache preset [presetname] options for any 

  37.   preset you have created.

  38.   

  39.   This is useful to ensure your page is not distorted by overly large images.

  40. 

  41. - Comment upload provides two permissions:

  42. 

  43.   - "upload files to comments"

  44.   - "view files uploaded to comments"

  45. 

  46. - Allowed extensions and the maximum allowed upload sizes are taken from the 

  47.   Upload module settings on Administer >> Site configuration >> File uploads 

  48.   (admin/settings/uploads).

  49. 

  50. 

  51. THEMING

  52. =======

  53. To override the display of attachments, copy the file

  54. "comment-upload-attachments.tpl.php" to your PHPtemplate theme to make changes.

  55. 

  56. Variables:

  57. 

  58. $images      - an array of images (when not set to Display as attachments).

  59. 

  60. with each element containing:

  61.   'url'      - url of the full image

  62.   'image'    -  tag

  63. 

  64. $attachments - an array of attachments

  65. 

  66. with each element containing:

  67.   'url'      -  url of the file

  68.   'zebra'    - 'odd' or 'even' to enable zebra striping

  69.   'text'     - description when set or filename of the file

  70.   'size'     - size of the file in bytes, kB or Mb.

  71. 

  72. 

  73. NOTE

  74. ====

  75. As comment_upload heavily modifies the way comment form submission works, there

  76. is a chance that it is not compatible with other modules changing the comment form.

  77. 

  78. 

  79. AUTHORS & COPYRIGHT

  80. ===================

  81. Comment upload 4.7.x and 5.x were written by Károly Négyesi and Jeff Eaton.

  82. Comment upload 6.x was written by Heine Deelstra.

  83. 

  84. Comment upload 6.x Copyright (c) 2008 Ustima Web Development.

  85. 

  86. This module is licensed under the  GPL v2. See LICENSE.txt for details.