You are here

Home » API reference » ImageAPI Optimize GD 2.x

README.txt in ImageAPI Optimize GD 2.x

Same filename and directory in other branches
  1. 8 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. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * Maintainers

  9. 

  10. 

  11. INTRODUCTION

  12. ------------

  13. 

  14. This module moves GD compression/quality into an ImageAPI Optimize processor.

  15. This allows for you to separate image actions like crop/scale/overlay from the

  16. image optimization side.

  17. 

  18. It's encouraged to set your sitewide GD toolkit settings to 100% quality, and

  19. allow ImageAPI Optimize pipelines to handle sitewide and per-image style quality

  20. settings.

  21. 

  22. 

  23.  * For a full description of the module, visit the project page:

  24.    https://www.drupal.org/project/imageapi_optimize_gd

  25. 

  26.  * To submit bug reports and feature suggestions, or to track changes:

  27.    https://www.drupal.org/project/issues/imageapi_optimize_gd

  28. 

  29. 

  30. REQUIREMENTS

  31. ------------

  32. 

  33. This module requires the following modules:

  34. 

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

  36. 

  37. 

  38. INSTALLATION

  39. ------------

  40. 

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

  42. 

  43.  * Visit:

  44.    https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules

  45.    for further information.

  46. 

  47. 

  48. Configuration

  49. ----------------

  50. 

  51. * Configure a new Image Optimize Pipeline

  52. 

  53.      - First, you will need to Configure a new Image Optimize Pipeline. To do

  54.      this navigate to Configuration >> Media >> Image Optimize pipelines. Fill

  55.      out Image optimize pipeline name. There is a dropdown list that reads

  56.      Select a new processor, choose GD then click Add. On the next screen fill

  57.      in the *Image quality* this represents a percentage. Make sure that the

  58.      File Types has a type selected such JPEG. Click Add processor.

  59. 

  60. * Set a Sitewide default pipeline

  61. 

  62.       - You can set a Sitewide default pipeline that will load in automatically

  63.       on all Image Styles using the Sitewide default pipeline. Navigate to

  64.       Configuration >> Media >> Image Optimize pipelines. Select the preferred

  65.       Pipeline. Click Save configuration.

  66. 

  67. * Set an individual Image style's Image Optimize Pipeline

  68. 

  69.      - Now when you travel to Configuration > Media > Image and edit your

  70.      preferred Image style. At the bottom of the form you can select your

  71.      preferred Image Optimize Pipeline or the Sitewide default pipeline.

  72. 

  73. 

  74. MAINTAINERS

  75. -----------

  76. 

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

  78. 

  79. This project has been sponsored by:

  80. 

  81.  * Elevated Third

  82. 

  83. Specializing in Drupal-powered digital experiences that get results. Visit

  84. https://www.elevatedthird.com/