docs/78240: Replace <literal> with <quote> around a #

[Tom Rhodes]

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

> The following reply was made to PR docs/78240; it has been noted by GNATS.
> 
> From: Marc Fonvieille <blackend at FreeBSD.org>
> To: Brad Davis <so14k at so14k.com>
> Cc: FreeBSD-gnats-submit at 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