Add information on generating INSTALL and HISTORY from sgml sources.
authorThomas G. Lockhart
Wed, 23 Jun 1999 06:19:36 +0000 (06:19 +0000)
committerThomas G. Lockhart
Wed, 23 Jun 1999 06:19:36 +0000 (06:19 +0000)
doc/src/sgml/docguide.sgml

index af4e7b04641ab03652097b3c395942db051063e4..ccdf85e6830534c1e597bafb2c95c7ca455fe610 100644 (file)
@@ -1,24 +1,12 @@
 
 
 
@@ -115,27 +92,67 @@ Include working list of all documentation sources, with current status
      
 
      
-      ./COPYRIGHTCopyright notice
-      ./INSTALLInstallation instructions (text from sgml->rtf->text)
-      ./READMEIntroductory info
-      ./register.txtRegistration message during make
-      ./doc/bug.templateBug report template
-      ./doc/postgres.tar.gzIntegrated docs (HTML)
-      ./doc/programmer.ps.gzProgrammer's Guide (Postscript)
-      ./doc/programmer.tar.gzProgrammer's Guide (HTML)
-      ./doc/reference.ps.gzReference Manual (Postscript)
-      ./doc/reference.tar.gzReference Manual (HTML)
-      ./doc/tutorial.ps.gzIntroduction (Postscript)
-      ./doc/tutorial.tar.gzIntroduction (HTML)
-      ./doc/user.ps.gzUser's Guide (Postscript)
-      ./doc/user.tar.gzUser's Guide (HTML)
+      
+       ./COPYRIGHTCopyright notice
+      
+      
+       ./INSTALL
+       Installation instructions (text from sgml->rtf->text)
+      
+      
+       ./README
+       Introductory info
+      
+      
+       ./register.txt
+       Registration message during make
+      
+      
+       ./doc/bug.template
+       Bug report template
+      
+      
+       ./doc/postgres.tar.gz
+       Integrated docs (HTML)
+      
+      
+       ./doc/programmer.ps.gz
+       Programmer's Guide (Postscript)
+      
+      
+       ./doc/programmer.tar.gz
+       Programmer's Guide (HTML)
+      
+      
+       ./doc/reference.ps.gz
+       Reference Manual (Postscript)
+      
+      
+       ./doc/reference.tar.gz
+       Reference Manual (HTML)
+      
+      
+       ./doc/tutorial.ps.gz
+       Introduction (Postscript)
+      
+      
+       ./doc/tutorial.tar.gz
+       Introduction (HTML)
+      
+      
+       ./doc/user.ps.gz
+       User's Guide (Postscript)
+      
+       ./doc/user.tar.gz
+       User's Guide (HTML)
+      
      
     
    
   
 
   
-   There are man pages available for installation, as well as a large number
+   There are man pages available, as well as a large number
    of plain-text README-type files throughout the Postgres
    source tree.
   
@@ -166,9 +183,11 @@ Include working list of all documentation sources, with current status
 
   
    See
-   Introduction to DocBook
+   
+    Introduction to DocBook
    for a nice "quickstart" summary of DocBook features.
-    DocBook Elements
+   
+    DocBook Elements
    provides a powerful cross-reference for features of
    DocBook.
   
@@ -176,9 +195,11 @@ Include working list of all documentation sources, with current status
   
    This documentation set is constructed using several tools, including
    James Clark's 
-    jade
+   
+    jade
    and Norm Walsh's 
-   Modular DocBook Stylesheets.
+   
+    Modular DocBook Stylesheets.
   
 
   
@@ -191,7 +212,7 @@ Include working list of all documentation sources, with current status
   
    
     TeX is a supported format for
-   jade output, but was not used at this time
+   jade output, but is not used at this time
    for several reasons, including the inability to make minor format
    fixes before committing to hardcopy and generally inadequate table
    support in the TeX
@@ -999,7 +1020,97 @@ by typing
 -->
 
   
-   <acronym>RTF</acronym> Cleanup Procedure
+   Text Hardcopy
+
+   
+    INSTALL and HISTORY are
+    updated for each release. For historical reasons, these files are
+    in plain text, but are derived from the newer
+    SGML sources.
+   
+
+   
+    Plain Text Generation
+
+    
+     Both INSTALL and
+     HISTORY are generated from existing
+     SGML sources. They are extracted from the same 
+     intermediate RTF file.
+    
+
+    
+     
+      Generate RTF by typing:
+      
+% cd doc/src/sgml
+% make installation.rtf
+      
+     
+    
+      
+    
+     
+      Import installation.rtf into
+      Applix Words.
+     
+    
+
+    
+     
+      Set the page width and margins.
+     
+
+     
+      
+       
+   Adjust the page width in File.PageSetup to 10 inches.
+       
+      
+
+      
+       
+   Select all text.
+   Adjust the right margin using the ruler to 9.5 inches. This
+   will give a maximum column width of 79 characters, within the
+   80 columns upper limit goal.
+       
+      
+     
+    
+
+    
+     
+      Lop off the parts of the document which are not needed.
+     
+
+     
+      For INSTALL, remove all release notes from
+      the end of the text, except for those from the current release.
+      For HISTORY, remove all text up to the
+      release notes, preserving and modifying the title and ToC.
+     
+    
+
+    
+     
+      Export the result as ASCII Layout.
+     
+    
+
+    
+     
+      Using emacs or vi, clean up the tabular information in
+      INSTALL. Remove the mailto
+      URLs for the porting contributors to shrink
+      the column heights.
+     
+    
+   
+  
+
+  
+   Postscript Hardcopy
 
    
     Several items must be addressed in generating Postscript
@@ -1018,7 +1129,7 @@ by typing
 
     
      
-      Generate the RTF input by typing
+      Generate the RTF input by typing (for example):
       
 % cd doc/src/sgml
 % make tutorial.rtf
@@ -1048,7 +1159,7 @@ by typing
      
       Not all documents have figures.
       You can grep the SGML source files for
-      the string Graphic to identify those parts of the
+      the string graphic to identify those parts of the
       documentation which may have figures. A few figures are replicated in
       various parts of the documentation.
      
@@ -1093,7 +1204,8 @@ by typing
 
     
      
-      Export the document to a file in Postscript format.
+      Print the document
+      to a file in Postscript format.