On Thu, Nov 30, 2000 at 12:22:12PM -0800, Mike Ressler wrote:
> Hi,
>
> I'm working on updating the keyboard shortcuts in the docs (starting with
> the User Guide).
Given that I'm former editor-in-chief of the LyX Documentation Effort
and remain its floating spiritual guide, I think it's time I weigh in
on this...
1. Different manuals will need different approaches.
It's already been mentioned that the Tutorial should pretty much
run with the default bindings, whatever they are. This makes
sense; a user reading the Tutorial ain't gonna know or care how to
change his keybindings.
For the UG and EG,
a) Prefer the default bindings;
b) However, when deemed necessary, also document the other major
binding(s) *in* *addition* *to* the default (either
parenthetically or in footnotes;
c) Finally, and above all else, do whatever is most appropriate for
the flow of the text. This, preservation of readability, takes
priority over all else.
2. Full documentation of all bindings belongs in the Reference Manual.
Someone else noted that we should document the bindings with the
functions, as we currently do. This is by design, folks. If
necessary, we can reorganize the RM a bit, junk unused chapters,
and move bindings to prominence.
An appendix in the UG would, therefore, be redundant. Just refer
to the Reference Manual.
3. The RefMan needs a new chapter, one listing keybindings.
a) Each major section would be for a particular flavor:
(i) Menus and Generic Defaults
(ii) CUA-like Default Bindings
(iii) Emacs-like Default Bindings
b) Within each major section, bindings would be grouped by
function/purpose.
c) Each group of bindings would be listed by keystroke and sorted
lexically.
d) Each keybinding would refer to the appropriate reference entry
in the chapter documenting lyxfunc's. If no such reference
exists, add one.
e) For the sake of the printed version, every
section/subsection/whatever will make use of "muticols" and be
put in at least two columns per page. (Online readers can
always use the TOC-menu to navigate.)
f) If appropriate, we'll put pagebreaks into this chapter so that
users can print out "quick-reference" sheets for the group(s) of
bindings they use the most.
So say I!
--
John Weiss
"Not through coersion. Not by force. But by compassion. By
affection. And, a small fish." -His Holiness, the 14th Dalai Lama
