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

Best tagging practice: multi-key sequences?



-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hello all,

I've come upon another scenario where I'm unsure what the best tagging
practice would be.

In general, if a user is instructed to perform a key combo we use the
keycombo and keycap tags:

	Press
	<keycombo>
		<keycap>Ctrl</keycap>
		<keycap>Alt</keycap>
		<keycap>Del</keycap>
	</keycombo>
	to initiate a reboot.

or, in the case of a key sequence, something like:

	Press <keycap>Esc</keycap>, <keycap>.</keycap> to recall the
	last argument of the last command in <command>bash</command>

When the user is being asked to type in text, we use userinput:

	Enter the text <userinput>I like penguins!</userinput> into
	text document.

The issue is that we're now marking up documentation that deals with
using vi and things are becoming a bit more ambiguous. What about an
instruction like:

	To save and quit, press :wq while in command mode

Technically, since :wq is a set of keypresses, rather than arbitrary
text that the user is entering, it seems that it should be marked up as

<keypress>:</keypress>, <keypress>w</keypress>, <keypress>q</keypress>

...but that is awfully klunky. We've instead been opting for

	<userinput>:wq</userinput>

even though that is arguably incorrect.

The FDP docs guide doesn't really address situations like this
(multi-key sequences) directly, so is there an informal standard we
should know about before settling on one or the other?

- --Brad
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)
Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org

iD8DBQFDhM8uDvp49DvQ8kcRAh+GAJ9R0hFXizWMNfZj2+5xbQR7duyoYQCfd58G
XNqh9lHZpPUen67vtwEddow=
=im/R
-----END PGP SIGNATURE-----


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