Page MenuHomePhabricator

Reconsider the wording about "global gadget" in the Previews features
Closed, ResolvedPublic1 Estimated Story Points

Description

This is a follow-up to T265709.

In the patch for that task three messages were added, which mention "global gadget settings and user scripts". Do we actually have "global gadget settings"? It would be nice to have Global gadgets, and it was even voted #1 in the Community Wishlist Survey 2016, but as far as I know it wasn't implemented.

I suspect these messages should be reworded.

If we actually do have "global gadget settings", the messages should link to them directly. Evidently, I don't know where they are :)

When you update the messages, please also remove the spaces before and after the | character in the links.

Event Timeline

Lena_WMDE set the point value for this task to 1.Mar 3 2021, 9:20 AM

Remove "global" from the messages.

Change 668025 had a related patch set uploaded (by WMDE-Fisch; owner: WMDE-Fisch):
[mediawiki/extensions/Popups@master] Remove "global" in i18n

https://gerrit.wikimedia.org/r/668025

We got a valid concern from @Amire80 on the patch.

I'm not sure that totally removing "global" is the right thing to do. The old text is: "Certain gadgets and other customizations may affect the performance of this feature. If you experience problems please review your gadgets and user scripts, including global ones." Mentioning global user scripts may be a good idea.

So we might want to use that same wording. Instead of

please review your global gadget settings and user scripts.

lets use

please review your gadgets and user scripts, including global ones.

I'm not a fan of ", including global ones.", I would leave that out. It doesn't add a lot of value (users can read about user scripts and their madness), while adding a lot of confusion (global gadgets? global user scripts? Do I have defaults already? Oh god)

Change 668025 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] Change wording around gadgets and user scripts

https://gerrit.wikimedia.org/r/668025

Change 668340 had a related patch set uploaded (by Thiemo Kreuz (WMDE); owner: Thiemo Kreuz (WMDE)):
[mediawiki/extensions/Popups@master] Minor tweaks to the wording of gadget-related messages

https://gerrit.wikimedia.org/r/668340

[…] "including global ones" […] doesn't add a lot of value […] while adding a lot of confusion […]

I tend to disagree. On the one hand, it's true, it might add confusion. We probably don't loose much by removing "including global ones". Still I find the hint helpful. There are many places where user scripts can live. Having global ones is not uncommon. The same time, more and more stuff actually becomes global: GlobalCssJs, MediaWiki-extensions-GlobalPreferences, MediaWiki-extensions-GlobalWatchlist. Not everybody knows or remembers what is what, and where they added user scripts.

Do we really expect users to come to us and complain specifically about "global gadgets" just because of this sentence?

Change 668340 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] Minor tweaks to the wording of gadget-related messages

https://gerrit.wikimedia.org/r/668340

I'm happy with the text as it is after recent changes, so only continuing this part of the conversation out of mild curiosity and because it might be relevant to other user-facing text we add in the future.

Do we really expect users to come to us and complain specifically about "global gadgets" just because of this sentence?

The explanatory text is not important for using the feature, it's actually intended for people who experience bugs. I expect (and hope for!) those people to complain regardless, so that we learn what new combinations of gadgets and scripts might interfere. But I find it strange to drag this text out for such an edge case. It's as if we're installing windows and we leave a big disclaimer, "caution, if you smudge unexpected substances and kid hands all over this window it will cease to be transparent", it's not something that a person actually needs to see when they're in a preferences dialog. The focus of the dialog is to explain what the feature will do if you enable it. It's beside the point and jumping several steps ahead to a) assume the user will turn on the feature b) will experience problems that might cause it to malfunction, and c) has configured currently unknown-to-us conflicting features which caused the error.

I would be happy to remove the entire "might not work" sentence and just wait for people to send us concrete bug reports...

@Andrew-WMDE checked on current text and, as the current text is "please review your {{int:prefs-gadgets}} preferences and user scripts, including global ones", I would like to keep it as is. It is a helpful hint and removing it doesn't reduce the length of the text much. In future we may think about shortening the text, or removing the "might not work" sentence, but I recommend that we consider this task complete as long as the spaces before and after the | character in the links have also been removed.

Sorry about dragging it through so many cycles, but I have a comment about the latest one.

At the current file you use {{int:prefs-gadgets}}. This is really not great, because in some languages the word can change according to grammar.

It's better to just write "Gadgets" in plain English, and explain in qqq that the word must be based on that message. Add something like this to the qqq string: The word "gadgets" must be based on {{msg-mw|prefs-gadgets}}. If you do this, it will be easy to translate, and translatewiki will show this documentation in a clear and relevant manner to every localizer.

Change 668711 had a related patch set uploaded (by Thiemo Kreuz (WMDE); owner: Thiemo Kreuz (WMDE)):
[mediawiki/extensions/Popups@master] Don't use {{int:…}} in full sentence messages

https://gerrit.wikimedia.org/r/668711

Change 668711 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] Don't use {{int:…}} in full sentence messages

https://gerrit.wikimedia.org/r/668711