Skip to content

Commit 266a280

Browse files
peterepetere
committed
Add introductory sections explaining what each book is about. Remove Y2K
statement.
1 parent b171f59 commit 266a280

19 files changed

+260
-210
lines changed

‎doc/src/sgml/admin.sgml

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/Attic/admin.sgml,v 1.39 2002/10/16 22:06:33 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/Attic/admin.sgml,v 1.40 2002/10/24 17:48:54 petere Exp $
33
-->
44

55
<book id="admin">
@@ -13,14 +13,60 @@ $Header: /cvsroot/pgsql/doc/src/sgml/Attic/admin.sgml,v 1.39 2002/10/16 22:06:33
1313
&legal;
1414
</bookinfo>
1515

16-
<!--
17-
Disable these extra intro chapters since some elements (e.g. y2k
18-
statement) are included in the first intro.sgml and cause errors if
19-
included twice.
20-
-->
16+
<preface id="admin-preface">
17+
<title>Preface</title>
18+
2119
<![%single-book;[
2220
&intro;
21+
&history;
22+
]]>
23+
24+
<sect1 id="admin-preface-thisbook">
25+
<title>What's In This Book</title>
26+
27+
<para>
28+
This book covers topics that are of interest to a PostgreSQL
29+
database administrator. This includes installation of the
30+
software, set up and configuration of the server, management of
31+
users and databases, and maintenance tasks. Anyone who runs a
32+
PostgreSQL server, either for personal use, but especially in
33+
production, should be familiar with the topics covered in this
34+
book.
35+
</para>
36+
37+
<para>
38+
The information in this book is arranged approximately in the
39+
order in which a new user should read it. But the chapters are
40+
self-contained and can be read individually as desired. The
41+
information in this book is presented in a narrative fashion in
42+
topical units. Readers looking for a complete description of a
43+
particular command should look into the &cite-reference;.
44+
</para>
45+
46+
<para>
47+
The first few chapters are written so that they can be understood
48+
without prerequisite knowledge, so that new users who need to set
49+
up their own server can begin their exploration with this book.
50+
The rest of this book which is about tuning and management
51+
presupposes that the reader is familiar with the general use of
52+
the PostgreSQL database system. Readers are encouraged to look at
53+
the &cite-tutorial; and the &cite-user; for additional
54+
information.
55+
</para>
56+
57+
<para>
58+
This book covers <productname>PostgreSQL &version;</productname>
59+
only. For information on other versions, please read the
60+
documentation that accompanies that release.
61+
</para>
62+
</sect1>
63+
64+
<![%single-book;[
65+
&info;
66+
&notation;
67+
&problems;
2368
]]>
69+
</preface>
2470

2571
&installation;
2672
&installw;

‎doc/src/sgml/advanced.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/advanced.sgml,v 1.29 2002/10/20 05:05:46 tgl Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/advanced.sgml,v 1.30 2002/10/24 17:48:54 petere Exp $
33
-->
44

55
<chapter id="tutorial-advanced">
@@ -130,7 +130,7 @@ ERROR: &lt;unnamed&gt; referential integrity violation - key referenced from we
130130
<para>
131131
The behavior of foreign keys can be finely tuned to your
132132
application. We will not go beyond this simple example in this
133-
tutorial, but just refer you to &cite-reference;
133+
tutorial, but just refer you to the &cite-reference;
134134
for more information. Making correct use of
135135
foreign keys will definitely improve the quality of your database
136136
applications, so you are strongly encouraged to learn about them.
@@ -394,8 +394,8 @@ SELECT name, altitude
394394
<productname>PostgreSQL</productname> has many features not
395395
touched upon in this tutorial introduction, which has been
396396
oriented toward newer users of <acronym>SQL</acronym>. These
397-
features are discussed in more detail in both &cite-user;
398-
and &cite-programmer;.
397+
features are discussed in more detail in both the &cite-user;
398+
and the &cite-programmer;.
399399
</para>
400400

401401
<para>

‎doc/src/sgml/ddl.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ddl.sgml,v 1.6 2002/10/20 05:05:46 tgl Exp $ -->
1+
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/ddl.sgml,v 1.7 2002/10/24 17:48:54 petere Exp $ -->
22

33
<chapter id="ddl">
44
<title>Data Definition</title>
@@ -13,7 +13,7 @@
1313
schemas, and how privileges can be assigned to tables. Finally,
1414
we will briefly look at other features that affect the data storage,
1515
such as views, functions, and triggers. Detailed information on
16-
these topics is found in &cite-programmer;.
16+
these topics is found in the &cite-programmer;.
1717
</para>
1818

