You are here

Home » API reference » ImageAPI Optimize WebP 8

README.txt in ImageAPI Optimize WebP 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 provides a WebP processor for the ImageAPI Optimize module. When
added to a pipeline, a .webp derivative is created from the source image,
providing 2 versions of a styled image.


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

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


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 WebP Deriver then click Add. On the next
     screen fill in the Image quality this represents a percentage. 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 provides a WebP processor for the ImageAPI Optimize module. When

  15. added to a pipeline, a .webp derivative is created from the source image,

  16. providing 2 versions of a styled image.

  17. 

  18. 

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

  20.    https://www.drupal.org/project/imageapi_optimize_webp

  21. 

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

  23.    https://www.drupal.org/project/issues/imageapi_optimize_webp

  24. 

  25. 

  26. REQUIREMENTS

  27. ------------

  28. 

  29. This module requires the following modules:

  30. 

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

  32. 

  33. 

  34. INSTALLATION

  35. ------------

  36. 

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

  38. 

  39.  * Visit:

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

  41.    for further information.

  42. 

  43. 

  44. Configuration

  45. ----------------

  46. 

  47. * Configure a new Image Optimize Pipeline

  48. 

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

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

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

  52.      Select a new processor, choose WebP Deriver then click Add. On the next

  53.      screen fill in the Image quality this represents a percentage. Click Add

  54.      processor.

  55. 

  56. 

  57. * Set a Sitewide default pipeline

  58. 

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

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

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

  62.      Pipeline. Click Save configuration.

  63. 

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

  65. 

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

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

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

  69. 

  70. 

  71. MAINTAINERS

  72. -----------

  73. 

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

  75. 

  76. This project has been sponsored by:

  77. 

  78.  * Elevated Third

  79. 

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

  81. https://www.elevatedthird.com/