Date: Sat, 28 Jul 2001 14:38:51 -0400
Message-Id: <200107281838.OAA32109@delorie.com>
X-Authentication-Warning: delorie.com: eliz set sender to eliz AT delorie DOT com using -f
From: Eli Zaretskii <eliz AT delorie DOT com>
To: "Mark E." <snowball3 AT bigfoot DOT com>
CC: djgpp-workers AT delorie DOT com
In-reply-to: <3B62C180.11330.5D467D@localhost> (snowball3@bigfoot.com)
Subject: Re: extended key translation table doc
References:  <3B62C180 DOT 11330 DOT 5D467D AT localhost>
Reply-To: djgpp-workers AT delorie DOT com
Errors-To: nobody AT delorie DOT com
X-Mailing-List: djgpp-workers AT delorie DOT com
X-Unsubscribes-To: listserv AT delorie DOT com
Precedence: bulk

> From: "Mark E." <snowball3 AT bigfoot DOT com>
> Date: Sat, 28 Jul 2001 13:43:28 -0400
> 
> I've documented the strings returned based on the extended key. Does
> the markup look right?

Don't use @key for the key sequences, and not for keys in a
multitable.  @key produces a small image of a keyboard key in the
printed version, and you don't want that in a table.  Especially since
your text is not about typing keys, but about sequences of characters
produced by the emulation.

I suggest to use @code for the sequences and @kbd for the keys typed
by the user, like this:

 @item @kbd{Up Arrow}
 @tab @code{ESC[A}   @tab @tab @code{ESC[37~} @tab @code{ESC[59~}

Note that I've made the entire sequence be in @code.

An alternative is @samp, which does the same in the on-line version,
but in the printed version adds quotes (@code is without quotes in
the printed version).

> @item @kbd{@key{Alt}-A} @tab @key{ESC}[81~

@kbd{@key{Alt}-A} is always wrong, even if you are talking about user
who types a key.  @kbd{Alt- AT key{A}} is the right form, if you must use
@key.  But I suggest to drop @key here, because of @multitable.

Otherwise, the text looks fine.  Thanks.