]> granicus.if.org Git - postgresql/commitdiff
Minor SGML markup improvements.
authorNeil Conway <neilc@samurai.com>
Tue, 17 Feb 2004 02:53:03 +0000 (02:53 +0000)
committerNeil Conway <neilc@samurai.com>
Tue, 17 Feb 2004 02:53:03 +0000 (02:53 +0000)
doc/src/sgml/docguide.sgml
doc/src/sgml/sources.sgml

index d3f86c1c34b011e5f5d475ba3bc41f04defd0a72..67b68195a87b4c36f48814bbf35a021a9ae049b5 100644 (file)
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/docguide.sgml,v 1.49 2003/12/13 20:09:15 momjian Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/docguide.sgml,v 1.50 2004/02/17 02:53:03 neilc Exp $ -->
 
 <appendix id="docguide">
  <title>Documentation</title>
@@ -51,8 +51,8 @@
    languages are applications of the <firstterm>Standard Generalized
    Markup Language</firstterm>, <acronym>SGML</acronym>, which is
    essentially a language for describing other languages.  In what
-   follows, the terms DocBook and SGML are both used, but technically
-   they are not interchangeable.
+   follows, the terms DocBook and <acronym>SGML</acronym> are both
+   used, but technically they are not interchangeable.
   </para>
 
   <para>
@@ -1017,13 +1017,13 @@ End:
     <para>
      The <productname>PostgreSQL</productname> distribution includes a
      parsed DTD definitions file <filename>reference.ced</filename>.
-     You may find that when using PSGML, a comfortable way of working
-     with these separate files of book parts is to insert a proper
-     <literal>DOCTYPE</literal> declaration while you're editing them.
-     If you are working on this source, for instance, it is an
-     appendix chapter, so you would specify the document as an
-     <quote>appendix</quote> instance of a DocBook document by making
-     the first line look like this:
+     You may find that when using <productname>PSGML</productname>, a
+     comfortable way of working with these separate files of book
+     parts is to insert a proper <literal>DOCTYPE</literal>
+     declaration while you're editing them.  If you are working on
+     this source, for instance, it is an appendix chapter, so you
+     would specify the document as an <quote>appendix</quote> instance
+     of a DocBook document by making the first line look like this:
 
 <programlisting>
 &lt;!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.2//EN"&gt;
@@ -1041,8 +1041,8 @@ End:
     <title>Other Emacs modes</title>
 
     <para>
-     <productname>GNU Emacs</productname> ships with a different SGML
-     mode, which is not quite as powerful as
+     <productname>GNU Emacs</productname> ships with a different
+     <acronym>SGML</acronym> mode, which is not quite as powerful as
      <productname>PSGML</productname>, but it's less confusing and
      lighter weight.  Also, it offers syntax highlighting (font lock),
      which can be very helpful.
index f2c422ae712329aae643275f6064db8f0478ed94..10601ab3dc10bf416a415f03a0032f54ddf68a42 100644 (file)
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.12 2003/11/29 19:51:37 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.13 2004/02/17 02:53:03 neilc Exp $
 -->
 
  <chapter id="source">
@@ -23,8 +23,8 @@ $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.12 2003/11/29 19:51:37 pgsql Ex
    </para>
 
    <para>
-    For Emacs, add the following (or something similar)
-    to your <filename>~/.emacs</filename> 
+    For <productname>Emacs</productname>, add the following (or
+    something similar) to your <filename>~/.emacs</filename> 
     initialization file:
 
 <programlisting>
@@ -56,7 +56,7 @@ $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.12 2003/11/29 19:51:37 pgsql Ex
 set tabstop=4
 </programlisting>
 
-    or equivalently from within vi, try
+    or equivalently from within <application>vi</application>, try
 
 <programlisting>
 :set ts=4
@@ -423,7 +423,7 @@ write
    <para>
     Use lower case for message wording, including the first letter of a
     primary error message.  Use upper case for SQL commands and key words if
-    they appear in the message. 
+    they appear in the message.
    </para>
 
    <para>
@@ -497,7 +497,8 @@ and
    </para>
 
    <para>
-    Rationale: Else no one will know what <quote>foo.bar.baz</quote> is.
+    Rationale: Otherwise no one will know what <quote>foo.bar.baz</>
+    refers to.
    </para>
 
   </simplesect>