Application and command names in <title> elements
Simon L. Nielsen
simon at nitro.dk
Mon May 19 20:34:55 UTC 2003
On 2003.05.19 16:17:00 -0400, Tom Rhodes wrote:
> On Mon, 19 May 2003 22:09:06 +0200
> "Simon L. Nielsen" <simon at nitro.dk> wrote:
>
> > On 2003.05.19 15:30:48 -0400, Tom Rhodes wrote:
> >
> > > 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.
> >
> > In a patch I used man entities multiple times shortly after each other
> > and Murrays changed it in the committed version to only use it the first
> > time and use <command> for the other cases.
> >
> > <comment by Murray from docs/50790 audit trail>
> > One thing to note is
> > that it doesn't look good to use the man page entities twice in close
> > proximity. So I used &man.dumpon.8; the first time, then just used
> > <command>dumpon</command> elsewhere in the paragraph.
> > </comment>
> >
> > I think this is seems like a good way since the man reference is still
> > nice to have.
>
> Ok, I see the logic here. Thanks guys.
Perhaps it would be a good idea to add a short note about this to the
section about "Applications, commands, options, and cites" in the FDP
primer ?
I can make a patch if it sounds like a good idea...
--
Simon L. Nielsen
-------------- 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/76342c8f/attachment.sig>
More information about the freebsd-doc
mailing list