Follow up for #1869328: Restore simplicity of language list

Problem/Motivation

A help text entry for the "language selection order" control is needed. The extent of the effect of the language order control is not readily apparent and a help message would be useful.

Proposed resolution

  • (done) change help text that says what the control does.
  • (not doing this) add feedback message (when languages are reordered) saying what it did and the result.

Remaining tasks

Without patch, with only one language

Without patch, with more than one languages

User interface changes

Improve help text.
There is no interface changes.

API changes

No API changes expected.

Comments

fenda’s picture

Assigned: Unassigned » fenda

Taking on this task. Should be a quick one but it's my first core patch so who knows?

fenda’s picture

Status: Active » Needs review
StatusFileSize
new1.08 KB

Patch attached for adding extra help text to cover this issue.

Generally the help test on the language list page could be improved. It doesn't really say anywhere what the admin is actually looking at which might be useful for first time users. But that's another issue?

yesct’s picture

+++ b/core/modules/language/language.moduleundefined
@@ -24,7 +24,7 @@ function language_help($path, $arg) {
-      return '<p>' . t('With multiple languages enabled, registered users may select their preferred language and authors can assign a specific language to content.') . '</p>';
+      return '<p>' . t('With multiple languages enabled, registered users may select their preferred language and authors can assign a specific language to content. The order of languages in the table below only affects language selection form elements found, for example, when specifying a contents language.') . '</p>';

The: when specifying a content's language, sounded strange to me. How about:

The order of languages in the table below affects the order languages appear in the language selection form element, for example, when editing or creating content.

DeNelo’s picture

The second comma (after "for example") makes the sentence ambigous. When I first read it, I understood the "example" to pertain to "the language selection form element", not to "editing or creating content".
Should be like this imho (also threw in an "in which" after the second "order"):
"The order of languages in the table below affects the order in which languages appear in the language selection form element, for example when editing or creating content."

tammo’s picture

In another issue I wrote a proposal for a new text for this page. Please review

http://drupal.org/node/1998516#comment-7433280

pixelite’s picture

StatusFileSize
new1.2 KB

I think the text in #3 is a bit verbose. We should also mention this ordering effects the order of languages in the language switcher. Attaching a patch with this change:

-      return '<p>' . t('With multiple languages enabled, registered users may select their preferred language and authors can assign a specific language t    o content. The selection of what language is used to display page elements is made depending on the detection menthod settings in the <a href="@detection">    Detection and Selection</a> tab.', array('@detection' => url('admin/config/regional/language/detection'))) . '</p>';
 10 +      return '<p>' . t('Reordering the languages below will effect the order in which they appear in the language switcher and, when editing content, the     language selector widget.') . '</p>';
DeNelo’s picture

Three things to #6:
Typo: "detection menthod" -> "detection method"
Also, "The selection of what" -> "The selection of which"
Finally, "will effect" -> "will affect"

attiks’s picture

Issue tags: +Needs usability review

taging

KCarlile’s picture

StatusFileSize
new1.26 KB

After reading through the issue, I think #7 misunderstood that the patch in #6 had already addressed those issues. Also, I think the patch in #6 didn't completely address the spirit of the issue, so I've added the following text to the end of the string: " The ordering in this table does not impact fallback behavior."

Also, I did test the patch in #6 and it worked.

diff --git a/core/modules/language/language.module b/core/modules/language/language.module
index 1dd936f..57134bb 100644
--- a/core/modules/language/language.module
+++ b/core/modules/language/language.module
@@ -24,7 +24,7 @@ function language_help($path, $arg) {
       return $output;
 
     case 'admin/config/regional/language':
-      return '<p>' . t('With multiple languages enabled, registered users may select their preferred language and authors can assign a specific language to content. The selection of what language is used to display page elements is made depending on the detection menthod settings in the <a href="@detection">Detection and Selection</a> tab.', array('@detection' => url('admin/config/regional/language/detection'))) . '</p>';
+      return '<p>' . t('Reordering the languages below will effect the order in which they appear in the language switcher and, when editing content, the language selector widget. The ordering in this table does not impact fallback behavior.') . '</p>';
 
     case 'admin/config/regional/language/add':
       return '<p>' . t('Add a language to be supported by your site. If your desired language is not available, pick <em>Custom language...</em> at the end and provide a language code and other details manually.') . '</p>';
lydie’s picture

StatusFileSize
new1.26 KB

Here is the revised version for #9 which seems just perfect.
I just changed the typo "effect" for "affect".

KCarlile’s picture

Shoot, I missed that one. Thank you! :)

KCarlile’s picture

KCarlile’s picture

DeNelo’s picture

#9 OK, I didn't get that. I guess when you say "Attaching a patch with this change:" and then list code, I thought that that was the change... :)
Should have looked at the actual patch.

yoroy’s picture

Issue tags: -Needs usability review

So this is a case of adding text to explain an inconsistent UX. Any change we can remove the cause for the inconsistency instead of stop gap explanations?

parthipanramesh’s picture

Issue summary: View changes
Status: Needs review » Reviewed & tested by the community

Seems to look fine. Thank you!

ianthomas_uk’s picture

Status: Reviewed & tested by the community » Needs work
+++ b/core/modules/language/language.module
@@ -24,7 +24,7 @@ function language_help($path, $arg) {
-      return '<p>' . t('With multiple languages enabled, registered users may select their preferred language and authors can assign a specific language to content. The selection of what language is used to display page elements is made depending on the detection menthod settings in the <a href="@detection">Detection and Selection</a> tab.', array('@detection' => url('admin/config/regional/language/detection'))) . '</p>';
+      return '<p>' . t('Reordering the languages below will affect the order in which they appear in the language switcher and, when editing content, the language selector widget. The ordering in this table does not impact fallback behavior.') . '</p>';

I don't think this new text is an improvement, because:
- It no longer suggests langauge-selection features will be shown/hidden depending on the number of languages enabled.
- 'language switcher' and 'language selector widget' sound overly technical. I'd prefer something like 'list of available languages'
- It loses any explaination of how fallback DOES happen.

The issue summary could also use an update before being set to RTBC.

--------

@yoroy the order the languages are shown to a user (e.g. alphabetically or by region) is a different problem to how to choose a users default language (e.g. by domain name example.us vs example.co.uk; by ip address; by browser settings).

--------

This help text in D8 HEAD was changed in #1803638: Improve default language change process (ui and help text) which was committed between patches #2 and #6. I think the new text solves the problem described and therefore suggest this is closed as a duplicate.

fenda’s picture

Assigned: fenda » Unassigned
schnitzel’s picture

I don't think that this issue is solved with #1803638: Improve default language change process (ui and help text)

It currently says:

With multiple languages enabled, registered users may select their preferred language and authors can assign a specific language to content. The selection of what language is used to display page elements is made depending on the detection menthod settings in the Detection and Selection tab.

So it's not yet clear what reordering does.

edmoran’s picture

Issue summary: View changes
balagan’s picture

Issue summary: View changes
StatusFileSize
new1.52 KB

Patch #10 also drops the last part of the message of patch 9 about the fallback behavior. I have readded that, and made changes according to ianthomas_uk's comment in comment #17

balagan’s picture

Status: Needs work » Needs review

Status: Needs review » Needs work

The last submitted patch, 21: language-list-order-help-1870746-21.patch, failed testing.

balagan’s picture

Assigned: Unassigned » balagan
balagan’s picture

StatusFileSize
new1.52 KB

This should be fine now, the text actually says:
Reordering the languages below will affect the order in which the enabled languages appear in the language switcher and, when editing content, in the list of available languages. The ordering in this table does not impact fallback behavior. The selection of the language to display the page elements is made depending on the detection method settings in the <a href="@detection">Detection and Selection</a> tab.'

balagan’s picture

Assigned: balagan » Unassigned
Status: Needs work » Needs review
robertdbailey’s picture

StatusFileSize
new1.43 KB

Patch #25 still seemed a bit wordy, and I got confused about "fallback behavior", since the next sentence did not seem related (even though it was). So, I've shortened it, and hopefully it still gives the right meaning and link.

balagan’s picture

..."does not impact fallback behavior in language fallback behavior."...

This sounds awkward.

How about ..."does not impact the fallback behavior set on the @link tab. ?

balagan’s picture

Assigned: Unassigned » balagan
Status: Needs review » Needs work
balagan’s picture

Assigned: balagan » Unassigned

Accidentally assigned to myself, unassigning now...

robertdbailey’s picture

StatusFileSize
new1.41 KB

@balagan pointed out some better wording. Resubmitting patch.

robertdbailey’s picture

Status: Needs work » Needs review
yesct’s picture

Issue summary: View changes
Issue tags: +Needs screenshots

To get rid of the idea of "enabled" languages (which is not exposed in this table anymore),
and make this shorter...

Instead of

Reordering the languages below will affect the order in which the enabled languages appear in the language switcher and, when editing content, in the list of available languages. The ordering in this table does not impact fallback behavior on the <a href="@detection">Detection and Selection</a> tab.

How about:

Reordering languages affects the order in which these languages appear in the language switcher and, when editing content, in the list of available languages. The order here does not impact the fallback behavior on the <a href="@detection">Detection and Selection</a> tab.

?

------

I think it would help to have a screenshot (with only one language, and with multiple languages) of the page/tab/table we are trying to describe.
Please upload screenshots in a comment and embed them in the issue summary.
(instructions to do that: https://drupal.org/contributor-tasks/add-screenshots)

tagging.

balagan’s picture

For my part I think 'enabled languages' gives a hint for the user how languages can be added to the list. I vote for accepting the patch in#31

stijndmd’s picture

I'd like to help, but I don't see the use for screenshots of descriptions. Maybe I am missing something here.

The patch in #31 works and the description seems very clear to me.

sweetchuck’s picture

Both 2 screenshots were taken without the patch. One with only the English language, the other with 3 languages.

sweetchuck’s picture

Issue summary: View changes
Issue tags: -Needs screenshots

Update the issue summary and embed the screenshots from comment #36

balagan’s picture

StatusFileSize
new147.53 KB

I am adding an image with the last patch applied.

robertdbailey’s picture

StatusFileSize
new1.38 KB

modified the patch to go with the wording by @YesCT in #33, if this is preferable to the committers.

balagan’s picture

StatusFileSize
new1.38 KB

Patch in comment 6 took out a lot of information, 9 put back the "fallback" expression, that does not appear on the related pages.
The text after the current patch says:

"Reordering the languages below will affect the order in which the added languages appear in the language switcher and, when editing content, in the list of selectable languages. The ordering in this table does not impact Detection and selection."

In this way we avoided the improper 'enabled' and the 'fallback' expressions, we keep the information, and the text gets shorter too, but the link to set the detection and selection remains.

Patch in comment 39 seems to be different from previous last patch only with the omission of the first "the".
I don't think that is a necessary change.

balagan’s picture

Sorry, I started writing the patch, and I thought I will quickly send it in, but we got a prolonged discussion, and by the time I have sent in patch #39, I have overwritten yours.

sweetchuck’s picture

Status: Needs review » Reviewed & tested by the community

I think the suggested help text in patch #40 is clear and consistent. Short enough but contains every necessary information.

yoroy’s picture

Status: Reviewed & tested by the community » Needs review

Current proposal:

Reordering the languages below will affect the order in which the added languages appear in the language switcher and, when editing content, in the list of selectable languages. The ordering in this table does not impact Detection and selection.

Maybe this communicates the same necessary info but shorter and simpler:

Reorder languages to change their order in the language switcher and, when editing content, in the list of selectable languages. This ordering does not impact detection and selection.
balagan’s picture

It just loses the information we tried to preserve, namely, that languages can be added.

balagan’s picture

StatusFileSize
new1.33 KB

Changed tha second part according to the above suggestion, but have put back the word "added" in front of languages.

yoroy’s picture

Status: Needs review » Reviewed & tested by the community

Thank you.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 45: language-list-order-help-1870746-45.patch, failed testing.

vastav’s picture

Status: Needs work » Needs review
yesct’s picture

Issue summary: View changes

cleaned up the issue summary.

I agree using "fallback" in the help text is not desirable, thanks for taking that out.
I agree using "added" now is better, we do not "enable" languages. we add them.

also read the patch. I dont see any errors. the information is accurate.

I wonder if it would be more helpful instead of
"in the language switcher"
to say
"in the language switcher block"

If I recall correctly the language switcher block is not on by default. So if someone reads this, and we say block, they have a hint of where to go to turn on the language switcher.

balagan’s picture

StatusFileSize
new1.33 KB

I have added the word "block" to the sentence, and changed the second word "change" to "set":

Text in earlier patch (45):
Reorder the added languages to change their order in the language switcher and, when editing content, in the list of selectable languages. This ordering does not impact detection and selection.

Text in new patch (50):
Reorder the added languages to set their order in the language switcher block and, when editing content, in the list of selectable languages. This ordering does not impact detection and selection.

Status: Needs review » Needs work

The last submitted patch, 50: language-list-order-help-1870746-50.patch, failed testing.

yesct’s picture

Status: Needs work » Needs review

50: language-list-order-help-1870746-50.patch queued for re-testing.

[edit:]
fail was:
Drupal\config\Tests\ConfigImportAllTest->testInstallUninstall() failing

looked at the test results, in the error log and found:

Fatal error: Maximum execution time of 240 seconds exceeded in /var/lib/drupaltestbot/sites/default/files/checkout/core/vendor/symfony/yaml/Symfony/Component/Yaml/Parser.php on line 542
FATAL Drupal\config\Tests\ConfigImportAllTest: test runner returned a non-zero error code (255).

robertdbailey’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new24.53 KB
new27.48 KB

Attached are screenshots with the patch applied. The wording seems simple enough and correct.

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Committed bfa4a9f and pushed to 8.x. Thanks!

  • Commit bfa4a9f on 8.x by alexpott:
    Issue #1870746 by balagan, robertdbailey, lydie, KCarlile, pixelite,...

Status: Fixed » Closed (fixed)

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