[Summary view] [Print] [Text view]

   1  $Id: README.txt,v 1.2.2.7 2008/09/15 16:45:15 heine Exp $
   2  
   3  Comment upload provides the ability to upload "file attachments" to comments.
   4  
   5  Compared to Comment upload 5.x, the 6.x version still lacks views integration.
   6  
   7  Comment upload requires at least Drupal 6.4.
   8  
   9  INSTALLATION
  10  ============
  11  - Copy the comment_upload folder from the archive to sites/all/modules.
  12  
  13  - Visit Administer >> Site building >> Modules (admin/build/modules) and enable
  14    the comment upload module (under Other).
  15  
  16  - Configure permission on Administer >> User management >> Permissions 
  17    (admin/user/permissions)
  18  
  19  - Enable attachments for specific content types on the edit pages of specific
  20    content types reached via the edit links on Administer >> Content management >> 
  21    Content types (admin/content/node-type).
  22  
  23  
  24  CONFIGURATION
  25  =============
  26  
  27  - You can enable uploads per content type on the edit pages of specific content
  28    types. Use the edit links on Administer >> Content management >> Content types 
  29    (admin/content/node-type) to access these pages.
  30  
  31  - Display of images is governed by the Image attachments on comments setting.
  32    
  33    - Display as attachments will include images in the attachments table.
  34    - Display as full image will add the entire image below the comment.
  35    
  36    If you install imagecache (http://drupal.org/project/imagecache) you will see
  37    additional 'Display via imagecache preset [presetname] options for any 
  38    preset you have created.
  39    
  40    This is useful to ensure your page is not distorted by overly large images.
  41  
  42  - Comment upload provides two permissions:
  43  
  44    - "upload files to comments"
  45    - "view files uploaded to comments"
  46  
  47  - Allowed extensions and the maximum allowed upload sizes are taken from the 
  48    Upload module settings on Administer >> Site configuration >> File uploads 
  49    (admin/settings/uploads).
  50  
  51  
  52  THEMING
  53  =======
  54  To override the display of attachments, copy the file
  55  "comment-upload-attachments.tpl.php" to your PHPtemplate theme to make changes.
  56  
  57  Variables:
  58  
  59  $images      - an array of images (when not set to Display as attachments).
  60  
  61  with each element containing:
  62    'url'      - url of the full image
  63    'image'    - <img> tag
  64  
  65  $attachments - an array of attachments
  66  
  67  with each element containing:
  68    'url'      -  url of the file
  69    'zebra'    - 'odd' or 'even' to enable zebra striping
  70    'text'     - description when set or filename of the file
  71    'size'     - size of the file in bytes, kB or Mb.
  72  
  73  
  74  NOTE
  75  ====
  76  As comment_upload heavily modifies the way comment form submission works, there
  77  is a chance that it is not compatible with other modules changing the comment form.
  78  
  79  
  80  AUTHORS & COPYRIGHT
  81  ===================
  82  Comment upload 4.7.x and 5.x were written by Károly Négyesi and Jeff Eaton.
  83  Comment upload 6.x was written by Heine Deelstra.
  84  
  85  Comment upload 6.x Copyright (c) 2008 Ustima Web Development.
  86  
  87  This module is licensed under the  GPL v2. See LICENSE.txt for details.