From ccc6851d0aea78481ebb899dbfcc95d5dd8b6515 Mon Sep 17 00:00:00 2001 From: "Thomas G. Lockhart" Date: Sat, 15 Aug 1998 06:53:52 +0000 Subject: [PATCH] Include working list of all documentation sources, with current status and plans for some of them. --- doc/src/sgml/docguide.sgml | 77 +++++++++++++++++++++++--------------- 1 file changed, 46 insertions(+), 31 deletions(-) diff --git a/doc/src/sgml/docguide.sgml b/doc/src/sgml/docguide.sgml index a5da8c4eaf..0005105046 100644 --- a/doc/src/sgml/docguide.sgml +++ b/doc/src/sgml/docguide.sgml @@ -1,3 +1,15 @@ + + @@ -121,6 +133,7 @@ Description ./COPYRIGHT Copyright notice ./register.txt Registration message during make + ./doc/bug.template Not converted ./doc/postgres.tar.gz Integrated docs (HTML) ./doc/programmer.ps.gz Programmer's Guide (Postscript) ./doc/programmer.tar.gz Programmer's Guide (HTML) @@ -259,9 +272,9 @@ Status - ./HISTORY Not converted + ./HISTORY Obsolete. Converted to release.sgml ./README Not converted - ./INSTALL Not converted + ./INSTALL Obsolete. Converted to install.sgml ./contrib/README Not converted ./contrib/apache_logging/README Not converted ./contrib/array/array_iterator.doc Not converted @@ -290,23 +303,22 @@ Status ./doc/FAQ_Linux Not converted ./doc/TODO Not converted ./doc/README.GEQO Removed. Superceded by geqo.sgml - ./doc/README.fsync Not converted - ./doc/README.locale Not converted - ./doc/README.mb Not converted + ./doc/README.fsync Assimilate into Admin Guide + ./doc/README.locale Assimilate into Admin Guide + ./doc/README.mb Assimilate into Admin Guide ./doc/README.mb.jp Not converted ./doc/README.support Not converted ./doc/TODO.GEQO Removed. Superceded by geqo.sgml - ./doc/bug.template Not converted - ./doc/userguide.ps Obsolete. Remove from distribution - ./migration/1.02_to_1.02.1 Removed (converted to SGML) - ./migration/1.09_to_6.0 Removed (converted to SGML) - ./migration/1.0_to_1.01 Removed (converted to SGML) - ./migration/6.0_to_6.1 Removed (converted to SGML) - ./migration/6.1_to_6.1.1 Removed (converted to SGML) - ./migration/6.1_to_6.2 Removed (converted to SGML) - ./migration/6.2.1_to_6.3 Removed (converted to SGML) - ./migration/6.2_to_6.2.1 Removed (converted to SGML) - ./migration/6.3.1_to_6.3.2 Removed (converted to SGML) + ./doc/userguide.ps Removed (converted to SGML) + ./migration/1.02_to_1.02.1 Removed. Superceded by release.sgml + ./migration/1.09_to_6.0 Removed. Superceded by release.sgml + ./migration/1.0_to_1.01 Removed. Superceded by release.sgml + ./migration/6.0_to_6.1 Removed. Superceded by release.sgml + ./migration/6.1_to_6.1.1 Removed. Superceded by release.sgml + ./migration/6.1_to_6.2 Removed. Superceded by release.sgml + ./migration/6.2.1_to_6.3 Removed. Superceded by release.sgml + ./migration/6.2_to_6.2.1 Removed. Superceded by release.sgml + ./migration/6.3.1_to_6.3.2 Removed. Superceded by release.sgml ./src/DEVELOPERS Not converted ./src/backend/access/nbtree/README Not converted ./src/backend/catalog/README Not converted @@ -383,10 +395,10 @@ Status ./src/man/ecpg.1 Not converted ./src/man/abort.l Not converted ./src/man/alter_table.l Not converted - ./src/man/alter_user.l Not converted + ./src/man/alter_user.l Split into Reference and Admin Guide ./src/man/begin.l Not converted - ./src/man/bki.5 Not converted - ./src/man/catalogs.3 Not converted + ./src/man/bki.5 Removed. Superceded by bki.sgml + ./src/man/catalogs.3 Catalog synopsis. Move to Programmer's Guide? ./src/man/cleardbdir.1 Not converted ./src/man/close.l Not converted ./src/man/cluster.l Not converted @@ -435,22 +447,22 @@ Status ./src/man/insert.l Not converted ./src/man/ipcclean.1 Not converted ./src/man/large_objects.3 Not converted - ./src/man/libpq.3 Not converted + ./src/man/libpq.3 Obsolete. Superceded by libpq.sgml ./src/man/listen.l Not converted ./src/man/load.l Not converted ./src/man/lock.l Not converted ./src/man/move.l Not converted ./src/man/notify.l Not converted - ./src/man/oracle_compat.3 Obsolete. Superceded by func.sgml - ./src/man/page.5 Not converted - ./src/man/pg_dump.1 Not converted - ./src/man/pg_dumpall.1 Not converted - ./src/man/pg_hba.conf.5 Not converted - ./src/man/pg_passwd.1 Not converted + ./src/man/oracle_compat.3 Removed. Superceded by func.sgml + ./src/man/page.5 Table storage. Assimilate into Dev Guide + ./src/man/pg_dump.1 Assimilate into Admin Guide + ./src/man/pg_dumpall.1 Assimilate into Admin Guide + ./src/man/pg_hba.conf.5 Assimilate into Admin Guide + ./src/man/pg_passwd.1 Assimilate into Admin Guide ./src/man/pgbuiltin.3 Obsolete. Superceded by datatype.sgml - ./src/man/pgintro.1 Not converted - ./src/man/postgres.1 Not converted - ./src/man/postmaster.1 Not converted + ./src/man/pgintro.1 Assimilate into User's Guide? + ./src/man/postgres.1 Assimilate into User's, Admin Guides + ./src/man/postmaster.1 Assimilate into User's, Admin Guides ./src/man/psql.1 Not converted ./src/man/reset.l Not converted ./src/man/revoke.l Not converted @@ -508,7 +520,10 @@ used for the documentation. The primary source files are: postgres.sgml -This is the integrated document, including all other documents as parts. +This is the integrated document, including all other documents as parts. +Output is generated in HTML since the browser interface +makes it easy to move around all of the documentation by just clicking. +The other documents are available in both HTML and hardcopy. @@ -608,7 +623,7 @@ James Clark's Currently, hardcopy is produced by importing Rich Text Format (RTF) output from -jade to +jade into ApplixWare for minor formatting fixups then exporting as a Postscript file.