[Bf-docboard] Keyboard shortcut convention

[Greg Zaal]

It's not really a big deal I think. If nobody has any strong reason not to
do so, I'd like to propose :kbd:`Ctrl` + :kbd:`A` as the standard.

I know it's a bit painful to type, but you can always set up a snippet in
your text editor to do the hard work for you (on sublime:
http://www.pasteall.org/55378/html4strict )

And we should always use upper case (or camel case rather), as in [Ctrl] +
[A] and not [ctrl] + [a].

If it's agreed, I'll check the existing content and make it all consistent.

Cheers,
Greg

On 27 November 2014 at 14:26, Piotr Arlukowicz <piotao at polskikursblendera.pl
> wrote:

> Just my two cents,
>
> I opt for single keys shown always in uppercase for clarity and visibility.
>
> It is clear then:
>
> A is just single a.
> Shift+A is just A with shift
>
> Using lowercase for 's' and uppercase 'S' for Shift-s is bad because they
> are not visible enough. The same for u and U, z and Z, o and O, etc.
>
> regards
> Piotr
>
>
> Piotr
> Polski Kurs Blendera: http://polskikursblendera.pl,
> YT: /user/piotao?feature=guide
> FB: /polskikursblendera
> TW: /piotao
>
>
> 2014-11-27 13:12 GMT+01:00 S J Bennett <quollism at ii.net>:
>
>> Sorry to bikeshed but it'd be nice to have this pinned down. I don't
>> want to have to go back and tediously re-edit something as omnipresent
>> as hotkeys.
>>
>> I did a quick bit of research to see if there's any broader consensus:
>> - Reaper uses [Ctrl]+[Alt]+Right-Click & Drag
>>    http://wiki.cockos.com/wiki/index.php/Item_Editing
>> - Houdini says [Ctrl] + [Tab] (boxed text, linking plus)
>>    http://www.sidefx.com/docs/houdini13.0/basics/panes
>> - Maya has special graphics for Alt, Shift, Space etc and also uses a
>> linking + outside the boxes
>>
>> http://download.autodesk.com/global/docs/maya2014/en_us/files/GUID-C8C48B82-85C3-427E-8CE5-E99942FACE0D.htm
>>    Maya also documents its hotkeys in plain lowercase which isn't the
>> most readable thing
>>
>> http://download.autodesk.com/global/docs/maya2014/en_us/files/Transforming_objects_Move_rotate_or_scale_objects_and_components.htm
>> - This article about Photoshop uses Shift+Alt+P and Cmd+Shift+U
>> highlighted in bold - no spaces or boxes
>> http://www.creativebloq.com/photoshop/photoshop-shortcuts-1012966
>>
>> The plus seems to be a pretty standard indication of "press all these
>> keys at once". Unlike in :kbd:`Ctrl+A` the plus doesn't tend to appear
>> in the box itself when there is a box. For me [Ctrl] + [A] is visually
>> less problematic than [Ctrl+A] - it's less crammed together and more
>> legible as a result. Separating the different keys into their boxes
>> makes the box around [Ctrl] etc a reliable visual metaphor for a single
>> key.
>>
>> What does everyone think?
>>
>> Also any thoughts on whether to make single keys like 'k' or 'g'
>> uppercase or lowercase when describing them as shortcuts? The monospace
>> font I'm seeing on my system indicates a clear difference between 1, l
>> and I so it's really down to a question of what we prefer.
>>
>> cheers,
>> Simon
>>
>> On 27/11/2014 2:43 AM, Campbell Barton wrote:
>> > I don't have really strong opinion, but prefer:
>> >
>> >   :kbd:`Ctrl+A`
>> >
>> > Its just easier to type and if you want to chain key bindings its a
>> > bit clearer whats going on.
>> >
>> > eg:
>> >   :kbd:`Ctrl+F`,  :kbd:`W`
>> >
>> > On Wed, Nov 26, 2014 at 5:38 PM, S J Bennett <quollism at ii.net> wrote:
>> >> I dig :kbd:`Ctrl` + :kbd:`a` for simultaneous commands, :kbd:`g`
>> :kbd:`x`
>> >> for sequential commands and :kbd:`g` :kbd:`xx` for key-repeat
>> sequential
>> >> commands.
>> >>
>> >> I feel like LMB MMB and RMB look better as caps as well.
>> >>
>> >> cheers,
>> >> Simon
>> >>
>> >>
>> >> On 26/11/2014 11:53 PM, Greg Zaal wrote:
>> >>
>> >> Hey folks,
>> >>
>> >> How are we handling keyboard shortcuts with modifiers?
>> >>
>> >> The style guide (http://www.blender.org/documentation/style-guide)
>> simply
>> >> shows ":kbd:`Lmb`", but what should we do for things like Ctrl + A?
>> >>
>> >> Possibilities include:
>> >>
>> >> :kbd:`Ctrl+A`
>> >> :kbd:`Ctrl-A`  (this is used in some places already, but it's not
>> common to
>> >> use '-')
>> >> :kbd:`Ctrl` + :kbd:`A`  (this is the prettiest imo)
>> >> :kbd:`Ctrl A`
>> >>
>> >> What do you think?
>> >>
>> >> Cheers,
>> >> Greg Zaal
>> >>
>> >>
>> >>
>> >> _______________________________________________
>> >> Bf-docboard mailing list
>> >> Bf-docboard at blender.org
>> >> http://lists.blender.org/mailman/listinfo/bf-docboard
>> >>
>> >>
>> >>
>> >> _______________________________________________
>> >> Bf-docboard mailing list
>> >> Bf-docboard at blender.org
>> >> http://lists.blender.org/mailman/listinfo/bf-docboard
>> >>
>> >
>> >
>>
>> _______________________________________________
>> Bf-docboard mailing list
>> Bf-docboard at blender.org
>> http://lists.blender.org/mailman/listinfo/bf-docboard
>>
>
>
> _______________________________________________
> 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/20141127/270c2f26/attachment.htm