Image styles description

I don't see where and how this would be useful, or even displayed.

This would be an edge case and doesn't make sense to add it in core, I agree with @sun.

However, if you still need that feature, you'll have to build a custom/contrib module and extend ImageStyle,ImageStyleFormBase and maybe other classes.

Closing with "won't fix".

I'd like to reopen this (8 years later!), as I feel descriptions would be valuable for providing use information or specific case details, and when dozens of image styles are created it would be useful too.

It could be displayed on the exisiting list styles page at /admin/config/media/image-styles

Similar to the content types list.

Hi, you can use this patch to achieve this functionality of the image style description. It supports the config export as well. Tested it by importing and exporting.

Thanks for the patch. I noticed a couple nitpicks with casing:

1. +++ b/core/modules/image/src/Entity/ImageStyle.php
   @@ -28,9 +28,13 @@
     *   label = @Translation("Image style"),
   + *   label = @Translation("Image Description"),
   

   "Image style" is sentence-casing so "Image Description" should be "Image description" to match.

   This would be similar to most other examples in core, e.g.

   label_collection = @Translation("Shortcut sets"),
   label_collection = @Translation("Contact forms"),
   label_collection = @Translation("Aggregator feeds"),
   

   though I do see two using proper-name-casing, e.g.

   label_collection = @Translation("Content Language Settings"),
   label_collection = @Translation("Text Editors"),
   

2. +++ b/core/modules/image/src/Entity/ImageStyle.php
   @@ -28,9 +28,13 @@
     *   label_collection = @Translation("Image styles"),
   + *   label_collection = @Translation("Image Description"),
   

   Same.

3. +++ b/core/modules/image/src/Entity/ImageStyle.php
   @@ -28,9 +28,13 @@
     *   label_singular = @Translation("image style"),
   + *   label_singular = @Translation("image Description"),
   

   "image style" is all lowercase so "image Description" should be "image description" to match. When looking at other examples in core, they are mostly lowercase, e.g.

   label_singular = @Translation("shortcut set"),
   label_singular = @Translation("contact form"),
   label_singular = @Translation("comment type"),
   

   The only exceptions I see are when the text starts with an acronym, e.g.

   label_singular = @Translation("URL alias"),
   label_singular = @Translation("REST resource configuration"),
   

4. +++ b/core/modules/image/src/Entity/ImageStyle.php
   @@ -28,9 +28,13 @@
     *   label_plural = @Translation("image styles"),
   + *   label_plural = @Translation("image Descriptions"),
   

   Same.

Thanks for picking out these issues @kristen-pol, I have fixed these here.

@himanshu_sindhwani It's good to add an interdiff when making updates: https://www.drupal.org/documentation/git/interdiff

Did a quick test and was able to add/edit an image style description using the patch in #10. One thing I noticed was that although I could add multiple lines in the edit form, the formatting doesn't come across in the list though maybe that is similar behavior to other admin screens. I don't have time to double check right now but here are some screenshots.

Hi @kristen-pol, thanks for your workaround. I have fixed the formatting issues. I have made it the same as the content listing on admin/structure/types.

One thing to note here if you want a new line you should try HTML tags like br tag after applying this new patch.

Thanks. I don't have time for a proper review but I noticed a couple things.

