You are here

Home » API reference » Config default image 8.2

README.txt in Config default image 8.2

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

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers


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

Config Default Image provides a field formatter which allows a site builder
to specify the default image for an image field which is tracked in source
code and deployed in config management. It captures the path to a
VCS-controlled image file instead of the uuid of a non-tracked content
resource in site files.

This addresses the problem that the core default image feature uses a file
content which, without this module, config management (drush cex/cim...) will
deploy the config but not the content, so the default image wouldn't deploy
with it.

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

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


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

No special requirements.


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

 * Install as you would normally install a contributed Drupal module.
   For further information, see:
   https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules


CONFIGURATION
-------------

 Prepare image file:

  * Place a web-friendly image file that Drupal recognizes (png, jpg, etc) in
  a folder in your Drupal installation that is tracked by VCS. Suggested folders
  are a custom module or a custom theme folder, and copy the path to that file
  from Drupal root. Ex: /modules/custom/my_module/images/default_logo.png

 Field configuration:

  * In Manage Fields, edit that field: In this image field configuration,
  make sure that the Default Image is not set.
  * In Manage Display, configure the Format of this field: Paste the path
  to the image, and adjust any other options.
  * Be sure to save the Manage Display screen.

 Export configuration:
  * Export as you normally would: ie. `drush cex -y`
  * Capture to VCS both your updated field config (which contains the
  environment-universal path) and the image asset itself.

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

Current maintainers:
 * Gaël Gosset (GaëlG) - drupal.org/u/gaëlg

This project has been sponsored by:
 * Insite
   A lasting and independent business project with more than 20 years
   experience and several hundred references in web projects and visual
   communication with public actors, associative and professional networks.

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. Config Default Image provides a field formatter which allows a site builder

  15. to specify the default image for an image field which is tracked in source

  16. code and deployed in config management. It captures the path to a

  17. VCS-controlled image file instead of the uuid of a non-tracked content

  18. resource in site files.

  19. 

  20. This addresses the problem that the core default image feature uses a file

  21. content which, without this module, config management (drush cex/cim...) will

  22. deploy the config but not the content, so the default image wouldn't deploy

  23. with it.

  24. 

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

  26.    https://www.drupal.org/project/config_default_image

  27. 

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

  29.    https://www.drupal.org/project/issues/search/config_default_image

  30. 

  31. 

  32. REQUIREMENTS

  33. ------------

  34. 

  35. No special requirements.

  36. 

  37. 

  38. INSTALLATION

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

  40. 

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

  42.    For further information, see:

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

  44. 

  45. 

  46. CONFIGURATION

  47. -------------

  48. 

  49.  Prepare image file:

  50. 

  51.   * Place a web-friendly image file that Drupal recognizes (png, jpg, etc) in

  52.   a folder in your Drupal installation that is tracked by VCS. Suggested folders

  53.   are a custom module or a custom theme folder, and copy the path to that file

  54.   from Drupal root. Ex: /modules/custom/my_module/images/default_logo.png

  55. 

  56.  Field configuration:

  57. 

  58.   * In Manage Fields, edit that field: In this image field configuration,

  59.   make sure that the Default Image is not set.

  60.   * In Manage Display, configure the Format of this field: Paste the path

  61.   to the image, and adjust any other options.

  62.   * Be sure to save the Manage Display screen.

  63. 

  64.  Export configuration:

  65.   * Export as you normally would: ie. `drush cex -y`

  66.   * Capture to VCS both your updated field config (which contains the

  67.   environment-universal path) and the image asset itself.

  68. 

  69. MAINTAINERS

  70. -----------

  71. 

  72. Current maintainers:

  73.  * Gaël Gosset (GaëlG) - drupal.org/u/gaëlg

  74. 

  75. This project has been sponsored by:

  76.  * Insite

  77.    A lasting and independent business project with more than 20 years

  78.    experience and several hundred references in web projects and visual

  79.    communication with public actors, associative and professional networks.