Bug 35133

Oops.  This should go to GNATS, too, should it not..

G'luck,
Peter

-- 
Peter Pentchev	roam@ringlet.net	roam@FreeBSD.org
PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
Thit sentence is not self-referential because "thit" is not a word.

----- Forwarded message from Peter Pentchev <roam@ringlet.net> -----

Date: Wed, 20 Feb 2002 10:13:54 +0200
From: Peter Pentchev <roam@ringlet.net>
To: Tom Rhodes <darklogik@pittgoth.com>
Subject: Re: docs/35133: [patch] work for -junior doc hacker thread
User-Agent: Mutt/1.2.5i
In-Reply-To: <200202200607.g1K67Ga19123@pittgoth.com>; from darklogik@pittgoth.com on Wed, Feb 20, 2002 at 01:07:16AM -0500

On Wed, Feb 20, 2002 at 01:07:16AM -0500, Tom Rhodes wrote:
> 
> >Number:         35133
> >Category:       docs
> >Synopsis:       [patch] work for -junior doc hacker thread

> >Description:
> This just adds the <quote> information to the FDP primer,
> and lists it only under the <para> information.  I didn't think it
> deserved a huge section devoted to it.  Of course, if someone
> thinks it should be done like that, no objections here ;)
> >How-To-Repeat:
> Ask yourself how to use quotes, and then wonder
> why there isn't any info on it in the primer
> >Fix:
> either commit or comment on this patch.

You asked for it ;)  Being as it is that I consider myself a junior -doc
hacker too, please do not take my comments too seriously; it's just MHO..

> --- fdp-primer.old/sgml-markup/chapter.sgml	Tue Feb 19 16:10:10 2002
> +++ fdp-primer/sgml-markup/chapter.sgml	Tue Feb 19 16:17:26 2002
> @@ -1014,6 +1014,16 @@
>  	    element.</para>
>  	</example>
>        </sect3>

First point: <quote> is not a block element, it is rather an in-line
element; its description does not quite belong here, I think..

> +
> +      <sect3>
> +        <title>Use of <sgmltag>quote</sgmltag>

Unclosed <title> tag.

> +
> +        <para>Within <sgmltag>para</sgmltag> you may want to quote something, since

You might want to break this sentence into its two logical parts..

> +          this is a normal operation in most documents it is usually done by using the
> +          <sgmltag>quote</sgmltag> tag.  This will give you an output similar to:
> +          <quote>I am a quote, and I can be used within <sgmltag>para</sgmltag></quote>
> +        </para>
> +      </sect3>

This does not quite follow the style of all the other examples in this
section of the FDP primer :)  What do you (and other -doc people) think
about the attached patch instead?

G'luck,
Peter

Index: doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml,v
retrieving revision 1.39
diff -u -r1.39 chapter.sgml
--- doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml	11 Feb 2002 01:58:44 -0000	1.39
+++ doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml	20 Feb 2002 08:04:45 -0000
@@ -1604,6 +1604,31 @@
       </sect3>
 
       <sect3>
+        <title>Quotations</title>
+
+	<para>To quote text from another document or source, or to denote
+	  a phrase that is used figuratively, use <sgmltag>quote</sgmltag>.
+	  Within a <sgmltag>quote</sgmltag> tag, you may use most of the
+	  markup tags available for normal text.</para>
+
+	<example>
+	  <title>Quotations</title>
+
+	  <para>Use:</para>
+
+	  <programlisting><![ CDATA [<para>However, make sure that the search does not go beyond the
+  <quote>boundary between local and public administration</quote>,
+  as RFC 1535 calls it.</para>]]></programlisting>
+
+	  <para>Appearance:</para>
+
+	  <para>However, make sure that the search does not go beyond the
+	    <quote>boundary between local and public administration</quote>,
+	    as RFC 1535 calls it.</para>
+	</example>
+      </sect3>
+      
+      <sect3>
 	<title>Keys, mouse buttons, and combinations</title>
 
 	<para>To refer to a specific key on the keyboard, use

----- End forwarded message -----

Peter I like it, it is better than mine.  Now, I guess we let Murray or 
Nik review it and commit it or?

-- 
Tom (Darklogik) Rhodes
www.Pittgoth.com Gothic Liberation Front
www.FreeBSD.org  The Power To Serve

Comment 3 dd 2002-03-03 01:17:45 UTC

State Changed
From-To: open->closed

Peter committed this but forgot to close it. 

Comment 4 dd 2002-03-03 01:17:45 UTC

Responsible Changed
From-To: freebsd-doc->roam

JFYI