Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitb2e76d5

Browse files
committed
Revive Reference Manual, remove reference pages from User's Guide.
Make version.sgml the central place for updating version numbers in thedocumentation. Document titles now contain the version number of therelease they belong to.filelist.sgml is the central (and only) place to declare system entities(i.e., sgml files). No longer a need to declare them in each documentheader.There is no longer any need to maintain duplicate chapter lists inpostgres.sgml and user/admin/etc.sgml, everything is build from the samesources. Some parameter entities allow for different text to be includedwhen the integrated or a single doc set is generated, which eliminates theproblems that had caused this to fail in the past.
1 parent4cbeefb commitb2e76d5

16 files changed

+410
-930
lines changed

‎doc/src/Makefile

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Postgres documentation makefile
2-
# $Header: /cvsroot/pgsql/doc/src/Makefile,v 1.14 2000/10/08 13:24:08 petere Exp $
2+
# $Header: /cvsroot/pgsql/doc/src/Makefile,v 1.15 2000/11/24 17:44:21 petere Exp $
33

44
subdir = doc/src
55
top_builddir = ../..
6-
-include$(top_builddir)/src/Makefile.global
6+
include$(top_builddir)/src/Makefile.global
77

88
TAR= tar
99
ZIP= gzip
1010
ZIPSUFFIX= gz
1111
TAREXCLUDE= --exclude=Makefile --exclude='*.sgml' --exclude=ref
1212

13-
SRC= adminpostgresprogrammer tutorial userdeveloper
13+
SRC= admindeveloper referenceprogrammer tutorial user postgres
1414

1515
TARGETS=$(SRC:%=%.tar.$(ZIPSUFFIX))
1616

@@ -35,14 +35,9 @@ sources:
3535
sources.tar:
3636
$(TAR) -cf$@ sgml graphics
3737

38-
admin.tar:
38+
admin.tardeveloper.tarreference.taruser.tar:
3939
$(MAKE) -C sgml clean
40-
$(MAKE) -C sgml admin.html
41-
cd sgml&&$(TAR) -cf ../$@$(TAREXCLUDE)*.html*.htm
42-
43-
developer.tar:
44-
$(MAKE) -C sgml clean
45-
$(MAKE) -C sgml developer.html
40+
$(MAKE) -C sgml$(basename$@).html
4641
cd sgml&&$(TAR) -cf ../$@$(TAREXCLUDE)*.html*.htm
4742

4843
programmer.tar:
@@ -55,11 +50,6 @@ tutorial.tar:
5550
$(MAKE) -C sgml tutorial.html
5651
cd sgml&&$(TAR) -cf ../$@$(TAREXCLUDE)*.html*.htm -C ../graphics clientserver.gif
5752

58-
user.tar:
59-
$(MAKE) -C sgml clean
60-
$(MAKE) -C sgml user.html
61-
cd sgml&&$(TAR) -cf ../$@$(TAREXCLUDE)*.html*.htm
62-
6353
postgres.tar:
6454
$(MAKE) -C sgml clean
6555
$(MAKE) -C sgml postgres.html

‎doc/src/sgml/Makefile

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
#
99
#
1010
# IDENTIFICATION
11-
# $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.25 2000/11/05 21:04:06 petere Exp $
11+
# $Header: /cvsroot/pgsql/doc/src/sgml/Makefile,v 1.26 2000/11/24 17:44:21 petere Exp $
1212
#
1313
#----------------------------------------------------------------------------
1414

@@ -55,7 +55,7 @@ D2MSCRIPT= $(D2MDIR)/docbook2man-spec.pl
5555

5656
vpath%.sgml ./ref
5757

58-
ALLDOCUMENTS = adminuser programmerdeveloper tutorialpostgres
58+
ALLBOOKS = admindeveloper programmerreference tutorialuser
5959

