Open lassoan opened 4 months ago
In many cross-platform software programs, notably those from Adobe and Microsoft, keyboard shortcuts are generally documented to reflect the conventions of the respective operating systems, while maintaining consistency wherever possible.
1 Key Modifiers:
2 Right-Click:
3 Alt/Opt Key:
4 More about the default keyboard shortcuts: link here
1 Key Modifiers:
2 Right-Click:
3 Alt/Opt Key:
4 More about the default keyboard shortcuts: General link here Outlook link here Note that all Microsoft keyboards are equipped to perform shortcuts in Windows and other Microsoft applications.
Describe both Windows and Mac everywhere:
Only describe Control:
Visual studio code provides different cheatsheets for each OS:
https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_keyboard-reference-sheets
For their online documentation it seems they embed a code snippet that dynamically changes the document based on what OS your browser is coming from:
https://github.com/microsoft/vscode-docs/blob/main/docs/getstarted/tips-and-tricks.md?plain=1#L80
If we think it's worth it we could do something similar with readthedocs.
re: vscode documentation
They are indeed processing the kb(shortcut-identifier)
to generate HTML as well as javascript dynamically updating the page based on the current user agent and the bindings organized in json files^1.
That said, after inspecting the microsoft/vscode-docs
repository, it looks like the corresponding infrastructure is organized in a private project called microsoft/vscode-website
^2
getstarted/keybindings#_basic-editing | |
---|---|
https://code.visualstudio.com/dist/index.js |
---|
Check how Control/Command keyboard shortcuts are documented in other cross-platform software (Adobe, Microsoft, etc.) so that we document these differences in shortcuts similarly in Slicer.
Differences include:
Alt
key on macOS, it is often mapped toOption