|
| 1 | +<!-- |
| 2 | +$Header: /cvsroot/pgsql/doc/src/sgml/docguide.sgml,v 1.7 1998/08/15 06:53:52 thomas Exp $ |
| 3 | +Documentation Guide |
| 4 | +Thomas Lockhart |
| 5 | + |
| 6 | +$Log: docguide.sgml,v $ |
| 7 | +Revision 1.7 1998/08/15 06:53:52 thomas |
| 8 | +Include working list of all documentation sources, with current status |
| 9 | + and plans for some of them. |
| 10 | + |
| 11 | +--> |
| 12 | + |
1 | 13 | <appendix label="A" Id="docguide">
|
2 | 14 | <docinfo>
|
3 | 15 | <authorgroup>
|
@@ -121,6 +133,7 @@ Description
|
121 | 133 | <tbody>
|
122 | 134 | <row><entry>./COPYRIGHT</entry><entry>Copyright notice</entry></row>
|
123 | 135 | <row><entry>./register.txt</entry><entry>Registration message during make</entry></row>
|
| 136 | +<row><entry>./doc/bug.template</entry><entry>Not converted</entry></row> |
124 | 137 | <row><entry>./doc/postgres.tar.gz</entry><entry>Integrated docs (<acronym>HTML</acronym>)</entry></row>
|
125 | 138 | <row><entry>./doc/programmer.ps.gz</entry><entry>Programmer's Guide (Postscript)</entry></row>
|
126 | 139 | <row><entry>./doc/programmer.tar.gz</entry><entry>Programmer's Guide (<acronym>HTML</acronym>)</entry></row>
|
@@ -259,9 +272,9 @@ Status
|
259 | 272 | </thead>
|
260 | 273 |
|
261 | 274 | <tbody>
|
262 |
| -<row><entry>./HISTORY</entry><entry>Not converted</entry></row> |
| 275 | +<row><entry>./HISTORY</entry><entry>Obsolete. Converted to release.sgml</entry></row> |
263 | 276 | <row><entry>./README</entry><entry>Not converted</entry></row>
|
264 |
| -<row><entry>./INSTALL</entry><entry>Not converted</entry></row> |
| 277 | +<row><entry>./INSTALL</entry><entry>Obsolete. Converted to install.sgml</entry></row> |
265 | 278 | <row><entry>./contrib/README</entry><entry>Not converted</entry></row>
|
266 | 279 | <row><entry>./contrib/apache_logging/README</entry><entry>Not converted</entry></row>
|
267 | 280 | <row><entry>./contrib/array/array_iterator.doc</entry><entry>Not converted</entry></row>
|
@@ -290,23 +303,22 @@ Status
|
290 | 303 | <row><entry>./doc/FAQ_Linux</entry><entry>Not converted</entry></row>
|
291 | 304 | <row><entry>./doc/TODO</entry><entry>Not converted</entry></row>
|
292 | 305 | <row><entry>./doc/README.GEQO</entry><entry>Removed. Superceded by geqo.sgml</entry></row>
|
293 |
| -<row><entry>./doc/README.fsync</entry><entry>Not converted</entry></row> |
294 |
| -<row><entry>./doc/README.locale</entry><entry>Not converted</entry></row> |
295 |
| -<row><entry>./doc/README.mb</entry><entry>Not converted</entry></row> |
| 306 | +<row><entry>./doc/README.fsync</entry><entry>Assimilate into Admin Guide</entry></row> |
| 307 | +<row><entry>./doc/README.locale</entry><entry>Assimilate into Admin Guide</entry></row> |
| 308 | +<row><entry>./doc/README.mb</entry><entry>Assimilate into Admin Guide</entry></row> |
296 | 309 | <row><entry>./doc/README.mb.jp</entry><entry>Not converted</entry></row>
|
297 | 310 | <row><entry>./doc/README.support</entry><entry>Not converted</entry></row>
|
298 | 311 | <row><entry>./doc/TODO.GEQO</entry><entry>Removed. Superceded by geqo.sgml</entry></row>
|
299 |
| -<row><entry>./doc/bug.template</entry><entry>Not converted</entry></row> |
300 |
| -<row><entry>./doc/userguide.ps</entry><entry>Obsolete. Remove from distribution</entry></row> |
301 |
| -<row><entry>./migration/1.02_to_1.02.1</entry><entry>Removed (converted to SGML)</entry></row> |
302 |
| -<row><entry>./migration/1.09_to_6.0</entry><entry>Removed (converted to SGML)</entry></row> |
303 |
| -<row><entry>./migration/1.0_to_1.01</entry><entry>Removed (converted to SGML)</entry></row> |
304 |
| -<row><entry>./migration/6.0_to_6.1</entry><entry>Removed (converted to SGML)</entry></row> |
305 |
| -<row><entry>./migration/6.1_to_6.1.1</entry><entry>Removed (converted to SGML)</entry></row> |
306 |
| -<row><entry>./migration/6.1_to_6.2</entry><entry>Removed (converted to SGML)</entry></row> |
307 |
| -<row><entry>./migration/6.2.1_to_6.3</entry><entry>Removed (converted to SGML)</entry></row> |
308 |
| -<row><entry>./migration/6.2_to_6.2.1</entry><entry>Removed (converted to SGML)</entry></row> |
309 |
| -<row><entry>./migration/6.3.1_to_6.3.2</entry><entry>Removed (converted to SGML)</entry></row> |
| 312 | +<row><entry>./doc/userguide.ps</entry><entry>Removed (converted to SGML)</entry></row> |
| 313 | +<row><entry>./migration/1.02_to_1.02.1</entry><entry>Removed. Superceded by release.sgml</entry></row> |
| 314 | +<row><entry>./migration/1.09_to_6.0</entry><entry>Removed. Superceded by release.sgml</entry></row> |
| 315 | +<row><entry>./migration/1.0_to_1.01</entry><entry>Removed. Superceded by release.sgml</entry></row> |
| 316 | +<row><entry>./migration/6.0_to_6.1</entry><entry>Removed. Superceded by release.sgml</entry></row> |
| 317 | +<row><entry>./migration/6.1_to_6.1.1</entry><entry>Removed. Superceded by release.sgml</entry></row> |
| 318 | +<row><entry>./migration/6.1_to_6.2</entry><entry>Removed. Superceded by release.sgml</entry></row> |
| 319 | +<row><entry>./migration/6.2.1_to_6.3</entry><entry>Removed. Superceded by release.sgml</entry></row> |
| 320 | +<row><entry>./migration/6.2_to_6.2.1</entry><entry>Removed. Superceded by release.sgml</entry></row> |
| 321 | +<row><entry>./migration/6.3.1_to_6.3.2</entry><entry>Removed. Superceded by release.sgml</entry></row> |
310 | 322 | <row><entry>./src/DEVELOPERS</entry><entry>Not converted</entry></row>
|
311 | 323 | <row><entry>./src/backend/access/nbtree/README</entry><entry>Not converted</entry></row>
|
312 | 324 | <row><entry>./src/backend/catalog/README</entry><entry>Not converted</entry></row>
|
@@ -383,10 +395,10 @@ Status
|
383 | 395 | <row><entry>./src/man/ecpg.1</entry><entry>Not converted</entry></row>
|
384 | 396 | <row><entry>./src/man/abort.l</entry><entry>Not converted</entry></row>
|
385 | 397 | <row><entry>./src/man/alter_table.l</entry><entry>Not converted</entry></row>
|
386 |
| -<row><entry>./src/man/alter_user.l</entry><entry>Not converted</entry></row> |
| 398 | +<row><entry>./src/man/alter_user.l</entry><entry>Split into Reference and Admin Guide</entry></row> |
387 | 399 | <row><entry>./src/man/begin.l</entry><entry>Not converted</entry></row>
|
388 |
| -<row><entry>./src/man/bki.5</entry><entry>Not converted</entry></row> |
389 |
| -<row><entry>./src/man/catalogs.3</entry><entry>Not converted</entry></row> |
| 400 | +<row><entry>./src/man/bki.5</entry><entry>Removed. Superceded by bki.sgml</entry></row> |
| 401 | +<row><entry>./src/man/catalogs.3</entry><entry>Catalog synopsis. Move to Programmer's Guide?</entry></row> |
390 | 402 | <row><entry>./src/man/cleardbdir.1</entry><entry>Not converted</entry></row>
|
391 | 403 | <row><entry>./src/man/close.l</entry><entry>Not converted</entry></row>
|
392 | 404 | <row><entry>./src/man/cluster.l</entry><entry>Not converted</entry></row>
|
@@ -435,22 +447,22 @@ Status
|
435 | 447 | <row><entry>./src/man/insert.l</entry><entry>Not converted</entry></row>
|
436 | 448 | <row><entry>./src/man/ipcclean.1</entry><entry>Not converted</entry></row>
|
437 | 449 | <row><entry>./src/man/large_objects.3</entry><entry>Not converted</entry></row>
|
438 |
| -<row><entry>./src/man/libpq.3</entry><entry>Not converted</entry></row> |
| 450 | +<row><entry>./src/man/libpq.3</entry><entry>Obsolete. Superceded by libpq.sgml</entry></row> |
439 | 451 | <row><entry>./src/man/listen.l</entry><entry>Not converted</entry></row>
|
440 | 452 | <row><entry>./src/man/load.l</entry><entry>Not converted</entry></row>
|
441 | 453 | <row><entry>./src/man/lock.l</entry><entry>Not converted</entry></row>
|
442 | 454 | <row><entry>./src/man/move.l</entry><entry>Not converted</entry></row>
|
443 | 455 | <row><entry>./src/man/notify.l</entry><entry>Not converted</entry></row>
|
444 |
| -<row><entry>./src/man/oracle_compat.3</entry><entry>Obsolete. Superceded by func.sgml</entry></row> |
445 |
| -<row><entry>./src/man/page.5</entry><entry>Not converted</entry></row> |
446 |
| -<row><entry>./src/man/pg_dump.1</entry><entry>Not converted</entry></row> |
447 |
| -<row><entry>./src/man/pg_dumpall.1</entry><entry>Not converted</entry></row> |
448 |
| -<row><entry>./src/man/pg_hba.conf.5</entry><entry>Not converted</entry></row> |
449 |
| -<row><entry>./src/man/pg_passwd.1</entry><entry>Not converted</entry></row> |
| 456 | +<row><entry>./src/man/oracle_compat.3</entry><entry>Removed. Superceded by func.sgml</entry></row> |
| 457 | +<row><entry>./src/man/page.5</entry><entry>Table storage. Assimilate into Dev Guide</entry></row> |
| 458 | +<row><entry>./src/man/pg_dump.1</entry><entry>Assimilate into Admin Guide</entry></row> |
| 459 | +<row><entry>./src/man/pg_dumpall.1</entry><entry>Assimilate into Admin Guide</entry></row> |
| 460 | +<row><entry>./src/man/pg_hba.conf.5</entry><entry>Assimilate into Admin Guide</entry></row> |
| 461 | +<row><entry>./src/man/pg_passwd.1</entry><entry>Assimilate into Admin Guide</entry></row> |
450 | 462 | <row><entry>./src/man/pgbuiltin.3</entry><entry>Obsolete. Superceded by datatype.sgml</entry></row>
|
451 |
| -<row><entry>./src/man/pgintro.1</entry><entry>Not converted</entry></row> |
452 |
| -<row><entry>./src/man/postgres.1</entry><entry>Not converted</entry></row> |
453 |
| -<row><entry>./src/man/postmaster.1</entry><entry>Not converted</entry></row> |
| 463 | +<row><entry>./src/man/pgintro.1</entry><entry>Assimilate into User's Guide?</entry></row> |
| 464 | +<row><entry>./src/man/postgres.1</entry><entry>Assimilate into User's, Admin Guides</entry></row> |
| 465 | +<row><entry>./src/man/postmaster.1</entry><entry>Assimilate into User's, Admin Guides</entry></row> |
454 | 466 | <row><entry>./src/man/psql.1</entry><entry>Not converted</entry></row>
|
455 | 467 | <row><entry>./src/man/reset.l</entry><entry>Not converted</entry></row>
|
456 | 468 | <row><entry>./src/man/revoke.l</entry><entry>Not converted</entry></row>
|
@@ -508,7 +520,10 @@ used for the documentation. The primary source files are:
|
508 | 520 | <term>postgres.sgml</term>
|
509 | 521 | <listitem>
|
510 | 522 | <para>
|
511 |
| -This is the integrated document, including all other documents as <firstterm>parts</firstterm>. |
| 523 | +This is the integrated document, including all other documents as parts. |
| 524 | +Output is generated in <acronym>HTML</acronym> since the browser interface |
| 525 | +makes it easy to move around all of the documentation by just clicking. |
| 526 | +The other documents are available in both <acronym>HTML</acronym> and hardcopy. |
512 | 527 | </para>
|
513 | 528 | </listitem>
|
514 | 529 | </varlistentry>
|
@@ -608,7 +623,7 @@ James Clark's
|
608 | 623 | <para>
|
609 | 624 | Currently, hardcopy is produced by importing <firstterm>Rich Text
|
610 | 625 | Format</firstterm> (<acronym>RTF</acronym>) output from
|
611 |
| -<application>jade</application>to |
| 626 | +<application>jade</application>into |
612 | 627 | <productname>ApplixWare</productname> for minor formatting fixups then
|
613 | 628 | exporting as a Postscript file.</para>
|
614 | 629 |
|
|