You are here

README.txt in ImageAPI Optimize GD 8

Same filename and directory in other branches
  1. 2.x README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

This module moves GD compression/quality into an ImageAPI Optimize processor.
This allows for you to separate image actions like crop/scale/overlay from the
image optimization side.

It's encouraged to set your sitewide GD toolkit settings to 100% quality, and
allow ImageAPI Optimize pipelines to handle sitewide and per-image style quality
settings.


 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/imageapi_optimize_gd

 * To submit bug reports and feature suggestions, or to track changes:
   https://www.drupal.org/project/issues/imageapi_optimize_gd


REQUIREMENTS
------------

This module requires the following modules:

 * Image Optimize (or ImageAPI Optimize) (https://www.drupal.org/project/imageapi_optimize)


INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module.

 * Visit:
   https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules
   for further information.


Configuration
----------------

* Configure a new Image Optimize Pipeline

     - First, you will need to Configure a new Image Optimize Pipeline. To do
     this navigate to Configuration >> Media >> Image Optimize pipelines. Fill
     out Image optimize pipeline name. There is a dropdown list that reads
     Select a new processor, choose GD then click Add. On the next screen fill
     in the *Image quality* this represents a percentage. Make sure that the
     File Types has a type selected such JPEG. Click Add processor.

* Set a Sitewide default pipeline

      - You can set a Sitewide default pipeline that will load in automatically
      on all Image Styles using the Sitewide default pipeline. Navigate to
      Configuration >> Media >> Image Optimize pipelines. Select the preferred
      Pipeline. Click Save configuration.

* Set an individual Image style's Image Optimize Pipeline

     - Now when you travel to Configuration > Media > Image and edit your
     preferred Image style. At the bottom of the form you can select your
     preferred Image Optimize Pipeline or the Sitewide default pipeline.


MAINTAINERS
-----------

 * Michael Lander (michaellander) - https://www.drupal.org/u/michaellander

This project has been sponsored by:

 * Elevated Third

Specializing in Drupal-powered digital experiences that get results. Visit
https://www.elevatedthird.com/

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Installation
  6. * Configuration
  7. * Maintainers
  8. INTRODUCTION
  9. ------------
  10. This module moves GD compression/quality into an ImageAPI Optimize processor.
  11. This allows for you to separate image actions like crop/scale/overlay from the
  12. image optimization side.
  13. It's encouraged to set your sitewide GD toolkit settings to 100% quality, and
  14. allow ImageAPI Optimize pipelines to handle sitewide and per-image style quality
  15. settings.
  16. * For a full description of the module, visit the project page:
  17. https://www.drupal.org/project/imageapi_optimize_gd
  18. * To submit bug reports and feature suggestions, or to track changes:
  19. https://www.drupal.org/project/issues/imageapi_optimize_gd
  20. REQUIREMENTS
  21. ------------
  22. This module requires the following modules:
  23. * Image Optimize (or ImageAPI Optimize) (https://www.drupal.org/project/imageapi_optimize)
  24. INSTALLATION
  25. ------------
  26. * Install as you would normally install a contributed Drupal module.
  27. * Visit:
  28. https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules
  29. for further information.
  30. Configuration
  31. ----------------
  32. * Configure a new Image Optimize Pipeline
  33. - First, you will need to Configure a new Image Optimize Pipeline. To do
  34. this navigate to Configuration >> Media >> Image Optimize pipelines. Fill
  35. out Image optimize pipeline name. There is a dropdown list that reads
  36. Select a new processor, choose GD then click Add. On the next screen fill
  37. in the *Image quality* this represents a percentage. Make sure that the
  38. File Types has a type selected such JPEG. Click Add processor.
  39. * Set a Sitewide default pipeline
  40. - You can set a Sitewide default pipeline that will load in automatically
  41. on all Image Styles using the Sitewide default pipeline. Navigate to
  42. Configuration >> Media >> Image Optimize pipelines. Select the preferred
  43. Pipeline. Click Save configuration.
  44. * Set an individual Image style's Image Optimize Pipeline
  45. - Now when you travel to Configuration > Media > Image and edit your
  46. preferred Image style. At the bottom of the form you can select your
  47. preferred Image Optimize Pipeline or the Sitewide default pipeline.
  48. MAINTAINERS
  49. -----------
  50. * Michael Lander (michaellander) - https://www.drupal.org/u/michaellander
  51. This project has been sponsored by:
  52. * Elevated Third
  53. Specializing in Drupal-powered digital experiences that get results. Visit
  54. https://www.elevatedthird.com/