modules/imagefield_crop/README.txt

$Id$

= Overview =
imagefield_crop provides a widget for cropping an image after upload.


= Usage =
When the user uploads an image, the image is presented inside a cropping area. A cropping box is show inside, and the user can resize and move it. Upon clicking 'preview' or 'submit', the image is cropped and the result is saved within the node.


= Prerequisites =
The imagefield_crop module uses interface elements library to implement the resize interface. The following modules are required:
* jquery_interface (which by itself requires jquery_update).
* imagefield (since imagefield_crop is just an image widget module, not a field module)


= Installation =

* Install the module and enable it.
* Then on the image field configuration page (admin/content/types/<content_type>/fields/<your_image_field>) choose the 'Image with cropping' widget.
* Save your field, and edit it again. There you can see the widget settings form where you can choose the cropping box size, and other configuration options.
* Upon uploading an image, or editing an existing node, the image cropping interface will be presented.


= Issues that you could help with =

* Sometimes you will need to use the 'refresh' button on your browser to see the updated image. I haven't tracked this down yet and help will be appreciated.
* Only one widget per page is supported (no multiple values, no multiple fields with this widget in the node). This is mostly a limitation of the javascript part of this module, and help here will be appreciated.
* The module requires the PHP GD library, and will not work if any other library is selected. I believe this limitation can be removed for Drupal 6, where the drupal image library is improved.
1	$Id$
2
3	= Overview =
4	imagefield_crop provides a widget for cropping an image after upload.
5
6
7	= Usage =
8	When the user uploads an image, the image is presented inside a cropping area. A cropping box is show inside, and the user can resize and move it. Upon clicking 'preview' or 'submit', the image is cropped and the result is saved within the node.
9
10
11	= Prerequisites =
12	The imagefield_crop module uses interface elements library to implement the resize interface. The following modules are required:
13	* jquery_interface (which by itself requires jquery_update).
14	* imagefield (since imagefield_crop is just an image widget module, not a field module)
15
16
17	= Installation =
18
19	* Install the module and enable it.
20	* Then on the image field configuration page (admin/content/types/<content_type>/fields/<your_image_field>) choose the 'Image with cropping' widget.
21	* Save your field, and edit it again. There you can see the widget settings form where you can choose the cropping box size, and other configuration options.
22	* Upon uploading an image, or editing an existing node, the image cropping interface will be presented.
23
24
25	= Issues that you could help with =
26
27	* Sometimes you will need to use the 'refresh' button on your browser to see the updated image. I haven't tracked this down yet and help will be appreciated.
28	* Only one widget per page is supported (no multiple values, no multiple fields with this widget in the node). This is mostly a limitation of the javascript part of this module, and help here will be appreciated.
29	* The module requires the PHP GD library, and will not work if any other library is selected. I believe this limitation can be removed for Drupal 6, where the drupal image library is improved.