You are here

Home » API reference » Image Field Caption 8

README.txt in Image Field Caption 8

Same filename and directory in other branches
  1. 7.2 README.txt
  2. 7 README.txt
|=====================|
| Image Field Caption |
|=====================|

  Provides a caption text area for image fields.

  This module behavior is based on the Image Field Caption module for Drupal 7 (7.x-2.1).
  https://www.drupal.org/project/image_field_caption
  
  The first adaptation for Drupal 8 was created by Echofive with the support of Wieni for the time,
  the money and the coffee ;)
  
  https://www.drupal.org/u/echofive
  https://www.drupal.org/wieni

|==============|
| Installation |
|==============|

  1. Download the module.
  2. Upload module to the modules/contribs folder.
  3. Enable the module.
  4. Flush all of Drupal's caches.

|=======|
| Usage |
|=======|

  1. Add a new image field to a content type, or use an existing image field and 
    set the field format to "Image with caption" on the "Manage display" tab.
  2. Add or edit a node or any other entity with an image field.
  3. Go to the image field on the entity form.
  4. Enter text into the caption text area and choose format.
  5. Save the entity.
  6. View the entity to see your image field caption.   
      
|===============|
| Configuration |
|===============|

  The configuration is only done on a per field basis.

|===============|
| Caption Theme |
|===============|

  By default, an image field's caption will be rendered below the image. 
  To customize the image caption display, copy the image-caption-formatter.html.twig file
  to your theme's directory and adjust the html for your needs. 
  Flush Drupal's theme registry cache to have it recognize your theme's new file:

  themes/custom/MY_THEME/image-caption-formatter.html.twig

|=============|
| Caption CSS |
|=============|

  To make changes to the caption css, use this CSS selector:

  blockquote.image-field-caption { /* add custom css here */ }

|==================|
| More Information |
|==================|

  About the Drupal 7 version (for legacy).
  http://www.drupal.org/project/image_field_caption
  http://www.tylerfrankenstein.com/image_field_caption

File

README.txt
View source 
  1. |=====================|

  2. | Image Field Caption |

  3. |=====================|

  4. 

  5.   Provides a caption text area for image fields.

  6. 

  7.   This module behavior is based on the Image Field Caption module for Drupal 7 (7.x-2.1).

  8.   https://www.drupal.org/project/image_field_caption

  9.   

  10.   The first adaptation for Drupal 8 was created by Echofive with the support of Wieni for the time,

  11.   the money and the coffee ;)

  12.   

  13.   https://www.drupal.org/u/echofive

  14.   https://www.drupal.org/wieni

  15. 

  16. |==============|

  17. | Installation |

  18. |==============|

  19. 

  20.   1. Download the module.

  21.   2. Upload module to the modules/contribs folder.

  22.   3. Enable the module.

  23.   4. Flush all of Drupal's caches.

  24. 

  25. |=======|

  26. | Usage |

  27. |=======|

  28. 

  29.   1. Add a new image field to a content type, or use an existing image field and 

  30.     set the field format to "Image with caption" on the "Manage display" tab.

  31.   2. Add or edit a node or any other entity with an image field.

  32.   3. Go to the image field on the entity form.

  33.   4. Enter text into the caption text area and choose format.

  34.   5. Save the entity.

  35.   6. View the entity to see your image field caption.   

  36.       

  37. |===============|

  38. | Configuration |

  39. |===============|

  40. 

  41.   The configuration is only done on a per field basis.

  42. 

  43. |===============|

  44. | Caption Theme |

  45. |===============|

  46. 

  47.   By default, an image field's caption will be rendered below the image. 

  48.   To customize the image caption display, copy the image-caption-formatter.html.twig file

  49.   to your theme's directory and adjust the html for your needs. 

  50.   Flush Drupal's theme registry cache to have it recognize your theme's new file:

  51. 

  52.   themes/custom/MY_THEME/image-caption-formatter.html.twig

  53. 

  54. |=============|

  55. | Caption CSS |

  56. |=============|

  57. 

  58.   To make changes to the caption css, use this CSS selector:

  59. 

  60.   blockquote.image-field-caption { /* add custom css here */ }

  61. 

  62. |==================|

  63. | More Information |

  64. |==================|

  65. 

  66.   About the Drupal 7 version (for legacy).

  67.   http://www.drupal.org/project/image_field_caption

  68.   http://www.tylerfrankenstein.com/image_field_caption

  69.