Best tagging practice: multi-key sequences?
Brad Smith
brads at redhat.com
Wed Nov 23 21:12:11 UTC 2005
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Tommy Reynolds wrote:
> Uttered Brad Smith <brads at redhat.com>, spake thus:
>
>
>>I think it would look inconsistent if only these instructions were
>>treated as regular text so, for our purposes, I think we
>>definitely need to tag it with something, I'm just unsure what.
>
>
> Well, <userinput>:wq</userinput>, of course. <keycode> and <keycap>
> are not "key strokes", they are silkscreen labels and ROM values.
>
> Just my $0.02e+48 on it.
>
> Cheers
>
Ok, so a good way of codifying this would be:
For typed-in characters, use <userinput>. Nonprintable characters should
be wrapped in <keycap> eg:
Enter: <userinput>Heading 1 <keycap>Tab<keycap> Heading 2
<keycap>Enter</keycap></userinput> into a text document to begin a
simple table.
Sounds good. I'll add this to our style guide.
Thanks again for helping clarify this,
- --Brad
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)
Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org
iD8DBQFDhNsqDvp49DvQ8kcRAp4NAJ9UoZizDOOFm2gXFKM8IMWj29eosQCfZXx9
F2dfxMr3+DtGdF3RrUWHDhI=
=wJKo
-----END PGP SIGNATURE-----
More information about the fedora-docs-list
mailing list