Skip to content

Commit 6de93c0

Browse files
peterepetere
committed
Update preface.
Use question marks rather than brackets to delimit optional elements in Tcl synopses. Fix stylesheet misfeature leading to excessively long cross-reference text when linking to a different "part". Remove <body> attributes -- CSS stylesheets should handle that. Improve bibliography formatting. Add fast-forward links for more convenient navigation.
1 parent e54965c commit 6de93c0

File tree

8 files changed

+366
-489
lines changed

8 files changed

+366
-489
lines changed

‎doc/src/sgml/history.sgml

Lines changed: 125 additions & 181 deletions
Large diffs are not rendered by default.

‎doc/src/sgml/info.sgml

Lines changed: 17 additions & 124 deletions
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,21 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.18 2003/01/19 00:13:28 momjian Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.19 2003/09/08 23:02:28 petere Exp $
33
-->
44

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

88
<para>
9-
The <productname>PostgreSQL</> documentation is organized into
10-
several books:
9+
Besides the documentation, that is, this book, there are other
10+
resources about <productname>PostgreSQL</productname>:
1111

1212
<variablelist>
13-
<varlistentry>
14-
<term>&cite-tutorial;</term>
15-
<listitem>
16-
<para>
17-
An informal introduction for new users.
18-
</para>
19-
</listitem>
20-
</varlistentry>
21-
22-
<varlistentry>
23-
<term>&cite-user;</term>
24-
<listitem>
25-
<para>
26-
Documents the <acronym>SQL</acronym> query language environment,
27-
including data types and functions, as well as user-level
28-
performance tuning. Every <productname>PostgreSQL</> user
29-
should read this.
30-
</para>
31-
</listitem>
32-
</varlistentry>
33-
34-
<varlistentry>
35-
<term>&cite-admin;</term>
36-
<listitem>
37-
<para>
38-
Installation and server management information. Everyone who
39-
runs a <productname>PostgreSQL</> server, either for personal
40-
use or for other users, needs to read this.
41-
</para>
42-
</listitem>
43-
</varlistentry>
44-
45-
<varlistentry>
46-
<term>&cite-programmer;</term>
47-
<listitem>
48-
<para>
49-
Advanced information for application programmers. Topics include
50-
type and function extensibility, library interfaces, and
51-
application design issues.
52-
</para>
53-
</listitem>
54-
</varlistentry>
55-
56-
<varlistentry>
57-
<term>&cite-reference;</term>
58-
<listitem>
59-
<para>
60-
Reference pages for <acronym>SQL</acronym> command syntax, and
61-
client and server programs. This book is auxiliary to the
62-
User's, Administrator's, and Programmer's Guides.
63-
</para>
64-
</listitem>
65-
</varlistentry>
66-
67-
<varlistentry>
68-
<term>&cite-developer;</term>
69-
<listitem>
70-
<para>
71-
Information for <productname>PostgreSQL</productname>
72-
developers. This is intended for those who are contributing to
73-
the <productname>PostgreSQL</productname> project; application
74-
development information appears in the &cite-programmer;.
75-
</para>
76-
</listitem>
77-
</varlistentry>
78-
</variablelist>
79-
</para>
80-
81-
<para>
82-
In addition to this manual set, there are other resources to help you with
83-
<productname>PostgreSQL</productname> installation and use:
84-
85-
<variablelist>
86-
<varlistentry>
87-
<term>man pages</term>
88-
<listitem>
89-
<para>
90-
The &cite-reference;'s pages in the traditional Unix man
91-
format. There is no difference in content.
92-
</para>
93-
</listitem>
94-
</varlistentry>
95-
9613
<varlistentry>
9714
<term>FAQs</term>
9815
<listitem>
9916
<para>
100-
Frequently Asked Questions (FAQ) lists document both general issues
101-
and some platform-specific issues.
17+
The FAQ list <indexterm><primary>FAQ-Liste</></> contains
18+
continuously updated answers to frequently asked questions.
10219
</para>
10320
</listitem>
10421
</varlistentry>
@@ -107,7 +24,8 @@ $Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.18 2003/01/19 00:13:28 momjia
10724
<term>READMEs</term>
10825
<listitem>
10926
<para>
110-
README files are available for some contributed packages.
27+
<filename>README</filename> files are available for some
28+
contributed packages.
11129
</para>
11230
</listitem>
11331
</varlistentry>
@@ -118,8 +36,8 @@ $Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.18 2003/01/19 00:13:28 momjia
11836
<para>
11937
The <ulink
12038
url="http://www.postgresql.org"><productname>PostgreSQL</productname>
121-
web site</ulink> carries details on the latest release, upcoming
122-
features, and other information to make your work or play with
39+
web site</ulink> carries details on the latest release and other
40+
information to make your work or play with
12341
<productname>PostgreSQL</productname> more productive.
12442
</para>
12543
</listitem>
@@ -131,10 +49,8 @@ $Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.18 2003/01/19 00:13:28 momjia
13149
<para>
13250
The mailing lists are a good place to have your questions
13351
answered, to share experiences with other users, and to contact
134-
the developers. Consult the <ulink
135-
url="http://www.postgresql.org/users-lounge/">User's
136-
Lounge</ulink> section of the <productname>PostgreSQL</>
137-
web site for details.
52+
the developers. Consult the <productname>PostgreSQL</> web site
53+
for details.
13854
</para>
13955
</listitem>
14056
</varlistentry>
@@ -143,41 +59,18 @@ $Header: /cvsroot/pgsql/doc/src/sgml/info.sgml,v 1.18 2003/01/19 00:13:28 momjia
14359
<term>Yourself!</term>
14460
<listitem>
14561
<para>
146-
<productname>PostgreSQL</productname> is an open-source effort.
62+
<productname>PostgreSQL</productname> is an open-source project.
14763
As such, it depends on the user community for ongoing support.
14864
As you begin to use <productname>PostgreSQL</productname>, you
14965
will rely on others for help, either through the documentation
15066
or through the mailing lists. Consider contributing your
151-
knowledge back. If you learn something which is not in the
152-
documentation, write it up and contribute it. If you add
153-
features to the code, contribute them.
154-
</para>
155-
156-
<para>
157-
Even those without a lot of experience can provide corrections
158-
and minor changes in the documentation, and that is a good way
159-
to start. The <email>pgsql-docs@postgresql.org</email> mailing
160-
list is the place to get going.
67+
knowledge back. Read the mailing lists and answer questions. If
68+
you learn something which is not in the documentation, write it
69+
up and contribute it. If you add features to the code,
70+
contribute them.
16171
</para>
16272
</listitem>
16373
</varlistentry>
16474
</variablelist>
16575
</para>
16676
</sect1>
167-
168-
<!-- Keep this comment at the end of the file
169-
Local variables:
170-
mode:sgml
171-
sgml-omittag:nil
172-
sgml-shorttag:t
173-
sgml-minimize-attributes:nil
174-
sgml-always-quote-attributes:t
175-
sgml-indent-step:1
176-
sgml-indent-data:t
177-
sgml-parent-document:nil
178-
sgml-default-dtd-file:"./reference.ced"
179-
sgml-exposed-tags:nil
180-
sgml-local-catalogs:("/usr/lib/sgml/catalog")
181-
sgml-local-ecat-files:nil
182-
End:
183-
-->

0 commit comments

Comments
 (0)