Bug 78240 - [patch] handbook: replace <literal> with <quote> around a #
Summary: [patch] handbook: replace <literal> with <quote> around a #
Status: Open
Alias: None
Product: Documentation
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: freebsd-doc mailing list
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-03-01 13:00 UTC by Brad Davis
Modified: 2017-12-31 22:34 UTC (History)
0 users

See Also:


Attachments
file.diff (645 bytes, patch)
2005-03-01 13:00 UTC, Brad Davis
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Brad Davis 2005-03-01 13:00:39 UTC
	Replace <literal> with <quote> around a #
Comment 1 Marc Fonvieille freebsd_committer 2005-03-01 13:34:43 UTC
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
Comment 2 Brad Davis 2005-03-01 14:12:57 UTC
Well we should decide which one to use because in the inetd section we
use <quote> which looks better IMO.


Regards,
Brad Davis
Comment 3 Giorgos Keramidas freebsd_committer 2005-03-02 00:58:22 UTC
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
Comment 4 Brad Davis 2005-03-02 07:19:28 UTC
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
Comment 5 Giorgos Keramidas 2005-03-02 09:46:48 UTC
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.
Comment 6 Tom Rhodes freebsd_committer 2008-12-24 10:17:47 UTC
Responsible Changed
From-To: freebsd-doc->brd

Over to Brad, it's his PR.
Comment 7 Eitan Adler freebsd_committer freebsd_triage 2017-12-31 08:01:27 UTC
For bugs matching the following criteria:

Status: In Progress Changed: (is less than) 2014-06-01

Reset to default assignee and clear in-progress tags.

Mail being skipped