1. +++ b/core/modules/image/src/Entity/ImageStyle.php
   @@ -450,0 +451,8 @@
   +  public function getDescription() {
   +    return $this->get('description');
   +  }
   +
   +
   +  /**
   

   Nitpick: Remove extra new line.

2. +++ b/core/modules/image/src/Form/ImageStyleFormBase.php
   @@ -68,6 +68,7 @@
   +      '#description' => t('This text will be displayed on the <em>Image styles</em> page.'),
   

   Change t to $this->t

Correcting these issues.

Updated patch as mentioned in #15. Please review.

Hi @jyotimishra123, I already fixed it in #16. Please don't hide the existing patches which are still running.

@himanshu_sindhwani Based on the timestamps for you and @jyotimishra123 this might have been a crosspost? Not sure.

Thanks for the update. I took a quick look and #17 covered items mentioned in #16. I don't have time for more review right now unfortunately.

Hi @himanshu_sindhwani, sorry!! but i did not hide any running existing patches intentionally, may be it was done by mistake..extremely sorry for this..When i saw this issue it was unassigned so i assigned it to myself and uploaded the patch but i guess our time matched, proof of this is my patch comment number..but you worked on it from starting so you are right my fault, but i thought its unassigned and you are not working on it hence i picked..Apologies again..my fault!!

Oh! yeah I see this may be due to us posting comments without refreshing the page. No issues. I am again uploading the patch with the correct name.

Hi, patch in #23 is not working for me. I have applied this patch in different versions of Drupal like 8.8.9 and 9.1.0 but it did not work.
After applying patch, i can see the description fields in image-style but when i save image-style by adding value in description field it says configuration has been saved but get description field empty. same for listing page of image-style where i cannot see description value.
sharing screenshot for the same.

The steps i followed:
1. Apply patch in #23 - git apply patch
2. Go to image-style edit form to add description - base-url/admin/config/media/image-styles/manage/large
3. visit image-style listing page - http://localhost:8888/admin/config/media/image-styles

i did not get desired result.

Hi @jyotimishra123, the patch is for Drupal version 9.1.x-dev, please check the version of the issue.

Hi @himanshu_sindhwani, the issue was not with version, it was cache issue on my Drupal instance. After clearing cache, patch in #23 is working absolutely fine and now m getting desired result. sharing screenshot for the same.
Thanks!!

This is RTBC from my side.

It didn't appear tests were triggered on the patch so I just started running them.

UPDATED: That didn't seem to work. Not sure why.

Hi @kristen Pol, Hope you fine!! Could you pleases elaborate because i am not able to understand what you saying in #29?
if you are trying to say that patch in #23 is not working then please try once with clearing the cache of Drupal instance.

If you look at #23 or any of the comments with patches, none of the automated tests ran. I tried to trigger them but it didn't work when I tried.

Discussed this with @longwave in Slack and got permission to paste the discussion:

longwave  4 minutes ago
"build successful" often means that the tests failed badly and couldn't report any results (edited) 

longwave  3 minutes ago
the way to check is click on the test link itself e.g. https://www.drupal.org/pift-ci-job/1685386 then "View results on dispatcher" to give you some details

longwave  3 minutes ago
if you then click "Console output" you can see the full details but it is a lot to dig through

kristen_pol  3 minutes ago
Awesome, thanks for the help!

longwave  2 minutes ago
in the console output there are a lot of fatal errors during the tests

longwave  2 minutes ago
usually the best way is pick one of the failing tests and run just that locally and see what happens

longwave  1 minute ago
22:19:12 In ConfigSchemaChecker.php line 95:
22:19:12                                                                                
22:19:12   Schema errors for image.style.large with the following errors: image.style.  
22:19:12   large:description missing schema    

longwave  1 minute ago
this might be relevant

kristen_pol  < 1 minute ago
Woot! Thanks a ton

kristen_pol  2 minutes ago
@longwave Ok if I paste this discussion into the issue?

longwave  2 minutes ago
sure

kristen_pol  2 minutes ago
:thumbsup:

longwave  2 minutes ago
Drupal\Core\Config\Schema\SchemaIncompleteException: Schema errors for image.style.large with the following errors: image.style.large:description missing schema

longwave  1 minute ago
many tests are failing with this

longwave  1 minute ago
a schema needs adding for the new description config key, i think

Moving back to needs work to fix the schema issue.

IMO, if this feature ends up being accepted, @longwave should be given an issue credit. Thanks.

Hi @Kristen Pol
Great!!, the discussion you pasted here, is very informative..
Thank to you and @longwave.

@jyotimishra123 It's good to un-assign the issue if you aren't able to get to it within a few hours. Thanks.

added description field in schema

Thanks for the update.

+++ b/core/modules/image/config/schema/image.schema.yml
@@ -9,6 +9,9 @@ image.style.*:
+    description:
+      type: text
+      label: 'Description'

I think this should be label to allow it to be translated though I see that block_content.schema.yml uses text.

Looking further I see that node.schema.yml also uses text so I guess this is ok as it's consistent with other code.

    description:
      type: text
      label: 'Description'

If these needs tests, the proper tag is "Needs tests".

Whoops. Fixing tag.

ok thanks @Kristen Pol . I will take care of tags next time

Attempted following items:
- Fix test case failures
- Add method to check if added description is present in testStyle method.
- Remove overridden labels from the ImageStyle config Entity. Overridden lables causing issues in other site backend. We don't need to override or tweak labels as we are just adding the description field.

Applied #10 patch is working fine added description field and saving value in the description field.
But #38 and #47 these patches not saving the value in description field
sharing the screenshot....

Attempted the following items in #47
- Fix test case failures
- Add method to check if the added description is present in testStyle method.
- Remove overridden labels from the ImageStyle config Entity. Overridden lables causing issues in other site backend. We don't need to override or tweak labels as we are just adding the description field.

Resolving PHPCs issues in this patch.

Patch #49 stores description.

RTBC + 1

Above patch Working as expected , added description field & store the description.

Before Patch:

After Patch:

Patch no #49 is working fine in drupal9.2. i updated attachment and changing status.

1. +++ b/core/modules/image/config/schema/image.schema.yml
   @@ -9,6 +9,9 @@ image.style.*:
   +    description:
   +      type: text
   +      label: 'Description'
   

   Should add nullable: true

2. +++ b/core/modules/image/src/Entity/ImageStyle.php
   @@ -49,7 +49,8 @@
   + *     "description" = "description"
   

   Could we add a comma at the end of line?

3. +++ b/core/modules/image/src/Entity/ImageStyle.php
   @@ -440,6 +449,13 @@ public function setName($name) {
   +  public function getDescription() {
   
   +++ b/core/modules/image/src/ImageStyleInterface.php
   @@ -28,6 +28,14 @@ public function getName();
   +  public function getDescription();
   

   As this is a new method we can strict type the method return.

Updated patch in #49 addressing #53.1, #53.2 and #53.3, kindly review.

Thanks!

Trying to fix test failures.

Fixing test errors.

Fixing custom commands failure errors.

Patch #60 still works and address the issues pointed at comment #53.

I'm not sure if we should add this either, so I'm tagging for product manager review.

Also, assuming we do add it - why not add descriptions to the image styles shipped with core and install profiles? Otherwise we're going to show a list of image styles with empty descriptions out of the box, which seems odd.

patch #60 applied successfully for 9.3.x-dev

Updating issue summary with latest screenshots.

The Needs Review Queue Bot tested this issue. It either no longer applies to Drupal core, or fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

Apart from a re-roll or rebase, this issue may need more work to address feedback in the issue or MR comments. To progress an issue, incorporate this feedback as part of the process of updating the issue. This helps other contributors to know what is outstanding.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.