From bdavis@house.so14k.com  Tue Mar  1 12:54:31 2005
Return-Path: <bdavis@house.so14k.com>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 6D13E16A4CE
	for <FreeBSD-gnats-submit@freebsd.org>; Tue,  1 Mar 2005 12:54:31 +0000 (GMT)
Received: from ender.liquidneon.com (ender.liquidneon.com [64.78.150.163])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 204E343D2D
	for <FreeBSD-gnats-submit@freebsd.org>; Tue,  1 Mar 2005 12:54:31 +0000 (GMT)
	(envelope-from bdavis@house.so14k.com)
Received: from localhost (localhost [127.0.0.1])
	by ender.liquidneon.com (Postfix) with ESMTP id 67CCB4414
	for <FreeBSD-gnats-submit@freebsd.org>; Tue,  1 Mar 2005 05:54:30 -0700 (MST)
Received: from ender.liquidneon.com ([127.0.0.1])
 by localhost (ender.liquidneon.com [127.0.0.1]) (amavisd-new, port 10024)
 with ESMTP id 78694-06 for <FreeBSD-gnats-submit@freebsd.org>;
 Tue,  1 Mar 2005 05:54:30 -0700 (MST)
Received: from mccaffrey.house.so14k.com (gw.house.so14k.com [216.87.87.128])
	by ender.liquidneon.com (Postfix) with ESMTP id D1FCF43E9
	for <FreeBSD-gnats-submit@freebsd.org>; Tue,  1 Mar 2005 05:54:29 -0700 (MST)
Received: by mccaffrey.house.so14k.com (Postfix, from userid 1001)
	id CC235BBA2; Tue,  1 Mar 2005 05:54:25 -0700 (MST)
Message-Id: <20050301125425.CC235BBA2@mccaffrey.house.so14k.com>
Date: Tue,  1 Mar 2005 05:54:25 -0700 (MST)
From: Brad Davis <so14k@so14k.com>
Reply-To: Brad Davis <so14k@so14k.com>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: Replace <literal> with <quote> around a #
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         78240
>Category:       docs
>Synopsis:       [patch] handbook: replace <literal> with <quote> around a #
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    brd
>State:          open
>Quarter:        
>Keywords:       all
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Mar 01 13:00:39 GMT 2005
>Closed-Date:    
>Last-Modified:  Tue Aug 31 22:13:04 UTC 2010
>Originator:     Brad Davis
>Release:        FreeBSD 5.4-PRERELEASE i386
>Organization:
>Environment:
System: FreeBSD mccaffrey.house.so14k.com 5.4-PRERELEASE FreeBSD 5.4-PRERELEASE #0: Thu Feb 24 17:03:44 MST 2005 root@mccaffrey.house.so14k.com:/usr/obj/usr/src/sys/SMP i386
>Description:
	Replace <literal> with <quote> around a #
>How-To-Repeat:
>Fix:


--- 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
 	configuration options is outside the scope of this book, so
 	only the most frequently modified directives will be described
>Release-Note:
>Audit-Trail:

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.
 
 Marc

From: Brad Davis <so14k@so14k.com>
To: Marc Fonvieille <blackend@FreeBSD.org>,
	FreeBSD-gnats-submit@FreeBSD.org
Cc:  
Subject: Re: docs/78240: Replace <literal> with <quote> around a #
Date: Tue, 1 Mar 2005 07:12:57 -0700

 Well we should decide which one to use because in the inetd section we
 use <quote> which looks better IMO.
 
 
 Regards,
 Brad Davis

From: Giorgos Keramidas <keramida@freebsd.org>
To: Brad Davis <so14k@so14k.com>
Cc: bug-followup@freebsd.org
Subject: Re: docs/78240: Replace <literal> with <quote> around a #
Date: Wed, 2 Mar 2005 02:58:22 +0200

 Brad Davis <so14k@so14k.com> wrote:
 > Well we should decide which one to use because in the inetd section we
 > use <quote> which looks better IMO.
 
 I'm personally a fan of <quote><literal>foo</literal></quote>, because
 it looks good both in plain text _and_ html output.  It is also similar
 to the way literal text is quoted in many places in the manpages, where
 the canonical way of quoting literal text is:
 
 	.Dq Li foo
 

From: Brad Davis <so14k@so14k.com>
To: Marc Fonvieille <blackend@FreeBSD.org>,
	FreeBSD-gnats-submit@FreeBSD.org,
	Giorgos Keramidas <keramida@freebsd.org>
Cc:  
Subject: Re: docs/78240: Replace <literal> with <quote> around a #
Date: Wed, 2 Mar 2005 00:19:28 -0700

 Well if that is what we want to do I can remake my patch to fix both
 instances that I know about and look for others.
 
 
 Regards,
 Brad Davis

From: Giorgos Keramidas <keramida@ceid.upatras.gr>
To: Brad Davis <so14k@so14k.com>,
	Marc Fonvieille <blackend@freebsd.org>
Cc: bug-followup@freebsd.org
Subject: Re: docs/78240: Replace <literal> with <quote> around a #
Date: Wed, 2 Mar 2005 11:46:48 +0200

 On 2005-03-02 00:19, Brad Davis <so14k@so14k.com> wrote
 regarding <quote><literal>foo</literal></quote> elements:
 >
 > Well if that is what we want to do I can remake my patch to fix both
 > instances that I know about and look for others.
 
 I'm not sure if nested <quote> and <literal> is something we can all
 agree about.  Even I have not decided if it's good to use nested
 elements or if we should marking up for style altogether and let the
 stylesheets decide how things are going to be presented (i.e. with
 quotes around the literal text, or not).
 
 Something like this, perhaps, in our doc/share/sgml/freebsd.dsl?
 
         (element literal
 	  (make-sequence
 	    (literal "``")
 	    (process-children)
 	    (literal "''")))
 
 I'm not very acquainted with DSSSL, so this may be wrong.  The general
 idea is that all <literal> elements will automagically quote their
 contents, so we don't need to <quote></quote> literal stuff.
 
Responsible-Changed-From-To: freebsd-doc->brd 
Responsible-Changed-By: trhodes 
Responsible-Changed-When: Wed Dec 24 10:17:47 UTC 2008 
Responsible-Changed-Why:  
Over to Brad, it's his PR. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=78240 
>Unformatted:
