Date: Wed, 20 Feb 2002 00:40:02 -0800 (PST) From: Peter Pentchev <roam@ringlet.net> To: freebsd-doc@freebsd.org Subject: Re: docs/35133: [patch] work for -junior doc hacker thread Message-ID: <200202200840.g1K8e2o55541@freefall.freebsd.org>
index | next in thread | raw e-mail
The following reply was made to PR docs/35133; it has been noted by GNATS. From: Peter Pentchev <roam@ringlet.net> To: freebsd-gnats-submit@FreeBSD.org Cc: Subject: Re: docs/35133: [patch] work for -junior doc hacker thread Date: Wed, 20 Feb 2002 10:34:36 +0200 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 ----- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the messagehelp
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200202200840.g1K8e2o55541>