Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 02 Nov 2008 17:26:15 -0500
From:      Eitan Adler <eitanadlerlist@gmail.com>
To:        freebsd-doc@freebsd.org
Subject:   change to sgml-primer example
Message-ID:  <490E2907.5090907@gmail.com>

next in thread | raw e-mail | index | archive | help
This is a multi-part message in MIME format.
--------------070401000904080509010206
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Can anyone comment on the attached patch to be run from
/usr/doc/en_US.ISO8859-1/books/fdp-primer/sgml-primer
- --
GNU Key fingerptrint: 2E13 BC16 5F54 0FBD 62ED 42B6 B65F 24AB E9C2 CCD1
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.9 (FreeBSD)

iEYEARECAAYFAkkOKQcACgkQtl8kq+nCzNF6pACfXl362SlqAL1BtgDgP1KuH2V1
LFgAn2++bPmiZq0mBkPUVluAKhRExlrD
=/oXj
-----END PGP SIGNATURE-----

--------------070401000904080509010206
Content-Type: text/plain;
 name="change_sgml_example.udiff.patch"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="change_sgml_example.udiff.patch"

--- chapter.sgml	2008-10-31 08:23:35.000000000 -0400
+++ newchapter.sgml	2008-11-02 17:21:54.000000000 -0500
@@ -862,6 +862,7 @@
 
     <example>
       <title>Erroneous SGML comments</title>
+		<para> The SGML parser will treat </para>
 
       <programlisting><![ CDATA [
 <!-- This is in the comment --
@@ -870,22 +871,21 @@
 
   -- back inside the comment -->]]></programlisting>
 
-      <para>The SGML parser will treat this as though it were actually:</para>
+      <para>as though it were actually:</para>
 
       <programlisting>&lt;!THIS IS OUTSIDE THE COMMENT&gt;</programlisting>
 
       <para>This is not valid SGML, and may give confusing error
 	messages.</para>
 
+      <para>Because "--" delimitates the end of a comment do <emphasis>do not</emphasis> write comments like this: </para>
+
       <programlisting><![ CDATA [<!--------------- This is a very bad idea --------------->]]></programlisting>
 
-      <para>As the example suggests, <emphasis>do not</emphasis> write
-	comments like that.</para>
+	<para>This is a (slightly) better approach, but it still potentially confusing to people new to SGML:</para>
 
       <programlisting><![ CDATA [<!--===================================================-->]]></programlisting>
 
-      <para>That is a (slightly) better approach, but it still potentially
-	confusing to people new to SGML.</para>
     </example>
 
     <sect2>

--------------070401000904080509010206
Content-Type: application/octet-stream;
	name="change_sgml_example.udiff.patch.sig"
Content-Transfer-Encoding: base64
Content-Disposition: attachment; filename="change_sgml_example.udiff.patch.sig"

iEYEABECAAYFAkkOKQcACgkQtl8kq+nCzNH/SwCfeyEYCQciCpqWvB9VFdDO9qSbHh4AmgLR
krTgvE1H+HmkUyrzqL1gpaUN
--------------070401000904080509010206--



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?490E2907.5090907>