Hi Bruce,
don‘t worry!
I didn't take your first answer personally. Apology accepted!
I didn't take your first answer personally. Apology accepted!
Much more important is that we are working on the same thing - improving the darktable documentation!
In the meantime I have looked at user manuals of applications with mouse interactions which I know. In these projects the mouse interactions are described within the text.
https://docs.gimp.org/2.10/en/gimp-tool-clone.html
https://docs.blender.org/manual/en/latest/editors/3dview/navigate/navigation.html#orbit
https://docs.blender.org/manual/en/latest/editors/3dview/navigate/navigation.html#panning
https://docs.blender.org/manual/en/latest/editors/3dview/navigate/navigation.html#orbit
https://docs.blender.org/manual/en/latest/editors/3dview/navigate/navigation.html#panning
Exceptions are keyboard shortcuts overviews, then the mouse interactions are written in the form Ctrl+click.
https://docs.gimp.org/2.10/en/key-reference-view.html (see rulers and guides)
I fully agree with Bruce's statement.
But I'm happy to go with whatever concensus is agreed upon by the group.
But I'm happy to go with whatever concensus is agreed upon by the group.
To get a good result, further opinions on this topic are helpful and it would be nice if more developers would comment on this topic!
Cheers,
Pierre Metzner
Pierre Metzner
> Von: "Bruce Williams"
> Datum: 27. September 2019 um 01:01
> An: darktable
> Betreff: Fwd: Fwd: [darktable-dev] Standardization of the writing of mouse interactions in the user manual
> Pierre,
> First up, my sincerest apologies!
> I did not realize that that was YOUR sentence. I thought it was something you had found on the page you had linked to.
> I would not have been so brutal had I understood. Sorry! :)
>
> And yes, you are correct. Our previous discussions were more about the ratifying of how to document key combinations, but we had not discussed mouse intersections as well.
>
> You said:
>
> IMHO it should be considered to completely eliminate the spelling of mouse
> interactions in combination with keys like Ctrl+move, Ctrl+scoll or
> Ctrl+right click in the manual and to express this in sentences instead
> (see example sentence).
>
> Hmmm, not sure I agree on this point.
> I think for consistency's sake, the idea of a group of commands looking like this....
>
> Ctrl+A
> Shift+L
> Ctrl+(right click)
> Alt+(scroll wheel)
>
> ....makes more sense than....
>
> Ctrl+A
> Shift+L
> press/hold the Ctrl key and right click
> press/hold the Alt key and scroll the mouse wheel
> This is just my view.
> But I'm happy to go with whatever concensus is agreed upon by the group.
>
> Cheers,
> Bruce Williams.
> First up, my sincerest apologies!
> I did not realize that that was YOUR sentence. I thought it was something you had found on the page you had linked to.
> I would not have been so brutal had I understood. Sorry! :)
>
> And yes, you are correct. Our previous discussions were more about the ratifying of how to document key combinations, but we had not discussed mouse intersections as well.
>
> You said:
>
> IMHO it should be considered to completely eliminate the spelling of mouse
> interactions in combination with keys like Ctrl+move, Ctrl+scoll or
> Ctrl+right click in the manual and to express this in sentences instead
> (see example sentence).
>
> Hmmm, not sure I agree on this point.
> I think for consistency's sake, the idea of a group of commands looking like this....
>
> Ctrl+A
> Shift+L
> Ctrl+(right click)
> Alt+(scroll wheel)
>
> ....makes more sense than....
>
> Ctrl+A
> Shift+L
> press/hold the Ctrl key and right click
> press/hold the Alt key and scroll the mouse wheel
> This is just my view.
> But I'm happy to go with whatever concensus is agreed upon by the group.
>
> Cheers,
> Bruce Williams.
___________________________________________________________________________ darktable developer mailing list to unsubscribe send a mail to darktable-dev+unsubscr...@lists.darktable.org