1919
<sect1 id="ddl-basics">
@@ -786,7 +786,7 @@ CREATE TABLE order_items (
786786
If the foreign key references a unique constraint, there are some
787787
additional possibilities regarding how null values are matched.
788788
These are explained in the <literal>CREATE TABLE</literal> entry
789-
in &cite-reference;.
789+
in the &cite-reference;.
790790
</para>
791791
</sect2>
792792
</sect1>

‎doc/src/sgml/ecpg.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.38 2002/10/21 18:04:05 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ecpg.sgml,v 1.39 2002/10/24 17:48:54 petere Exp $
33
-->
44

55
<chapter id="ecpg">
@@ -798,7 +798,7 @@ ECPG = ecpg
798798

799799
<para>
800800
The complete syntax of the <command>ecpg</command> command is
801-
detailed in &cite-reference;.
801+
detailed in the &cite-reference;.
802802
</para>
803803
</sect1>
804804

‎doc/src/sgml/entities.sgml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
<![%single-book;[
22

3-
<!entity cite-admin "the <citetitle>PostgreSQL Administrator's Guide</citetitle>">
4-
<!entity cite-developer "the <citetitle>PostgreSQL Developer's Guide</citetitle>">
5-
<!entity cite-programmer "the <citetitle>PostgreSQL Programmer's Guide</citetitle>">
6-
<!entity cite-reference "the <citetitle>PostgreSQL Reference Manual</citetitle>">
7-
<!entity cite-tutorial "the <citetitle>PostgreSQL Tutorial</citetitle>">
8-
<!entity cite-user "the <citetitle>PostgreSQL User's Guide</citetitle>">
3+
<!entity cite-admin "<citetitle>PostgreSQL Administrator's Guide</citetitle>">
4+
<!entity cite-developer "<citetitle>PostgreSQL Developer's Guide</citetitle>">
5+
<!entity cite-programmer "<citetitle>PostgreSQL Programmer's Guide</citetitle>">
6+
<!entity cite-reference "<citetitle>PostgreSQL Reference Manual</citetitle>">
7+
<!entity cite-tutorial "<citetitle>PostgreSQL Tutorial</citetitle>">
8+
<!entity cite-user "<citetitle>PostgreSQL User's Guide</citetitle>">
99

1010
]]>
1111
<![%set-of-books;[
1212

13-
<!entity cite-admin "the <xref linkend='admin'>">
14-
<!entity cite-developer "the <xref linkend='developer'>">
15-
<!entity cite-programmer "the <xref linkend='programmer'>">
16-
<!entity cite-reference "the <xref linkend='reference'>">
17-
<!entity cite-tutorial "the <xref linkend='tutorial'>">
18-
<!entity cite-user "the <xref linkend='user'>">
13+
<!entity cite-admin "<xref linkend='admin'>">
14+
<!entity cite-developer "<xref linkend='developer'>">
15+
<!entity cite-programmer "<xref linkend='programmer'>">
16+
<!entity cite-reference "<xref linkend='reference'>">
17+
<!entity cite-tutorial "<xref linkend='tutorial'>">
18+
<!entity cite-user "<xref linkend='user'>">
1919

2020
]]>

‎doc/src/sgml/filelist.sgml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/filelist.sgml,v 1.24 2002/10/16 22:06:33 petere Exp $ -->
1+
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/filelist.sgml,v 1.25 2002/10/24 17:48:54 petere Exp $ -->
22

33
<!entity history SYSTEM "history.sgml">
44
<!entity info SYSTEM "info.sgml">
55
<!entity intro SYSTEM "intro.sgml">
66
<!entity legal SYSTEM "legal.sgml">
77
<!entity notation SYSTEM "notation.sgml">
88
<!entity problems SYSTEM "problems.sgml">
9-
<!entity y2k SYSTEM "y2k.sgml">
109

1110
<!entity bookindex SYSTEM "bookindex.sgml">
1211
<!entity setindex SYSTEM "setindex.sgml">

‎doc/src/sgml/info.sgml

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,76 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.15 2001/11/28 20:49:10 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.16 2002/10/24 17:48:54 petere Exp $
33
-->
44

55
<sect1 id="resources">
6-
<title>Documentation Resources</title>
6+
<title>Overview of Documentation Resources</title>
77

88
<para>
9-
This manual set is organized into several parts:
9+
The PostgreSQL documentation is organized into several books:
1010

1111
<variablelist>
1212
<varlistentry>
13-
<term>Tutorial</term>
13+
<term>&cite-tutorial;</term>
1414
<listitem>
1515
<para>
16-
An informal introduction for new users
16+
An informal introduction for new users.
1717
</para>
1818
</listitem>
1919
</varlistentry>
2020

2121
<varlistentry>
22-
<term>User's Guide</term>
22+
<term>&cite-user;</term>
2323
<listitem>
2424
<para>
25-
Documents the SQL query language environment, including data types
26-
and functions.
25+
Documents the SQL query language environment, including data
26+
types and functions, as well as user-level performance tuning.
27+
Every PostgreSQL user should read this.
2728
</para>
2829
</listitem>
2930
</varlistentry>
3031

3132
<varlistentry>
32-
<term>Programmer's Guide</term>
33+
<term>&cite-admin;</term>
3334
<listitem>
3435
<para>
35-
Advanced information for application programmers. Topics include
36-
type and function extensibility, library interfaces,
37-
and application design issues.
36+
Installation and server management information. Everyone who
37+
runs a PostgreSQL server, either for personal use or for other
38+
users, needs to read this.
3839
</para>
3940
</listitem>
4041
</varlistentry>
4142

4243
<varlistentry>
43-
<term>Administrator's Guide</term>
44+
<term>&cite-programmer;</term>
4445
<listitem>
4546
<para>
46-
Installation and server management information
47+
Advanced information for application programmers. Topics include
48+
type and function extensibility, library interfaces, and
49+
application design issues.
4750
</para>
4851
</listitem>
4952
</varlistentry>
5053

5154
<varlistentry>
52-
<term>Reference Manual</term>
55+
<term>&cite-reference;</term>
5356
<listitem>
5457
<para>
55-
Reference pages for SQL command syntax and client and server programs
58+
Reference pages for SQL command syntax, and client and server
59+
programs. This book is auxiliary to the User's,
60+
Administrator's, and Programmer's Guides.
5661
</para>
5762
</listitem>
5863
</varlistentry>
5964

6065
<varlistentry>
61-
<term>Developer's Guide</term>
66+
<term>&cite-developer;</term>
6267
<listitem>
6368
<para>
64-
Information for <productname>PostgreSQL</productname> developers.
65-
This is intended for those who are contributing to the
66-
<productname>PostgreSQL</productname> project;
67-
application development information appears in the
68-
<citetitle>Programmer's Guide</citetitle>.
69+
Information for <productname>PostgreSQL</productname>
70+
developers. This is intended for those who are contributing to
71+
the <productname>PostgreSQL</productname> project; application
72+
development information appears in the <citetitle>Programmer's
73+
Guide</citetitle>.
6974
</para>
7075
</listitem>
7176
</varlistentry>
@@ -81,8 +86,8 @@ $Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.15 2001/11/28 20:49:10 petere
8186
<term>man pages</term>
8287
<listitem>
8388
<para>
84-
The <citetitle>Reference Manual</citetitle>'s pages in the traditional
85-
Unix man format.
89+
The <citetitle>Reference Manual</citetitle>'s pages in the
90+
traditional Unix man format. There is no difference in content.
8691
</para>
8792
</listitem>
8893
</varlistentry>

‎doc/src/sgml/intro.sgml

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/intro.sgml,v 1.19 2002/01/07 02:29:12 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/intro.sgml,v 1.20 2002/10/24 17:48:54 petere Exp $
33
-->
44

5-
<preface id="preface">
6-
<title>Preface</title>
7-
85
<sect1 id="intro-whatis">
96
<title> What is <productname>PostgreSQL</productname>?</title>
107

@@ -95,14 +92,6 @@ $Header: /cvsroot/pgsql/doc/src/sgml/intro.sgml,v 1.19 2002/01/07 02:29:12 peter
9592

9693
</sect1>
9794

98-
&history;
99-
&info;
100-
&notation;
101-
&problems;
102-
&y2k;
103-
104-
</preface>
105-
10695
<!-- Keep this comment at the end of the file
10796
Local variables:
10897
mode:sgml

‎doc/src/sgml/manage-ag.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.21 2002/09/25 21:16:10 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.22 2002/10/24 17:48:54 petere Exp $
33
-->
44

55
<chapter id="managing-databases">
@@ -47,7 +47,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/manage-ag.sgml,v 2.21 2002/09/25 21:16:10 p
4747
into separate databases. If the projects or users are interrelated
4848
and should be able to use each other's resources they should be put
4949
in the same databases but possibly into separate schemas. More
50-
information about managing schemas is in &cite-user;.
50+
information about managing schemas is in the &cite-user;.
5151
</para>
5252

5353
<note>

‎doc/src/sgml/notation.sgml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/notation.sgml,v 1.19 2001/11/23 22:06:20 tgl Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/notation.sgml,v 1.20 2002/10/24 17:48:54 petere Exp $
33
-->
44

55
<sect1 id="notation">
66
<title>Terminology and Notation</title>
77

8-
<para>
9-
The terms <quote>PostgreSQL</quote> and <quote>Postgres</quote> will be
10-
used interchangeably to refer to the software that accompanies this
11-
documentation.
12-
</para>
13-
148
<para>
159
An <firstterm>administrator</firstterm> is generally a person who is
1610
in charge of installing and running the server. A <firstterm>user</firstterm>

0 commit comments

Comments
 (0)