From owner-freebsd-doc  Wed May 29 15:12: 2 2002
Delivered-To: freebsd-doc@freebsd.org
Received: from mail.reppep.com (www.reppep.com [64.81.19.108])
	by hub.freebsd.org (Postfix) with ESMTP
	id 9025437B409; Wed, 29 May 2002 15:11:42 -0700 (PDT)
Received: from [129.85.219.160] (salt.rockefeller.edu [129.85.219.160])
	by mail.reppep.com (Postfix) with ESMTP
	id 22E6117C06; Wed, 29 May 2002 17:13:32 -0400 (EDT)
Mime-Version: 1.0
X-Sender: pepper@mail.reppep.com
Message-Id: <p05111a1bb91affba8a28@[129.85.219.160]>
In-Reply-To: <20020529214746.GA67346@hades.hell.gr>
References: <20020529214746.GA67346@hades.hell.gr>
Date: Wed, 29 May 2002 18:03:07 -0400
To: Giorgos Keramidas <keramida@freebsd.org>
From: Chris Pepper <pepper@reppep.com>
Subject: Re: (man page || manpage) => manual page
Cc: Tom Rhodes <trhodes@freebsd.org>, freebsd-doc@freebsd.org
Content-Type: text/plain; charset="us-ascii" ; format="flowed"
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-doc.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-doc>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-doc>
X-Loop: FreeBSD.org

	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