Date: Wed, 29 May 2002 18:03:07 -0400 From: Chris Pepper <pepper@reppep.com> To: Giorgos Keramidas <keramida@freebsd.org> Cc: Tom Rhodes <trhodes@freebsd.org>, freebsd-doc@freebsd.org Subject: Re: (man page || manpage) => manual page Message-ID: <p05111a1bb91affba8a28@[129.85.219.160]> In-Reply-To: <20020529214746.GA67346@hades.hell.gr> References: <20020529214746.GA67346@hades.hell.gr>
next in thread | previous in thread | raw e-mail | index | archive | help
So this raises a question I've been wondering about. Sorry if it's a FAQ -- I haven't stumbled across it yet. What is the dividing line between entities and tags? I'd think it would be more XML-ish and reusable to use something like: <citerefentry> <refentrytitle>lame</refentrytitle> <manvolnum>1</manvolnum> </citerefentry> than "&man.lame.1;". What's the dividing line that falls between man pages and other tagged items, that makes man an entity (in all the pages I've looked at so far, anyway)? Thx, Chris Pepper At 12:47 AM +0300 2002/05/30, Giorgos Keramidas wrote: >When &man.xxx.y; references are being made I prefer the style that >Jeroen suggested to me a long time ago. Instead of writing: > > Additional encoding options can be found by consulting the >> - lame man page.</para> >> + lame manual page.</para> > >Since `lame' is used in IRC to denote 'silly', 'idiot', or similar, >you will probably want to change this part. Make it something like: > > by consulting > <citerefentry> > <refentrytitle>lame</refentrytitle> > <manvolnum>1</manvolnum> > </citerefentry>. > >This emulates the functionality of &man.lame.1;. You can even make >this a local entity in the file that references the manpage, by adding >to the <!DOCTYPE> element the proper stuff: > > [ <!ENTITY man.lame.1 >"<citerefentry/<refentrytitle/lame/<manvolnum/1//"> ] > >and then using &man.lame.1; as usual. -- Chris Pepper: <http://www.reppep.com/~pepper/>; Rockefeller University: <http://www.rockefeller.edu/>; 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?p05111a1bb91affba8a28>