From b80523090664df8a72a6937c2d2249f11e6dd3ae Mon Sep 17 00:00:00 2001 From: "Thomas G. Lockhart" Date: Thu, 27 May 1999 15:49:08 +0000 Subject: [PATCH] Markup fixes. Update for v6.5 release. --- doc/src/sgml/about.sgml | 53 ++-- doc/src/sgml/docguide.sgml | 553 +++++++++++++++++++------------------ doc/src/sgml/mvcc.sgml | 202 +++++++------- doc/src/sgml/notation.sgml | 205 +++++++------- doc/src/sgml/postgres.sgml | 8 +- doc/src/sgml/y2k.sgml | 144 +++++----- 6 files changed, 621 insertions(+), 544 deletions(-) diff --git a/doc/src/sgml/about.sgml b/doc/src/sgml/about.sgml index 5f43906a13..b1435050cb 100644 --- a/doc/src/sgml/about.sgml +++ b/doc/src/sgml/about.sgml @@ -1,18 +1,37 @@ - -About This Release + + About This Release - - PostgreSQL is available without cost. This manual - describes version 6.4 of PostgreSQL. - - - We will use Postgres -to mean the version distributed as PostgreSQL. - - -Check the Administrator's Guide for a list of currently supported machines. -In general, -Postgres is portable to any Unix/Posix-compatible system -with full libc library support. - - + + PostgreSQL is available without cost. This manual + describes version 6.5 of PostgreSQL. + + + + We will use Postgres + to mean the version distributed as PostgreSQL. + + + + Check the Administrator's Guide for a list of currently supported machines. + In general, + Postgres is portable to any Unix/Posix-compatible system + with full libc library support. + + + + diff --git a/doc/src/sgml/docguide.sgml b/doc/src/sgml/docguide.sgml index 0d0900f309..d16e3c1d1a 100644 --- a/doc/src/sgml/docguide.sgml +++ b/doc/src/sgml/docguide.sgml @@ -1,9 +1,13 @@ - - - - -Thomas -Lockhart - - -Tom Ivar -Helbekkmo - - -1998-04-28 - - -Documentation - - -The purpose of documentation is to make Postgres -easier to learn, use, and develop. -The documentation set should describe the Postgres -system, language, and interfaces. -It should be able to answer -common questions and to allow a user to find those answers on his own -without resorting to mailing list support. - - - -Documentation Roadmap - - -Postgres has four primary documentation -formats: - - - -Plain text for pre-installation information. - - -HTML, for on-line browsing and reference. - - -Hardcopy, for in-depth reading and reference. - - -man pages, for quick reference. - - - - - - -<ProductName>Postgres</ProductName> Documentation Products - - - - -File - - -Description - - - - - - ./COPYRIGHT Copyright 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 -of plain-text README-type files throughout the Postgres -source tree. - - - - -The Documentation Project - - -Packaged documentation is available in both -HTML and Postscript -formats. These are available as part of the standard -Postgres installation. We discuss here -working with the documentation sources and generating documentation -packages. - - - -The purpose of DocBook SGML - is to allow an author to -specify the structure and content of a document (e.g. using the -DocBook DTD), and to -have a document style define how that content is rendered into a -final form (e.g. using Norm Walsh's -Modular Style Sheets). - - - -See -Introduction to DocBook for a nice "quickstart" summary of -DocBook features. - DocBook Elements -provides a powerful cross-reference for features of -DocBook. - - - -This documentation set is constructed using several tools, including -James Clark's - jade - and Norm Walsh's -Modular DocBook Stylesheets. - - - -Currently, hardcopy is produced by importing Rich Text -Format (RTF) output from -jade into -ApplixWare for minor formatting fixups then -exporting as a Postscript file. - - - - -TeX is a supported format for -jade output, but was 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 -stylesheets. - - + + + + + Thomas + Lockhart + + + Tom Ivar + Helbekkmo + + + 1999-05-27 + + + Documentation + + + The purpose of documentation is to make Postgres + easier to learn, use, and develop. + The documentation set should describe the Postgres + system, language, and interfaces. + It should be able to answer + common questions and to allow a user to find those answers on his own + without resorting to mailing list support. + + + + Documentation Roadmap + + + Postgres has four primary documentation + formats: + + + + Plain text for pre-installation information. + + + HTML, for on-line browsing and reference. + + + Hardcopy, for in-depth reading and reference. + + + man pages, for quick reference. + + + + + + + <productname>Postgres</productname> Documentation Products + + + + + File + + + Description + + + + + + ./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) + + +
+ + + + There are man pages available for installation, as well as a large number + of plain-text README-type files throughout the Postgres + source tree. + + + + + The Documentation Project + + + Packaged documentation is available in both + HTML and Postscript + formats. These are available as part of the standard + Postgres installation. We discuss here + working with the documentation sources and generating documentation + packages. + + + + The documentation sources are written using SGML + markup of plain text files. + The purpose of DocBook SGML + is to allow an author to + specify the structure and content of a technical document (using the + DocBook DTD), and to + have a document style define how that content is rendered into a + final form (e.g. using Norm Walsh's + Modular Style Sheets). + + + See + Introduction to DocBook + for a nice "quickstart" summary of DocBook features. + DocBook Elements + provides a powerful cross-reference for features of + DocBook. + + + + This documentation set is constructed using several tools, including + James Clark's + jade + and Norm Walsh's + Modular DocBook Stylesheets. + + + + Currently, hardcopy is produced by importing + Rich Text Format (RTF) output from + jade into + ApplixWare for minor formatting fixups, then + exporting as a Postscript file. + + + + TeX is a supported format for + jade output, but was 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 + stylesheets. + + Documentation Sources @@ -352,7 +356,7 @@ Too much tabular info and not very helpful in hardcopy. -<ProductName>Postgres</ProductName> Documentation Sources +<productname>Postgres</productname> Documentation Sources @@ -526,7 +530,7 @@ Status
-<ProductName>Postgres</ProductName> Documentation Sources +<productname>Postgres</productname> Documentation Sources @@ -964,138 +968,141 @@ by typing - -Hardcopy Generation for v6.4 - - -The hardcopy Postscript documentation is generated by converting the -SGML source code to RTF, then -importing into ApplixWare-4.4.1. -After a little cleanup (see the following -section) the output is "printed" to a postscript file. - + + Hardcopy Generation for v6.5 - -Some figures were redrawn to avoid having bitmap -GIF files in the hardcopy documentation. One -figure, of the system catalogs, was sufficiently complex that there -was not time to redraw it. It was converted to fit using the -following commands: + + The hardcopy Postscript documentation is generated by converting the + SGML source code to RTF, then + importing into ApplixWare-4.4.1. + After a little cleanup (see the following + section) the output is "printed" to a postscript file. + - + - -<acronym>RTF</acronym> Cleanup Procedure + + <acronym>RTF</acronym> Cleanup Procedure - -Several items must be addressed in generating Postscript -hardcopy: + + Several items must be addressed in generating Postscript + hardcopy: - -Applixware <acronym>RTF</acronym> Cleanup + + Applixware <acronym>RTF</acronym> Cleanup - -Applixware does not seem to do a complete job of importing RTF -generated by jade/MSS. In particular, all text is given the -Header1 style attribute label, although the text -formatting itself is acceptable. Also, the Table of Contents page -numbers do not refer to the section listed in the table, but rather -refer to the page of the ToC itself. + + Applixware does not seem to do a complete job of importing RTF + generated by jade/MSS. In particular, all text is given the + Header1 style attribute label, although the text + formatting itself is acceptable. Also, the Table of Contents page + numbers do not refer to the section listed in the table, but rather + refer to the page of the ToC itself. - - -Generate the RTF input by typing - + + + Generate the RTF input by typing + % cd doc/src/sgml % make tutorial.rtf - - - - - - -Open a new document in Applix Words and -then import the RTF file. - - - - - -Print out the existing Table of Contents, to mark up in the following -few steps. - - - - - -Insert figures into the document. Center each figure on the page using -the centering margins button. - - -Not all documents have figures. You can grep the SGML source files for -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. - - - - - -Work through the document, adjusting page breaks and table column -widths. - - - - - -If a bibliography is present, Applix Words seems to mark all remaining -text after the first title as having an underlined attribute. Select -all remaining text, turn off underlining using the underlining button, -then explicitly underline each document and book title. - - - - - -Work through the document, marking up the ToC hardcopy with the actual -page number of each ToC entry. - - - - - -Replace the right-justified incorrect page numbers in the ToC with -correct values. This only takes a few minutes per document. - - - - - -Save the document as native Applix Words format to allow easier last -minute editing later. - - - - - -Export the document to a file in Postscript format. - - - - - -Compress the Postscript file using gzip. -Place the compressed file into the doc directory. - - - - - + + + + + + + Open a new document in Applix Words and + then import the RTF file. + + + + + + Print out the existing Table of Contents, to mark up in the following + few steps. + + + + + + Insert figures into the document. Center each figure on the page using + the centering margins button. + + + Not all documents have figures. + You can grep the SGML source files for + 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. + + + + + + Work through the document, adjusting page breaks and table column + widths. + + + + + + If a bibliography is present, Applix Words seems to mark all remaining + text after the first title as having an underlined attribute. Select + all remaining text, turn off underlining using the underlining button, + then explicitly underline each document and book title. + + + + + + Work through the document, marking up the ToC hardcopy with the actual + page number of each ToC entry. + + + + + + Replace the right-justified incorrect page numbers in the ToC with + correct values. This only takes a few minutes per document. + + + + + + Save the document as native Applix Words format to allow easier last + minute editing later. + + + + + + Export the document to a file in Postscript format. + + + + + + Compress the Postscript file using gzip. + Place the compressed file into the doc directory. + + + + + @@ -1660,7 +1667,7 @@ Run texhash to update the tex database. diff --git a/doc/src/sgml/postgres.sgml b/doc/src/sgml/postgres.sgml index f68a521c19..01470c6f9e 100644 --- a/doc/src/sgml/postgres.sgml +++ b/doc/src/sgml/postgres.sgml @@ -1,11 +1,15 @@ -- 2.40.0