Date: Sat, 14 Jul 2001 11:08:26 +0100 From: Nik Clayton <nik@freebsd.org> To: Murray Stokely <murray.stokely@windriver.com> Cc: freebsd-doc@FreeBSD.org Subject: Re: marking up keystrokes Message-ID: <20010714110826.F35484@clan.nothing-going-on.org> In-Reply-To: <20010713183147.E27674@meow.osd.bsdi.com>; from murray.stokely@windriver.com on Fri, Jul 13, 2001 at 06:31:47PM -0700 References: <20010713183147.E27674@meow.osd.bsdi.com>
index | next in thread | previous in thread | raw e-mail
[-- Attachment #1 --] On Fri, Jul 13, 2001 at 06:31:47PM -0700, Murray Stokely wrote: > There is no consistency to the way we currently mark up keystrokes > in the documentation. A quick glance will find many different styles: > > 1. CTRL+P > 2. CTRL-P > 3. ctrl-p > 4. Ctrl-P > > Sometimes these are wrapped in a <literal>, but usually not. > O'Reilly's style guide dictates the last entry, The only book I've > got on my desk at the moment seems to switch back and forth between #2 > and #4. Let the stylesheets do the work. The markup for something like that would be: <keycombo action="simul"><keycap>Ctrl</keycap><keycap>P</keycap></keycombo> This is used all over the place in the FAQ (and should probably be documented in the Primer). Valid values for 'action' are: Click Double-Click Other Press Seq Simul More details at http://www.docbook.org/tdg/html/keycombo.html > I think we should standardize with #4 but #2 isn't bad either. In > any case, I think that we should introduce some entities to keep > everything nice and easy and also allow us to give the correct > markup emphasis to keystrokes. > > &key.enter; > &key.ctrl.p; > &key.ctrl.alt.del; > &key.esc.p; > > Does anyone have any objections to me adding these to freebsd.ent > and using them throughout the Handbook? Other ideas? Entities for the various keys might be handy, but they'd really need to be written as &keycode.foo; (since DocBook also has a KeyCode element, with which it could get confused. Then the markup might become something like <keycombo action="simul">&keycap.ctrl;&keycap.p;</keycombo> which is a small improvement. N -- FreeBSD: The Power to Serve http://www.freebsd.org/ FreeBSD Documentation Project http://www.freebsd.org/docproj/ --- 15B8 3FFC DDB4 34B0 AA5F 94B7 93A8 0764 2C37 E375 --- [-- Attachment #2 --] -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.0.6 (FreeBSD) Comment: For info see http://www.gnupg.org iEYEARECAAYFAjtQGhoACgkQk6gHZCw343UD8wCfRCeYB03ZOzUuMI+ypdaOzC0U 7awAn1eoQUAB9wcy8YJR5PGKR1xWtoSG =BR/S -----END PGP SIGNATURE-----home | help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010714110826.F35484>