#444422 by skilip: option for preview area width
[project/imagefield_crop.git] / README.txt
1
2 = Overview =
3 imagefield_crop provides a widget for cropping an image after upload.
4
5
6 = Usage =
7 When the user uploads an image, the image is presented inside a cropping area.
8 A cropping box is shown inside, and the user can resize and move it. Upon
9 clicking 'preview' or 'submit', the image is cropped and the result is saved
10 within the node.
11
12 Watch the screencast[1] by capellic[2]
13
14   [1] http://capellic.com/blog/imagefield-crop
15   [2] http://drupal.org/user/192467
16
17 = Features =
18
19 * Dynamic preview is presented during cropping
20 * Original image is displayed every time for re-cropping
21 * The original image is used for cropping, for best quality
22 * Ability to define the crop interface resolution
23 * Ability to define the output image resolution and enforce it
24
25
26 = Prerequisites =
27 * imagefield (http://drupal.org/project/imagefield)
28 * filefield (http://drupal.org/project/filefield)
29 * imageapi (http://drupal.org/project/imageapi)
30 * Graphics processing engine (gd, imagemagick, or anything else imageapi.module can work with).
31
32
33 = Installation =
34 * To install the module copy the 'imagefield_crop' folder to your sites/all/modules directory.
35 * Go to admin/build/modules. Enable the module.
36   Read more about installing modules at http://drupal.org/node/70151
37
38
39 = Configuration and usage =
40 * We assume that you have already created a new content type. Edit your content type fields at admin/content/types
41 * Click on appropriate MANAGE FIELDS link.
42 * Add a new field. To do so click on SELECT A FIELD TYPE dropdown menu. Select FILE. Click on FILE UPLOAD dropdown menu. Select IMAGE WITH CROPPING.
43 * Click on SAVE button.
44 * Follow instructions on the next page. You can choose the cropping box size, and other configuration options. If unsure leave default configuration. Click on SAVE FIELD SETTINGS button.
45 * Create a new item at /node/add
46 * Click on BROWSE button. Select an image.
47 * Click on UPLOAD button
48 * Upon uploading an image, or editing an existing node, the image cropping interface will be presented.
49
50
51 = Contribute. Report issue. Request support. Request new feature. =
52 * Go to the module issue queue at http://drupal.org/project/issues/imagefield_crop?status=All&categories=All
53 * Click on CREATE A NEW ISSUE link.
54 * Fill the form.
55 * To get a status report on your request go to http://drupal.org/project/issues/user
56