From owner-freebsd-doc@FreeBSD.ORG Mon May 19 13:05:58 2003 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 1F9FF37B401; Mon, 19 May 2003 13:05:58 -0700 (PDT) Received: from shrike.submonkey.net (pc1-cdif2-5-cust38.cdif.cable.ntl.com [81.101.150.38]) by mx1.FreeBSD.org (Postfix) with ESMTP id 1EC5243FA3; Mon, 19 May 2003 13:05:53 -0700 (PDT) (envelope-from setantae@submonkey.net) Received: from setantae by shrike.submonkey.net with local (Exim 4.12) id 19HqtM-000JTU-00; Mon, 19 May 2003 21:05:52 +0100 Date: Mon, 19 May 2003 21:05:52 +0100 From: Ceri Davies To: Tom Rhodes Message-ID: <20030519200552.GA74816@submonkey.net> Mail-Followup-To: Ceri Davies , Tom Rhodes , doc@FreeBSD.org References: <20030519192255.GB74434@submonkey.net> <20030519153048.51f20a06.trhodes@FreeBSD.org> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="GvXjxJ+pjyke8COw" Content-Disposition: inline In-Reply-To: <20030519153048.51f20a06.trhodes@FreeBSD.org> User-Agent: Mutt/1.5.4i Sender: Ceri Davies cc: doc@FreeBSD.org Subject: Re: Application and command names in elements X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project <freebsd-doc.freebsd.org> List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>, <mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe> List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc> List-Post: <mailto:freebsd-doc@freebsd.org> List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help> List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>, <mailto:freebsd-doc-request@freebsd.org?subject=subscribe> X-List-Received-Date: Mon, 19 May 2003 20:05:58 -0000 --GvXjxJ+pjyke8COw Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Mon, May 19, 2003 at 03:30:48PM -0400, Tom Rhodes wrote: > On Mon, 19 May 2003 20:22:55 +0100 > Ceri Davies <ceri@freebsd.org> wrote: > >=20 > > I've been taking a high level look at getting all the <title> elements = in > > the handbook ready for the 3rd edition (well, glimpse has been doing all > > the hard work so far), and I'm very tempted to religiously wrap all app= lication > > and command names in the appropriate markup. > >=20 > > Would anyone care to talk me out of it? >=20 > I'd like to chime in here if you do not mind. While I was thinking > about this just last night, a question arose as to which is more appropri= ate: > <command> or manual page entities. >=20 > <command>, and &man.REF;, to me, are ambiguous. For instance, we can wrap > the following in either command or &man entities: >=20 > By using the &man.ssh.1; utility for remote network connections, you redu= ce > the risk of password theft. If you use a manpage entity more than once in close proximity, it starts to look silly, at least in HTML output. In general I think that's when <comma= nd> elements come in handy. Ceri --=20 --GvXjxJ+pjyke8COw Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.2 (FreeBSD) iD8DBQE+yTkgocfcwTS3JF8RAjVSAJ9xFOBeob0vBIjlM8KDVmaCULh3owCeKxMI Yk16QBcZtCKfjVtWjBVmw1k= =JLWh -----END PGP SIGNATURE----- --GvXjxJ+pjyke8COw--