[Labels] Make the Ellipses section more clear
ClosedPublic

Authored by ngraham on Aug 14 2018, 6:07 PM.

Details

Summary

This patch rewrites the Ellipses section to accomplish two goals:

  • Provide clearer guidelines for when to use ellipses and when not to use ellipses
  • Correct an error that mistakenly suggested that Configure [something] should not have an ellipsis because it does not require user input; it most certainly does! User input is the whole point, in fact.

Diff Detail

Repository
R985 KDE Human Interface Guidelines
Branch
configure-ellipses (branched from master)
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 1864
Build 1882: arc lint + arc unit
ngraham requested review of this revision.Aug 14 2018, 6:07 PM
ngraham created this revision.
ngraham updated this revision to Diff 39743.Aug 14 2018, 6:09 PM

Remove "Check Spelling..." since its title alone isn't enoughh information to determine whether it meets the criteria; implementation detauls could make it go either way

ngraham updated this revision to Diff 39744.Aug 14 2018, 6:10 PM

Unify wording for two sections

ngraham edited the summary of this revision. (Show Details)Aug 14 2018, 6:13 PM
ngraham updated this revision to Diff 39749.Aug 14 2018, 8:12 PM

Remove reference to "in a separate window", since that's not true

abetts added a subscriber: abetts.Aug 14 2018, 10:47 PM

Remove reference to "in a separate window", since that's not true

Thanks for pointing out the logic break there. I favor this change.

romangg requested changes to this revision.Aug 15 2018, 6:59 AM

That's a very nice change. I especially like that reasons are given when ellipses should not be used. As for writing style, I always try to minimize the usage of parentheses, since too many of them are distracting when reading. Maybe state the reasons with an em dash instead (you could additionally write the reason italic):

About — not an action

source/style/writing/labels.rst
108

Since some of these examples can also be without additional user input, but typically they are with, better use:

Here are examples of menu items and buttons whose labels typically have ellipses:

This revision now requires changes to proceed.Aug 15 2018, 6:59 AM
ngraham updated this revision to Diff 39758.Aug 15 2018, 7:10 AM

Address review comments

romangg accepted this revision.Aug 15 2018, 8:00 AM
This revision is now accepted and ready to land.Aug 15 2018, 8:00 AM
ngraham marked an inline comment as done.Aug 15 2018, 10:36 AM

Looks like I don't have commit rights:

 PUSHING  Pushing changes to "origin/master".
FATAL: W any websites/hig-kde-org ngraham DENIED by fallthru
ngraham closed this revision.Aug 16 2018, 8:29 PM