Make Appearance KCMs' labels consistent
ClosedPublic

Authored by filipf on Feb 10 2019, 4:56 PM.

Details

Summary

With the purpose of making KCMs more consistent and following the HIG, this patch does the following:

  • Converts all .desktop file "Comment" values into action(verb)-style labels
  • Drops the use of articles in "Comment" values
  • Changes the KAboutData i18n strings so that they match the respective KCM's name

Diff Detail

Repository
R119 Plasma Desktop
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
filipf created this revision.Feb 10 2019, 4:56 PM
Restricted Application added a project: Plasma. · View Herald TranscriptFeb 10 2019, 4:56 PM
Restricted Application added a subscriber: plasma-devel. · View Herald Transcript
filipf requested review of this revision.Feb 10 2019, 4:56 PM
filipf updated this revision to Diff 51329.Feb 10 2019, 5:08 PM

address metadata.desktop files; add another change for app style

GB_2 accepted this revision.Feb 10 2019, 5:14 PM

Perfect!

This revision is now accepted and ready to land.Feb 10 2019, 5:14 PM
ngraham requested changes to this revision.EditedFeb 10 2019, 5:45 PM

Why are we doing this? The current ones (mostly) read like natural sentences, as tooltips should; this new style is more like a title, but it's *not* a title. If we are trying to work around the fact that the tooltip text is displayed as a header on the KCMs themselves by making the header text more titular, we should not try to force the comment to be a title, but rather display the actual title there instead and have the comment be a subtitle or something.

This revision now requires changes to proceed.Feb 10 2019, 5:45 PM

So you had all these comments changed to be "more natural" and now you change them back to how they were before?

Exactly. Let's not go in circles here.

The comment field in the desktop file and the KAboutData description are really meant to be tooltips or captions, not titles. Let's not try to awkwardly force them to be titles as a workaround for the fact that our KCMs headers inappropriately display their text instead of real title text.

GB_2 added a comment.Feb 12 2019, 4:19 PM

We currently use the KAboutData name in headers, we can easily change them to real titles and leave the desktop files how they are currently (explanation sentences). Should we just use the KCM name in the header or something more explaining like "Look and Feel Theme Selection"?

Putting the KCM name in the header would make semantic sense, though then we would have triple name duplication: in the header, in the sidebar, and in the titlebar. Maybe that's not so bad as long as they all display the same text though.

filipf updated this revision to Diff 51597.Feb 13 2019, 3:19 PM

use verb style headers

Bah sorry, it pulled in some other non-related changes as well. Will fix if I figure out how or open up a new diff.

filipf updated this revision to Diff 51598.Feb 13 2019, 3:21 PM

try to fix it?

filipf updated this revision to Diff 51601.EditedFeb 13 2019, 3:40 PM

Fixed now.

filipf updated this revision to Diff 51602.Feb 13 2019, 3:55 PM

KAboutData i18n is the same as Name

Perfect. This strikes me as the exactly correct way to do it: The KAboutData string shows a real title, and the Comment provides the tooltip text. Can we do this for the few remaining KCMs in the appearance section too?

Looks like there's a bug in the font management KCM: it ignores the KAboutData string and always displays the comment.

Perfect. This strikes me as the exactly correct way to do it: The KAboutData string shows a real title, and the Comment provides the tooltip text. Can we do this for the few remaining KCMs in the appearance section too?

Looks like there's a bug in the font management KCM: it ignores the KAboutData string and always displays the comment.

Yes, we need 2 new patches though because Window Decorations and GTK Style are in different repos.

For this patch (and moving forward) we still have 2 dilemmas left then:

  • remove the article -> "Configure system fonts" instead of "Configure the system fonts"?
  • capitalize Look and Feel? Or just do "Choose (the) look and feel theme"?

For this patch (and moving forward) we still have 2 dilemmas left then:

  • remove the article -> "Configure system fonts" instead of "Configure the system fonts"?

My recommendation:

  • For the UI-related font KCM: "Choose user interface fonts" or something like that
  • For the font installer KCM, we could expose some more of its power via the tooltip and make the comment something more like "Install, manage, and organize system fonts"
  • capitalize Look and Feel? Or just do "Choose (the) look and feel theme"?

For the title, "Look And Feel" is good. For the tooltip, my recommendation is "Choose the Look and Feel theme".

GB_2 accepted this revision.Feb 13 2019, 5:25 PM

For this patch (and moving forward) we still have 2 dilemmas left then:

  • remove the article -> "Configure system fonts" instead of "Configure the system fonts"?

My recommendation:

  • For the UI-related font KCM: "Choose user interface fonts" or something like that
  • For the font installer KCM, we could expose some more of its power via the tooltip and make the comment something more like "Install, manage, and organize system fonts"
  • capitalize Look and Feel? Or just do "Choose (the) look and feel theme"?

For the title, "Look And Feel" is good. For the tooltip, my recommendation is "Choose the Look and Feel theme".

In the tooltip Look and Feel should be lowercase, then it's correct.
Other theme types are lowercase too and it's not a brand.

GB_2 requested changes to this revision.Feb 13 2019, 5:28 PM
This revision now requires changes to proceed.Feb 13 2019, 5:28 PM
GB_2 added a comment.EditedFeb 13 2019, 5:28 PM

Oops, didn't want to accept yet

filipf updated this revision to Diff 51616.Feb 13 2019, 6:07 PM

get rid of articles, better wording

ngraham accepted this revision.Feb 13 2019, 6:13 PM

Looking good to me now!

I notice that the font installation and Emoticons KCMs display the comment rather than the KAboutData string in their headers, but this is a bug unrelated to your patch. Still, we should figure out what's going on and fix it in another patch.

BTW could you explain the changes in more detail in the Summary section?

filipf edited the summary of this revision. (Show Details)Feb 13 2019, 6:31 PM

BTW could you explain the changes in more detail in the Summary section?

Sure, just did that now. Sounds pretty technical but I think it summarizes everything done here.

GB_2 accepted this revision.Feb 13 2019, 7:25 PM
GB_2 edited the summary of this revision. (Show Details)
This revision is now accepted and ready to land.Feb 13 2019, 7:26 PM
This revision was automatically updated to reflect the committed changes.