6060
ALLSGML :=$(wildcard$(srcdir)/*.sgml$(srcdir)/ref/*.sgml)
6161

@@ -155,10 +155,18 @@ manl: $(SQLTARGETS) manpage.refs
155155
## HTML
156156
##
157157

158-
%.html:%.sgml$(ALLSGML)
158+
JADE.html =$(JADE)$(JADEFLAGS)$(SGMLINCLUDE) -d$(HDSL) -V %use-id-as-filename% -t sgml
159+
160+
postgres.html: postgres.sgml$(ALLSGML)
159161
@rm -f*.htm
160-
$(JADE)$(JADEFLAGS)$(SGMLINCLUDE) -d$(HDSL) -V %use-id-as-filename% -t sgml$<
162+
$(JADE.html)$<
161163
# Include some softlinks to the generic default file names
164+
ln -sf postgres.htm index.html
165+
ln -sf postgres.htm postgres.html
166+
167+
$(addsuffix .html,$(ALLBOOKS)):%.html:%.sgml$(ALLSGML)
168+
@rm -f*.htm
169+
$(JADE.html) book-decl.sgml$<
162170
ln -sf$*.htm index.html
163171
ln -sf$*.htm$*.html
164172

@@ -168,12 +176,12 @@ manl: $(SQLTARGETS) manpage.refs
168176
##
169177

170178
# RTF to allow minor editing for hardcopy
171-
%.rtf:%.sgml
172-
$(JADE)$(JADEFLAGS)$(SGMLINCLUDE) -d$(PDSL) -t rtf$<
179+
$(addsuffix .rtf,$(ALLBOOKS)):%.rtf:%.sgml$(ALLSGML)
180+
$(JADE)$(JADEFLAGS)$(SGMLINCLUDE) -d$(PDSL) -t rtfbook-decl.sgml$<
173181

174182
# TeX and DVI
175-
%.tex:%.sgml
176-
$(JADE)$(JADEFLAGS)$(SGMLINCLUDE) -d$(PDSL) -t tex$<
183+
$(addsuffix .tex,$(ALLBOOKS)):%.tex:%.sgml$(ALLSGML)
184+
$(JADE)$(JADEFLAGS)$(SGMLINCLUDE) -d$(PDSL) -t texbook-decl.sgml$<
177185

178186
%.dvi:%.tex
179187
jadetex$<
@@ -222,10 +230,13 @@ tempfile_HISTORY.sgml: release.sgml
222230
## Check
223231
##
224232

225-
check:$(addprefix check-,$(ALLDOCUMENTS))
233+
check:$(addprefix check-,$(ALLBOOKS)) check-postgres
226234

227235
# Quick syntax check without style processing
228-
check-%:%.sgml
236+
$(addprefix check-,$(ALLBOOKS)): check-%:%.sgml
237+
$(NSGMLS)$(SGMLINCLUDE) -s book-decl.sgml$<
238+
239+
check-postgres: postgres.sgml
229240
$(NSGMLS)$(SGMLINCLUDE) -s$<
230241

231242

‎doc/src/sgml/about.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
<para>
55
<productname>PostgreSQL</productname> is available without cost. This manual
6-
describes version7.0 of <productname>PostgreSQL</productname>.
6+
describes version&version; of <productname>PostgreSQL</productname>.
77
</para>
88

99
<para>

‎doc/src/sgml/admin.sgml

Lines changed: 20 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,22 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/Attic/admin.sgml,v 1.27 2000/09/30 16:58:20 petere Exp $
3-
4-
Postgres Administrator's Guide.
5-
Derived from postgres.sgml.
6-
- thomas 1998-10-27
2+
$Header: /cvsroot/pgsql/doc/src/sgml/Attic/admin.sgml,v 1.28 2000/11/24 17:44:21 petere Exp $
73
-->
84

9-
<!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
10-
11-
<!entity version "7.1">
12-
<!entity majorversion "7.1">
13-
14-
<!entity about SYSTEM "about.sgml">
15-
<!entity history SYSTEM "history.sgml">
16-
<!entity info SYSTEM "info.sgml">
17-
<!entity legal SYSTEM "legal.sgml">
18-
<!entity notation SYSTEM "notation.sgml">
19-
<!entity problems SYSTEM "problems.sgml">
20-
<!entity y2k SYSTEM "y2k.sgml">
21-
22-
<!entity backup SYSTEM "backup.sgml">
23-
<!entity charset SYSTEM "charset.sgml">
24-
<!entity client-auth SYSTEM "client-auth.sgml">
25-
<!entity intro-ag SYSTEM "intro-ag.sgml">
26-
<!entity installation SYSTEM "installation.sgml">
27-
<!entity installw SYSTEM "install-win32.sgml">
28-
<!entity manage-ag SYSTEM "manage-ag.sgml">
29-
<!entity recovery SYSTEM "recovery.sgml">
30-
<!entity regress SYSTEM "regress.sgml">
31-
<!entity release SYSTEM "release.sgml">
32-
<!entity runtime SYSTEM "runtime.sgml">
33-
<!entity user-manag SYSTEM "user-manag.sgml">
34-
35-
<!entity biblio SYSTEM "biblio.sgml">
36-
37-
<!-- see standalone-install.sgml about these -->
38-
<!entity % flattext-install-ignore "INCLUDE">
39-
<!entity % flattext-install-include "IGNORE">
40-
]>
41-
425
<book id="admin">
436

447
<!-- Title information -->
458

46-
<title>PostgreSQL Administrator's Guide</title>
9+
<title><![%single-book;[PostgreSQL &version;]]> Administrator's Guide</title>
4710
<bookinfo>
48-
<releaseinfo>Covering v7.0 for general release</releaseinfo>
49-
<bookbiblio>
50-
<authorgroup>
51-
<corpauthor>The PostgreSQL Development Team</corpauthor>
52-
</authorgroup>
53-
<!-- editor in authorgroup is not supported
54-
<AuthorGroup>
55-
-->
56-
<editor>
57-
<firstname>Thomas</firstname>
58-
<surname>Lockhart</surname>
59-
<affiliation>
60-
<orgname>Caltech/JPL</orgname>
61-
</affiliation>
62-
</editor>
63-
<!--
64-
</AuthorGroup>
65-
-->
66-
67-
<!--
68-
<AuthorInitials>TGL</AuthorInitials>
69-
-->
11+
<corpauthor>The PostgreSQL Global Development Group</corpauthor>
7012

71-
<date>(last updated 2000-05-01)</date>
72-
</bookbiblio>
13+
<editor>
14+
<firstname>Thomas</firstname>
15+
<surname>Lockhart</surname>
16+
<affiliation>
17+
<orgname>Caltech/JPL</orgname>
18+
</affiliation>
19+
</editor>
7320

7421
<legalnotice>
7522
<para>
@@ -80,7 +27,7 @@ Derived from postgres.sgml.
8027

8128
</bookinfo>
8229

83-
<preface id="preface">
30+
<preface id="ag-preface">
8431
<title>Summary</title>
8532

8633
<para>
@@ -95,7 +42,14 @@ Derived from postgres.sgml.
9542
</para>
9643
</preface>
9744

45+
<!--
46+
Disable these extra intro chapters since some elements (e.g. y2k
47+
statement) are included in the first intro.sgml and cause errors if
48+
included twice.
49+
-->
50+
<![%single-book;[
9851
&intro-ag;
52+
]]>
9953
&installation;
10054
&installw;
10155
&runtime;
@@ -107,16 +61,9 @@ Derived from postgres.sgml.
10761
&recovery;
10862
&regress;
10963
&release;
110-
64+
<![%single-book;[
11165
&biblio;
112-
113-
<!--
114-
Don't bother with an index until we get some index entries.
115-
- thomas 1998-10-26
116-
<index id="index">
117-
</index>
118-
-->
119-
66+
]]>
12067
</book>
12168

12269
<!-- Keep this comment at the end of the file

‎doc/src/sgml/book-decl.sgml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
2+
3+
<!entity % version SYSTEM "version.sgml">
4+
%version;
5+
<!entity % filelist SYSTEM "filelist.sgml">
6+
%filelist;
7+
8+
<!entity % set-of-books "IGNORE">
9+
<!entity % single-book "INCLUDE">
10+
11+
]>

‎doc/src/sgml/developer.sgml

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,8 @@
1-
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/Attic/developer.sgml,v 1.1 2000/10/08 13:24:09 petere Exp $ -->
1+
<!-- $Header: /cvsroot/pgsql/doc/src/sgml/Attic/developer.sgml,v 1.2 2000/11/24 17:44:21 petere Exp $ -->
22
<!-- PostgreSQL Developer's Guide -->
33

4-
<!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
5-
6-
<!entity about SYSTEM "about.sgml">
7-
<!entity history SYSTEM "history.sgml">
8-
<!entity info SYSTEM "info.sgml">
9-
<!entity legal SYSTEM "legal.sgml">
10-
<!entity notation SYSTEM "notation.sgml">
11-
<!entity problems SYSTEM "problems.sgml">
12-
<!entity y2k SYSTEM "y2k.sgml">
13-
14-
<!entity arch-dev SYSTEM "arch-dev.sgml">
15-
<!entity biblio SYSTEM "biblio.sgml">
16-
<!entity bki SYSTEM "bki.sgml">
17-
<!entity catalogs SYSTEM "catalogs.sgml">
18-
<!entity compiler SYSTEM "compiler.sgml">
19-
<!entity contacts SYSTEM "contacts.sgml">
20-
<!entity cvs SYSTEM "cvs.sgml">
21-
<!entity docguide SYSTEM "docguide.sgml">
22-
<!entity geqo SYSTEM "geqo.sgml">
23-
<!entity page SYSTEM "page.sgml">
24-
<!entity protocol SYSTEM "protocol.sgml">
25-
<!entity sources SYSTEM "sources.sgml">
26-
27-
]>
28-
294
<book id="developer">
30-
<title><productname>PostgreSQL Developer's Guide</></>
5+
<title><![%single-book;[PostgreSQL&version;]]>Developer's Guide</title>
316

327
<bookinfo>
338
<abstract>
@@ -37,7 +12,7 @@
3712
</simpara>
3813
</abstract>
3914

40-
<corpauthor>The PostgreSQL Global Development Group</>
15+
<corpauthor>The PostgreSQL Global Development Group</corpauthor>
4116
</bookinfo>
4217

4318
&sources;
@@ -53,8 +28,9 @@
5328
&compiler;
5429
&bki;
5530
&page;
31+
<![%single-book;[
5632
&biblio;
57-
33+
]]>
5834
<!-- appendices -->
5935
&cvs;
6036
&docguide;

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp