Application and command names in <title> elements

[Ceri Davies]

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 at freebsd.org> wrote:
> > 
> > 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 application
> > and command names in the appropriate markup.
> > 
> > Would anyone care to talk me out of it?
> 
> 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 appropriate:
> <command> or manual page entities.
> 
> <command>, and &man.REF;, to me, are ambiguous.  For instance, we can wrap
> the following in either command or &man entities:
> 
> By using the &man.ssh.1; utility for remote network connections, you reduce
> 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 <command>
elements come in handy.

Ceri
-- 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20030519/5af257d4/attachment.sig>