On Thu, Nov 30, 2000 at 12:22:12PM -0800, Mike Ressler wrote:
>
> Given that CUA is the default, and assuming that an overwhelming majority
> use that, the question is how to I document such things without being
> ridiculous? Do I just document CUA and tell Emacs users to go figure it
> out themselves? (e.g. "to cut highlighted text, use C-x")
I think the docs have to be written assuming you've got the default binding.
Otherwise, you'd have to write it so that it automatically displayed what
the person's personal bindings were at that time, or something.
> Do I put the Emacs equivalent in parentheses? (e.g. "to cut highlighted
> text, use C-x (C-w)")
>
> Or do I annoy everyone and spell it out? (e.g. "to cut highlighted text,
> use C-x in CUA or C-w in Emacs")
IMO, both of these are verbose and annoying. (Admittedly I use CUA.) Yes,
the docs should have all the necessary information, but they also need to be
*readable*. Every time you have one of those parentheses (or worse, an extra
phrase) will break the train of thought of the text.
I would instead suggest that you prominently note that all the given
bindings are CUA and if you want Emacs bindings, they are listed at [Ref].
If you think this isn't good enough, maybe you could try footnotes. (I'm not
sure how many bindings you're talking about. If there are hundreds, the
footnotes could get burdensome, although you could also put several bindings
into one footnote.)
-Amir
