diff --git a/doc/src/sgml/docguide.sgml b/doc/src/sgml/docguide.sgml index db4bcce56e..dc53c88b80 100644 --- a/doc/src/sgml/docguide.sgml +++ b/doc/src/sgml/docguide.sgml @@ -70,6 +70,25 @@ + + Documentation Structure + + + The root of the XML document that is the manual, the book + element, is found in /doc/src/sgml/postgres.sgml. + Within the book are parts, mostly defined within the same file, expect for the + Reference part, which is found in /doc/src/sgml/reference.sgml. + + + + Modularization is done by using entities. These are defined in two places as + well (corresponding to postgres.sgml and + reference.sgml), + /doc/src/sgml/filelist.sgml and + /doc/src/sgml/ref/allfiles.sgml. See comments in those + files for more information. + + Tool Sets diff --git a/doc/src/sgml/filelist.sgml b/doc/src/sgml/filelist.sgml index 25fb99cee6..4f92942964 100644 --- a/doc/src/sgml/filelist.sgml +++ b/doc/src/sgml/filelist.sgml @@ -1,5 +1,30 @@ + + + + +%allfiles; + + @@ -34,96 +59,93 @@ + - + + - - + + - - + + + + + - - - - - - - - -%allfiles; + + + + - + + + + - - - - - + - - + + + + - - - - - + + - + + + - - - - - - + + + @@ -144,7 +166,7 @@ - + @@ -155,7 +177,6 @@ - @@ -165,40 +186,38 @@ - + + + + + + + + + + - - - - - - - - - - - - - + + diff --git a/doc/src/sgml/postgres.sgml b/doc/src/sgml/postgres.sgml index af476c82fc..22a9bc9870 100644 --- a/doc/src/sgml/postgres.sgml +++ b/doc/src/sgml/postgres.sgml @@ -233,6 +233,11 @@ break is not needed in a wider output rendering. + &reference; diff --git a/doc/src/sgml/ref/allfiles.sgml b/doc/src/sgml/ref/allfiles.sgml index f5be638867..7a7b876fbe 100644 --- a/doc/src/sgml/ref/allfiles.sgml +++ b/doc/src/sgml/ref/allfiles.sgml @@ -2,6 +2,14 @@ doc/src/sgml/ref/allfiles.sgml PostgreSQL documentation Complete list of usable sgml source files in this directory. + +See ../filelist.sgml for how this is incorporated into the manual. +These pages are also used to generate the "man" build outputs. + +Pages are listed in alphabetical order. They use refentry top-level +elements instead of chapters or sections. + +Entities defined here are referenced in ../reference.sgml --> diff --git a/doc/src/sgml/reference.sgml b/doc/src/sgml/reference.sgml index ff85ace83f..1c53b396e3 100644 --- a/doc/src/sgml/reference.sgml +++ b/doc/src/sgml/reference.sgml @@ -1,5 +1,13 @@ + Reference