Problem/Motivation

Found in #2580575: Installing a module can delete config translations

views.style.table schema has incorrect label for 'description'
Currently, the config schema label for both 'caption' and 'description' are "Caption". That results in two fields labeled "Caption" in the configuration translation form.

specifically, the "Caption" element of the style settings of a table View (in my case, I tried it with the /admin/content View

steps to reproduce

  1. install standard profile
  2. enable config_translation
  3. add any language
  4. translate the view admin/structure/views/view/content/translate
  5. open: displays, master display settings, content default display options, format, table

Proposed resolution

Fix the description in the schema.

Remaining tasks

Contributor tasks needed
Task Novice task? Contributor instructions Complete?
Add steps to reproduce the issue Novice Instructions
Embed before and after screenshots in the issue summary Novice Instructions
Review patch to ensure that it fixes the issue, stays within scope, is properly documented, and follows coding standards Instructions

User interface changes

before

after

No (no new patterns, just correcting the label)

API changes

No

Data model changes

No

Files: 
CommentFileSizeAuthor
#9 translate-after.png89.65 KBYesCT
#8 2581399.8.patch877 bytesYesCT
PASSED: [[SimpleTest]]: [PHP 5.5 MySQL] 116,228 pass(es). View
#8 interdiff.2581399.1.8.txt798 bytesYesCT
#7 translate-with-values.png187.8 KBYesCT
#7 values.png72.75 KBYesCT
#6 in-the-ui.png186.63 KBYesCT
#5 two-captions.png227.7 KBYesCT
views-description-label.patch491 byteseffulgentsia
PASSED: [[SimpleTest]]: [PHP 5.5 MySQL] 116,245 pass(es). View

Comments

effulgentsia created an issue. See original summary.

YesCT’s picture

Issue summary: View changes
YesCT’s picture

Gábor Hojtsy’s picture

We don't say "Table caption" either. Is "Table description" the UI text used on the admin UI for this field? We usually try to match that because then people can match the things together AND the translations would also be the same (easy!)

YesCT’s picture

Issue summary: View changes
FileSize
227.7 KB
YesCT’s picture

FileSize
186.63 KB

maybe here... I'm not sure yet.

YesCT’s picture

FileSize
72.75 KB
187.8 KB

yeah, when I put in values, then I can see.

YesCT’s picture

FileSize
798 bytes
877 bytes
PASSED: [[SimpleTest]]: [PHP 5.5 MySQL] 116,228 pass(es). View

I think this makes those match the UI. (didn't check *everything* in this UI)

YesCT’s picture

Issue summary: View changes
FileSize
89.65 KB

which makes the translate form (after a drush cr) look like

Gábor Hojtsy’s picture

Status: Needs review » Reviewed & tested by the community

Yay, looks good!

YesCT’s picture

Issue tags: +Configuration schema, +D8MI

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 8: 2581399.8.patch, failed testing.

Gábor Hojtsy’s picture

Status: Needs work » Reviewed & tested by the community
Issue tags: +sprint, +language-config

Test fails were entirely unrelated.

xjm’s picture

Status: Reviewed & tested by the community » Needs review

Several questions to figure out what of this, if any, can go into a patch release:

  • Do these labels themselves get translated? I.e. would this break the text for translators who are translating?
  • Or would it break existing config translations?
  • Is this something that gets stored in config and would require an upgrade path?
  • Why is there (empty) and blank fields in the before description, but table names in the after descruption? Is that also caused by this patch somehow, or were the screenshots just produced slightly differently?

The third option, with the duplicated "Caption", is obviously just plain wrong. However, now that 8.0.0 is released, we should possibly separate the improvements for the other two strings and have those go into 8.1.x instead, to reduce the disruption for translations. References: https://www.drupal.org/core/d8-allowed-changes#minor and https://www.drupal.org/core/d8-bc-policy

@Gábor Hojtsy, thoughts?

Gábor Hojtsy’s picture

Status: Needs review » Reviewed & tested by the community

@xjm: yes, they are displayed in the core config translation UI, as screenshot in the summary; yes they would change translatable strings, but these are minor (and the original ones don't make sense, the changing strings are not a reason to keep the UI that does not make sense).

On the other hand this will not break existing configuration and is not something stored in configuration, and will not need an upgrade path. The strings are merely used to display the config translation UI (in core). They are not stored anywhere.

As for which changes to put into which versions, the "new" strings are already used in views, in fact the views schema should have just used the same strings as the views UI, which in fact means LESS work for translators:

$ git grep "Caption for the table"
core/modules/views/src/Plugin/views/style/Table.php:      '#title' => $this->t('Caption for the table'),
$ git grep "Summary title"
core/modules/views/src/Plugin/views/style/Table.php:      '#title' => $this->t('Summary title'),
$ git grep "Table description"
core/modules/views/src/Plugin/views/style/Table.php:      '#title' => $this->t('Table description'),

In short, this patch removes a few incorrect strings and replaces them with strings that are already in core (and already translated), so while it is no work for translators, it also improves the translation user interface without needing an upgrade path. That sounds like win-win-win.

xjm’s picture

Thanks @Gábor Hojtsy! Based on that it also sounds to me like it will be good to include this fix in a patch release.

catch’s picture

Status: Reviewed & tested by the community » Fixed

Committed/pushed to 8.1.x and cherry-picked to 8.0.x. Thanks!

  • catch committed 5e3847d on 8.1.x
    Issue #2581399 by YesCT, effulgentsia: views.style.table schema has...

  • catch committed 94dd2b9 on
    Issue #2581399 by YesCT, effulgentsia: views.style.table schema has...
xjm’s picture

Issue tags: +String change in 8.0.1
Gábor Hojtsy’s picture

Issue tags: -sprint

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.