Bug 28877

Summary: Use of both 'Caps Lock' and 'CapsLock'
Product: xkeyboard-config Reporter: Simos Xenitellis <simos.bugzilla>
Component: GeneralAssignee: xkb
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: medium Keywords: NEEDINFO
Version: unspecified   
Hardware: Other   
OS: All   
Whiteboard:
i915 platform: i915 features:
Attachments: Patch for Scroll Lock
Patch for Num Lock
Patch for Caps Lock
Screenshot showing most messages relating to CapsLock text.

Description Simos Xenitellis 2010-07-01 15:11:42 UTC
A user (launchpad) noticed that Caps Lock is sometimes found as 'CapsLock' (that is, without a space in between, in messages.

Is this considered a typo?
As far as I have seen, this is found in base.xml.in.

The en_GB localisation translates CapsLock to Caps Lock.
Comment 1 Sergey V. Udaltsov 2010-07-01 15:46:23 UTC
Actually in all cases in base.xml.in it is written as CapsLock. Where do you see it as Caps Lock?
Comment 2 Simos Xenitellis 2010-07-01 16:26:31 UTC
(In reply to comment #1)
> Actually in all cases in base.xml.in it is written as CapsLock. Where do you
> see it as Caps Lock?

You are right, there is no Caps Lock in rules/*. I mixed it up with po/* where it is translated to Caps Lock.
Comment 3 Sergey V. Udaltsov 2010-07-01 16:31:42 UTC
Well, the translations are managed by TP. I do not have much influence there...
Comment 4 Simos Xenitellis 2010-07-02 05:37:24 UTC
(In reply to comment #3)
> Well, the translations are managed by TP. I do not have much influence there...

From the maintainer's side, you may choose to update base.xml.in so that CapsLock becomes Caps Lock. 
There is no significant work for the translators side as they just need to unfuzzy a few messages that are already translated correctly.
Comment 5 Simos Xenitellis 2010-07-02 05:38:20 UTC
Created attachment 36679 [details] [review]
Patch for Scroll Lock

Adding for comparison on the extent of the changes.
Comment 6 Simos Xenitellis 2010-07-02 05:38:46 UTC
Created attachment 36680 [details] [review]
Patch for Num Lock

Adding for comparison on the extent of the changes.
Comment 7 Simos Xenitellis 2010-07-02 05:39:15 UTC
Created attachment 36681 [details] [review]
Patch for Caps Lock

Adding for comparison on the extent of the changes.
Comment 8 Sergey V. Udaltsov 2010-07-02 12:32:10 UTC
I actually do not know what is the right way. What would be correct English: CapsLock or Caps Lock?
Comment 9 Simos Xenitellis 2010-07-02 15:03:49 UTC
(In reply to comment #8)
> I actually do not know what is the right way. What would be correct English:
> CapsLock or Caps Lock?

I believe it should be Caps Lock.

All references point to 'Caps Lock'; http://en.wikipedia.org/wiki/Caps_lock 
which follow Num Lock and Scroll Lock.
Comment 10 Sergey V. Udaltsov 2010-07-04 13:08:50 UTC
Ghm. I am still hesitant. Can tell you why. There are cases where separating words can cause confusion:

Alt+Caps Lock does the original capslock action

Shift+Caps Lock

That can be read as ("Alt+Caps") Lock and ("Shift+Caps") Lock. Absolute nonsense, but still...

Should "Caps Lock" be but in quotes? I do not know...
Comment 11 Simos Xenitellis 2010-07-05 03:01:01 UTC
(In reply to comment #10)
> Ghm. I am still hesitant. Can tell you why. There are cases where separating
> words can cause confusion:
> 
> Alt+Caps Lock does the original capslock action
> 
> Shift+Caps Lock
> 
> That can be read as ("Alt+Caps") Lock and ("Shift+Caps") Lock. Absolute
> nonsense, but still...
> 
> Should "Caps Lock" be but in quotes? I do not know...

The issue is that 'CapsLock/Caps Lock' is used both in free text and as part of notation (as in Alt+CapsLock). 
Since we cannot use text formatting to make the distinction (probably GNOME UI guidelines?), we could use 'CapsLock' for the notation, and Caps Lock in the free text (elsewhere).
Comment 12 Sergey V. Udaltsov 2010-07-05 10:18:25 UTC
> The issue is that 'CapsLock/Caps Lock' is used both in free text and as part of
> notation (as in Alt+CapsLock). 
Yes.

> Since we cannot use text formatting to make the distinction (probably GNOME UI
> guidelines?), 
What kind of formatting would you use? We cannot make assumptions about the way GUI tools are going to use the xml.

> we could use 'CapsLock' for the notation, and Caps Lock in the
> free text (elsewhere).
Ghm... This is kind of inconsistent... I've always thought about CapsLock in context of "notation" (as you call it), that's why I did not use space. Will review the strings again..
Comment 13 James Cloos 2010-07-05 11:48:34 UTC
The normal convention in English is that new ideas start as multiple
words, possibly combined with hyphens, and over time become a single
word.  CapsLock has been around long enough to be a word of its own.

As have ShiftLock, et al.

All that said, however, the symbols have _-separation; it also would
be reasonable, therefore, to use Caps_Lock, et al everywhere.
Comment 14 Daniel Stone 2010-07-05 11:56:06 UTC
(In reply to comment #13)
> The normal convention in English is that new ideas start as multiple
> words, possibly combined with hyphens, and over time become a single
> word.  CapsLock has been around long enough to be a word of its own.
> 
> As have ShiftLock, et al.
> 
> All that said, however, the symbols have _-separation; it also would
> be reasonable, therefore, to use Caps_Lock, et al everywhere.

Just to continue the bikeshedding, I think it looks horrendously ugly and over-technical, and this is borne out by most keyboards I see separating it with a space (including the one I'm typing this on).
Comment 15 Sergey V. Udaltsov 2010-07-05 12:00:11 UTC
I agree - using underscore makes it look too technical, if not geeky.
It is a pity bugzilla does not allow voting:)
Comment 16 Daniel Stone 2010-07-05 12:05:49 UTC
On Mon, Jul 05, 2010 at 12:00:12PM -0700, bugzilla-daemon@freedesktop.org wrote:
> I agree - using underscore makes it look too technical, if not geeky.
> It is a pity bugzilla does not allow voting:)

Bear in mind I think the same about CapsLock, not just Caps_Lock. :)
Comment 17 Sergey V. Udaltsov 2010-07-05 12:07:58 UTC
> Bear in mind I think the same about CapsLock, not just Caps_Lock. :)

How would you write this:

Alt+Caps Lock does the original capslock action

?
Comment 18 Daniel Stone 2010-07-05 12:13:17 UTC
On Mon, Jul 05, 2010 at 12:07:58PM -0700, bugzilla-daemon@freedesktop.org wrote:
> https://bugs.freedesktop.org/show_bug.cgi?id=28877
> 
> --- Comment #17 from Sergey V. Udaltsov <svu@gnome.org> 2010-07-05 12:07:58 PDT ---
> > Bear in mind I think the same about CapsLock, not just Caps_Lock. :)
> 
> How would you write this:
> 
> Alt+Caps Lock does the original capslock action

Maybe as 'Alt + Caps Lock', instead of Alt+CapsLock? If you really want
to make sure, maybe <em>Alt</em> + <em>Caps Lock</em> ...
Comment 19 Simos Xenitellis 2010-07-05 15:06:59 UTC
Created attachment 36772 [details]
Screenshot showing most messages relating to CapsLock text.

I attach a screenshot that shows most of the messages that have the CapsLock text. It shows about 60-70% of the messages having to do with the three patches attached.

The purpose of this bug report is to figure out how to do usability enhancements that is normally associated to distributions. Due to the nature of xkeyboard-config and since the 'consumer' of xkeyboard-config is principally GNOME, we do that usability enhancement exercise on the messages here.

If we were to take it further, we would show graphically that these 'Alt', 'Caps Lock' are actually keyboard keys. There is a Unicode character for keycap, like a⃣ but it does not look like it works for multiple characters.

Doing CapsLock->Caps Lock would be a gradual improvement.
Comment 20 Sergey V. Udaltsov 2010-07-08 15:47:15 UTC
I agree - in that group "Caps Lock" would look more natural. So, perhaps we should use "Caps Lock", along with "Alt + 'Caps Lock'" etc

Final call: objections, anyone?
Comment 21 Sergey V. Udaltsov 2010-07-12 15:53:51 UTC
For a moment, committed just with spaces. Will play with quotes...
Comment 22 Daniel Stone 2010-07-13 04:14:13 UTC
On Mon, Jul 12, 2010 at 03:53:51PM -0700, bugzilla-daemon@freedesktop.org wrote:
> For a moment, committed just with spaces. Will play with quotes...

I still think wrapping modifiers in <em /> in the UI would make the most
sense, especially as it visually differentiates modifiers from normal
keys.
Comment 23 Sergey V. Udaltsov 2010-07-13 10:18:32 UTC
> I still think wrapping modifiers in <em /> in the UI would make the most
> sense, especially as it visually differentiates modifiers from normal
> keys.
I see your point. I am not sure how to implement that in a way that would not depend on features of some particular toolkit - so any tool (including console-based) would be able to use those descriptions.

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.