You are here

README.txt in Manual Crop 7

Manual Crop
===========

The Manual Crop module exposes a set of image style effects that allow you
to crop (and scale) an image after uploading.

Dependencies
------------
- Libraries 2.x
- jQuery plugins:
    - imagesLoaded:
        + Website: http://desandro.github.io/imagesloaded
        + Download: https://github.com/desandro/imagesloaded/archive/v2.1.2.tar.gz
    - imgAreaSelect:
        + Website: http://odyniec.net/projects/imgareaselect
        + Download: https://github.com/odyniec/imgareaselect/archive/v0.9.11-rc.1.tar.gz

Installation
------------
Start by downloading and installing the Libraries 2.x module.

Next download and extract the imagesLoaded plugin, rename the extracted folder to
"jquery.imagesloaded" and place it under "sites/all/libraries". The plugin should
now be located at "sites/all/libraries/jquery.imagesloaded/jquery.imagesloaded.min.js".

Please note that the 3.x version can also be used, but it depends on jQuery 1.5
which can only be obtained by installing the jQuery Update module.

Now download and extract the imgAreaSelect plugin, rename extracted folder to
"jquery.imgareaselect" and copy it into "sites/all/libraries". The plugin should
now be located at "sites/all/libraries/jquery.imgareaselect/jquery.imgareaselect.dev.js".

When finished you can activate the module via the Modules page!

Configuration
-------------
After installing the module you need to configure your image styles before you
can start cropping. Go to Administration » Configuration » Media » Image styles
and click on the "edit" link for the styles that need a Manual Crop effect.

Add and configure one of the Manual Crop effects, you'll notice that the Manual
Crop effect will always become the first effect in the list. This is because
cropping should always be done first, otherwise the result will be unpredictable.

Next go to Administration » Structure » Content types and click on the "manage fields"
link (the Field UI module should be activated) for the content type that should
allow cropping. Now click on the "edit" link of the image field, so you can enable
and configure Manual Crop (open the "Manual Crop" fieldset) for the current field.

After saving the settings you should return to the content type overview and click
on "manage display" so you can set the (cropped) image style that should be used.

Manual Crop adds a "?c=md5_hash" query string parameter to the image url so the
at client-side cached image gets refreshed whenever the crop selection changes.
To prevent an SEO impact, this can be disabled by unchecking the
"Reload cache-control" setting at admin/config/media/manualcrop.

File

README.txt
View source
  1. Manual Crop
  2. ===========
  3. The Manual Crop module exposes a set of image style effects that allow you
  4. to crop (and scale) an image after uploading.
  5. Dependencies
  6. ------------
  7. - Libraries 2.x
  8. - jQuery plugins:
  9. - imagesLoaded:
  10. + Website: http://desandro.github.io/imagesloaded
  11. + Download: https://github.com/desandro/imagesloaded/archive/v2.1.2.tar.gz
  12. - imgAreaSelect:
  13. + Website: http://odyniec.net/projects/imgareaselect
  14. + Download: https://github.com/odyniec/imgareaselect/archive/v0.9.11-rc.1.tar.gz
  15. Installation
  16. ------------
  17. Start by downloading and installing the Libraries 2.x module.
  18. Next download and extract the imagesLoaded plugin, rename the extracted folder to
  19. "jquery.imagesloaded" and place it under "sites/all/libraries". The plugin should
  20. now be located at "sites/all/libraries/jquery.imagesloaded/jquery.imagesloaded.min.js".
  21. Please note that the 3.x version can also be used, but it depends on jQuery 1.5
  22. which can only be obtained by installing the jQuery Update module.
  23. Now download and extract the imgAreaSelect plugin, rename extracted folder to
  24. "jquery.imgareaselect" and copy it into "sites/all/libraries". The plugin should
  25. now be located at "sites/all/libraries/jquery.imgareaselect/jquery.imgareaselect.dev.js".
  26. When finished you can activate the module via the Modules page!
  27. Configuration
  28. -------------
  29. After installing the module you need to configure your image styles before you
  30. can start cropping. Go to Administration » Configuration » Media » Image styles
  31. and click on the "edit" link for the styles that need a Manual Crop effect.
  32. Add and configure one of the Manual Crop effects, you'll notice that the Manual
  33. Crop effect will always become the first effect in the list. This is because
  34. cropping should always be done first, otherwise the result will be unpredictable.
  35. Next go to Administration » Structure » Content types and click on the "manage fields"
  36. link (the Field UI module should be activated) for the content type that should
  37. allow cropping. Now click on the "edit" link of the image field, so you can enable
  38. and configure Manual Crop (open the "Manual Crop" fieldset) for the current field.
  39. After saving the settings you should return to the content type overview and click
  40. on "manage display" so you can set the (cropped) image style that should be used.
  41. Manual Crop adds a "?c=md5_hash" query string parameter to the image url so the
  42. at client-side cached image gets refreshed whenever the crop selection changes.
  43. To prevent an SEO impact, this can be disabled by unchecking the
  44. "Reload cache-control" setting at admin/config/media/manualcrop.