1279675 - Clarify localization notes for devtools key-shortcuts

Status: RESOLVED FIXED

(DevTools :: General, defect, P1)

Description

[Julian Descottes [:jdescottes]]

Follow up to Bug 1279459.

Localization notes for keyboard shortcuts should explain that these strings should not be literally translated, with a link to a documentation explaining what are the accepted keys / special-keys / modifiers.

Something like:

> Technical definition of the keyboard shortcut for [feature_name]. should not be
> literally translated. If another shortcut should be used in a given locale,
> read the about the supported keys, special keys and modifiers at
> documentation_link]. 
> 

For the documentation page, we can either:
1. update the key-shortcuts module to have parity with the electron implementation and then link to their doc [1]. 
2. maintain our own documentation page (similar to the electron one)
3. embed the documentation in key-shortcuts.js [2]. We already have the list of keys which is straightforward enough, we just need to add the list of supported modifiers and more shortcut examples   

[1] https://github.com/electron/electron/blob/master/docs/api/accelerator.md
[2] https://dxr.mozilla.org/mozilla-central/source/devtools/client/shared/key-shortcuts.js

Comment 1

[Brian Grinstead [:bgrins]]

See https://bugzilla.mozilla.org/show_bug.cgi?id=1268441#c28.

> There are two parts to explain: don't localize the first part of the string, only change the letter if you need to.
> Some notes could be added to this document, besides sending an email to dev-l10n to explain it
> https://developer.mozilla.org/en-US/docs/Mozilla/Localization/Localization_content_best_practices

Comment 2

[Alexandre Poirot [:ochameau]]

Updated the mdn page:
https://developer.mozilla.org/en-US/docs/Mozilla/Localization/Localization_content_best_practices#Developer_tools_key_shortcuts

Comment 3

[Alexandre Poirot [:ochameau]]

And I just sent a mail to dev-l10n. There may be some delay if the list is moderated...