Date: Tue, 27 Aug 2002 20:37:23 +0200 From: Marc Fonvieille <blackend@FreeBSD.org> To: Nik Clayton <nik@FreeBSD.org> Cc: freebsd-doc@FreeBSD.org Subject: Re: [HEAD UP] Support for manpath in the links to manual pages Message-ID: <20020827203722.A41285@abigail.blackend.org> In-Reply-To: <20020827175059.GB66096@clan.nothing-going-on.org>; from nik@FreeBSD.org on Tue, Aug 27, 2002 at 06:50:59PM %2B0100 References: <20020827164338.B39381@abigail.blackend.org> <20020827175059.GB66096@clan.nothing-going-on.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On Tue, Aug 27, 2002 at 06:50:59PM +0100, Nik Clayton wrote: > On Tue, Aug 27, 2002 at 04:43:38PM +0200, Marc Fonvieille wrote: > > > > <!ENTITY man.xdm.1 "<citerefentry vendor='ports'/<refentrytitle/xdm/<manvolnum/1//"> > > > > in man-refs.ent for a FreeBSD ports manual page. > > I will change soon man-refs.ent to point on the correct manual pages. > > Note that in the docs the entities remain similar to &man.xdm.1; > > I'm not sure they should. Apart from anything else, we'll probably get > to a situation at some point where we have a binary in FreeBSD, and a > binary that's installed from the ports tree that has the same name. Or > binaries from different BSD's that we want to be able to distinguish > between. > > [ Also, we might want to refer to different versions of the same FreeBSD > man page -- for example, fsck(8) for 4.x vs fsck(8) for 5.x. . . . ] > > Without giving it a huge amount of thought, I suspect that something > like > > &man.xfree86.xdm.1; > &man.netbsd.ls.1; Yes, it will be the easiest solution and the transition will be simple. We just have to keep old entities in man-refs.ent till all docs are fixed. Maybe this can be already done for XFree86 related manual pages. > > is going to make more sense in the long run. We might want to include > version numbers in that as well. The entity might then expand to > something like > > <citerefentry vendor="xfree86"> > <refentrytitle>xdm</refentrytitle> > <manvolnum>1</manvolnum> > <citerefentry> (XFree86) > > so that the generated HTML is going to look something like > > <a href="...">xdm(1)</a> (XFree86) > > to make it clear to the reader that this is not in the base system. > Indeed, for the moment a newcomer to FreeBSD can't guess what is from the base system and what is from a third party software. Maybe we could use some different colors for the manual pages links, but it'd be useless for printing version or text browsers. Marc To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20020827203722.A41285>