From owner-freebsd-doc@FreeBSD.ORG  Tue Mar  1 23:27:01 2005
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP
	id EE18B16A4CE; Tue,  1 Mar 2005 23:27:01 +0000 (GMT)
Received: from pittgoth.com (14.zlnp1.xdsl.nauticom.net [209.195.149.111])
	by mx1.FreeBSD.org (Postfix) with ESMTP
	id 79A6D43D1D; Tue,  1 Mar 2005 23:27:01 +0000 (GMT)
	(envelope-from trhodes@FreeBSD.org)
Received: from mobile.pittgoth.com (ip68-230-188-82.dc.dc.cox.net
	[68.230.188.82])	(authenticated bits=0)
	by pittgoth.com (8.12.10/8.12.10) with ESMTP id j21NR0Mp002585
	(version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NOT);
	Tue, 1 Mar 2005 18:27:00 -0500 (EST)
	(envelope-from trhodes@FreeBSD.org)
Date: Tue, 1 Mar 2005 18:26:51 -0500
From: Tom Rhodes <trhodes@FreeBSD.org>
To: Marc Fonvieille <blackend@FreeBSD.org>
Message-ID: <20050301182651.2b8ce710@mobile.pittgoth.com>
In-Reply-To: <200503011340.j21DeKHe048812@freefall.freebsd.org>
References: <200503011340.j21DeKHe048812@freefall.freebsd.org>
X-Mailer: Sylpheed-Claws 1.0.1 (GTK+ 1.2.10; i386-portbld-freebsd6.0)
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
cc: freebsd-doc@FreeBSD.org
Subject: Re: docs/78240: Replace <literal> with <quote> around a #
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Tue, 01 Mar 2005 23:27:02 -0000

On Tue, 1 Mar 2005 13:40:20 GMT
Marc Fonvieille <blackend@freebsd.org> wrote:

> The following reply was made to PR docs/78240; it has been noted by GNATS.
> 
> From: Marc Fonvieille <blackend@FreeBSD.org>
> To: Brad Davis <so14k@so14k.com>
> Cc: FreeBSD-gnats-submit@FreeBSD.org
> Subject: Re: docs/78240: Replace <literal> with <quote> around a #
> Date: Tue, 1 Mar 2005 14:34:43 +0100
> 
>  On Tue, Mar 01, 2005 at 05:54:25AM -0700, Brad Davis wrote:
>  > 
>  > --- doc-ori/en_US.ISO8859-1/books/handbook/network-servers/chapter.sgml	Fri Feb 25 13:31:42 2005
>  > +++ doc/en_US.ISO8859-1/books/handbook/network-servers/chapter.sgml	Tue Mar  1 05:51:14 2005
>  > @@ -4262,7 +4262,7 @@
>  >  	installed as
>  >  	<filename>/usr/local/etc/apache/httpd.conf</filename> on &os;.
>  >  	This file is a typical &unix; text configuration file with
>  > -	comment lines beginning with the <literal>#</literal>
>  > +	comment lines beginning with the <quote>#</quote>
>  >  	character.  A comprehensive description of all possible
>  
>  The current markup seems right to me.  <quote></quote> should be used to
>  quote some text or to indicate a word is not used in the usual way, etc.
>  I'm not sure there is a rule for a single character.

If you want to stress the importance or abnormal appearance of
a character, then quote is good.

I'm also debating the usefulness of this patch.


-- 
Tom Rhodes