[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Fwd: A matter of documentation



Hello,
For me, the only stipulation I would make is that whatever convention you 
use, it *MUST* explained *BEFORE* it is referenced; and, it *MUST* me 
available with when needed.  No fair puting such docs in a zipped format, 
when the docs required that you read it before unzipping!  (yes, I would 
have sent you the $50 with this letter, but I already sealed the envelope! 
<g> )

Come to think on it, that which sounds easier on the ears, is easier to 
understand and listen to.  For example, "c dash x alt - e" is easier for 
me, than "control x  alt echo"

Dave

e-mail: helkenn@titan.com or helkenn@pacbell.net

>Resent-Date: Fri, 17 Aug 2001 18:08:47 -0400 (EDT)
>X-Authentication-Warning: hub.cs.vassar.edu: lists set sender to 
>emacspeak-request@cs.vassar.edu using -f
>Subject: A matter of documentation
>To: emacspeak@cs.vassar.edu
>X-Mailer: Lotus Notes Release 5.0.7  March 21, 2001
>From: "Jennifer E Jobst" <jobst@us.ibm.com>
>Date: Fri, 17 Aug 2001 17:07:33 -0500
>X-MIMETrack: Serialize by Router on D04NM109/04/M/IBM(Release 5.0.6 
>|December 14, 2000) at
>  08/17/2001 06:07:34 PM
>Resent-From: emacspeak@cs.vassar.edu
>X-Mailing-List: <emacspeak@cs.vassar.edu> archive/latest/2163
>X-Loop: emacspeak@cs.vassar.edu
>Resent-Sender: emacspeak-request@cs.vassar.edu
>
>Greetings all,
>
>I'm working to help update the Emacspeak HOWTO, and I'd love your input on
>a matter of documentation.
>
>As you know, in Emacs commands use either the Control key or the Meta (Alt)
>key, plus an alphanumerical key (or two).  In most documentation, these key
>combinations are written as C-x C-s or some such.  Sometimes the command is
>in quotes.  Sometimes it is tagged to be in a different font so that the
>reader will know it is a keyboard command.  There are several variations.
>
>What I would like to know is, what would be the best way to document these
>commands so that they are clearly read by a synthesizer? From my
>experience, typically something like C-x would be read as
>
>(higher pitch to denote capital letter) c hyphen x
>
>So, for a newer user, would this be clear?  Alternatively, I was thinking
>about using something like
>
>control c-x
>
>or
>
>control c x
>
>Anyway, I was wondering what would be the most useful and understandable
>format for these commands.  Any comments or suggestions you might have, on
>this topic or any other documentation-related topic, would be very welcome.
>
>I look forward to hearing from you!
>
>Sincerely yours,
>
>Jennifer E. Jobst
>Linux Information Development
>IBM Linux Technology Services
>(512) 838-8298, T/L 678-8298
>
>-----------------------------------------------------------------------------
>To unsubscribe from the emacspeak list or change your address on the
>emacspeak list send mail to "emacspeak-request@cs.vassar.edu" with a
>subject of "unsubscribe" or "help"

-----------------------------------------------------------------------------
To unsubscribe from the emacspeak list or change your address on the
emacspeak list send mail to "emacspeak-request@cs.vassar.edu" with a
subject of "unsubscribe" or "help"


Emacspeak Files | Subscribe | Unsubscribe | Search