[Bf-docboard] Keyboard shortcut convention

[S J Bennett]

There's that compromise between [these]+[are]+[simultaneous]+[keys] 
(block = keypress) vs [these are simultaneous keys] (block = press 
everything together).

The Sphinx documentation recommends going with [Control-X Control-C], 
putting sequential keystrokes inside the same block and linking 
simultaneous keys with a hyphen instead of a plus. :kbd: is meant to 
"mark a sequence of keystrokes" according to 
http://sphinx-doc.org/markup/inline.html

Following that recommendation, we get sequences like [G X X], 
[Control-Alt-Shift-C], maybe [NumpadMinus] and [KeyboardMinus] for - 
depending where it is. Very visually clean. "-" is visually less busy 
than "+"; even if "+" is a much more widely used convention, both are 
understandable.

As for "easy to type", there's going to be more people reading these 
docs than writing them. While "easy to type" is important, I feel that 
"easy to read" should take precedence.

cheers,
Simon

On 28/11/2014 12:21 AM, koil . wrote:
> Id rather :kbd:`Shift+Alt+S`, its just easier to type.
>
> What do they look like rendered anyway?.
> I guess something like these:
> :kbd:`Shift+Alt+S` ... [Shift+Alt+S].
> :kbd:`Shift` + :kbd:`Alt` + :kbd:`S` ... [Shift] + [Alt] + [S].
> How does :kbd:`Shift`:kbd:`Alt`:kbd:`S` render ... [Shift][Alt][S] ?.
>
> I dunno.
> I would go for :kbd:`Shift+Alt+S`, :kbd:`Alt+RMB`, etcetera.
> This is easier to type and easy to read.
>
> Key chains like this would look confusing, [Shift] + [Alt] + [S], 
> [Alt] + [LMB], [Alt] + [R].
> Compared to, [Shift+Alt+S], [Alt+LMB], [Alt+R].
> Does, [Shift][Alt][S], [Alt][LMB], [Alt][R], look acceptable?... If it 
> works.
>
> There is a issue with the [+] and [-] buttons.
>
> :|
>
> Maybe [Shift Alt S] or [Shift][Alt][S], I dunno.
>
>
>
>
> _______________________________________________
> Bf-docboard mailing list
> Bf-docboard at blender.org
> http://lists.blender.org/mailman/listinfo/bf-docboard

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.blender.org/pipermail/bf-docboard/attachments/20141128/bacd5fdf/attachment.htm