You are here

README.txt in Picture Background Formatter 8

Same filename and directory in other branches
  1. 7 README.txt
Introduction
------------

The Picture Background Formatter module creates an image field formatter that
generates background image CSS code based on a Picture Mapping.


Requirements
------------

This module requires the following modules:

  * Picture (https://www.drupal.org/project/picture)


Installation
------------

  * Install as you would normally install a contributed Drupal module. See:
    https://drupal.org/documentation/install/modules-themes/modules-7
    for further information.


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

  * A picture mapping must be created prior to utilizing the Picture Background
    Formatter

  * Add an image field to your desired Content Type

  * In the Content Type Display panel, change the format of your image field
    to Picture Background Formatter

  * Click the field settings gear to expose the Picture Mapping and Selector
    fields

    - The chosen Picture Mapping will create image style varients just as the
      normal Picture formatter would

    - Input the desired CSS Selector where you want the background image
      to appear


Troubleshooting
---------------

If you do not see the Picture Background Formatter formatter in your Content
Type display, please make sure you have correctly configured a valid Picture
Mapping via admin/config/media/picture

Picture Background Formatter only uses Image Styles for its output. Any
breakpoints that use Picture module's Sizes Attribute will be skipped.

File

README.txt
View source
  1. Introduction
  2. ------------
  3. The Picture Background Formatter module creates an image field formatter that
  4. generates background image CSS code based on a Picture Mapping.
  5. Requirements
  6. ------------
  7. This module requires the following modules:
  8. * Picture (https://www.drupal.org/project/picture)
  9. Installation
  10. ------------
  11. * Install as you would normally install a contributed Drupal module. See:
  12. https://drupal.org/documentation/install/modules-themes/modules-7
  13. for further information.
  14. Configuration
  15. -------------
  16. * A picture mapping must be created prior to utilizing the Picture Background
  17. Formatter
  18. * Add an image field to your desired Content Type
  19. * In the Content Type Display panel, change the format of your image field
  20. to Picture Background Formatter
  21. * Click the field settings gear to expose the Picture Mapping and Selector
  22. fields
  23. - The chosen Picture Mapping will create image style varients just as the
  24. normal Picture formatter would
  25. - Input the desired CSS Selector where you want the background image
  26. to appear
  27. Troubleshooting
  28. ---------------
  29. If you do not see the Picture Background Formatter formatter in your Content
  30. Type display, please make sure you have correctly configured a valid Picture
  31. Mapping via admin/config/media/picture
  32. Picture Background Formatter only uses Image Styles for its output. Any
  33. breakpoints that use Picture module's Sizes Attribute will be skipped.