Commit Graph

62 Commits

Author SHA1 Message Date
Peter Eisentraut
3c49c6facb Convert documentation to DocBook XML
Since some preparation work had already been done, the only source
changes left were changing empty-element tags like <xref linkend="foo">
to <xref linkend="foo"/>, and changing the DOCTYPE.

The source files are still named *.sgml, but they are actually XML files
now.  Renaming could be considered later.

In the build system, the intermediate step to convert from SGML to XML
is removed.  Everything is build straight from the source files again.
The OpenSP (or the old SP) package is no longer needed.

The documentation toolchain instructions are updated and are much
simpler now.

Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
2017-11-23 09:44:28 -05:00
Peter Eisentraut
1ff01b3902 Convert SGML IDs to lower case
IDs in SGML are case insensitive, and we have accumulated a mix of upper
and lower case IDs, including different variants of the same ID.  In
XML, these will be case sensitive, so we need to fix up those
differences.  Going to all lower case seems most straightforward, and
the current build process already makes all anchors and lower case
anyway during the SGML->XML conversion, so this doesn't create any
difference in the output right now.  A future XML-only build process
would, however, maintain any mixed case ID spellings in the output, so
that is another reason to clean this up beforehand.

Author: Alexander Lakhin <exclusion@gmail.com>
2017-10-20 19:26:10 -04:00
Peter Eisentraut
c29c578908 Don't use SGML empty tags
For DocBook XML compatibility, don't use SGML empty tags (</>) anymore,
replace by the full tag name.  Add a warning option to catch future
occurrences.

Alexander Lakhin, Jürgen Purtz
2017-10-17 15:10:33 -04:00
Peter Eisentraut
47b55d4174 doc: Put callouts in SQL comments
This makes copy-and-pasting the SQL code easier.

From: Thomas Munro <thomas.munro@enterprisedb.com>
2017-03-03 15:03:03 -05:00
Bruce Momjian
94fe9c0f4e Use "backend process" rather than "backend server", where appropriate. 2011-03-12 09:38:56 -05:00
Peter Eisentraut
4fc09ad00c Add index entries for more functions
Also, move index entries into the tables, closer to the function description,
for easier editing in the future.  Resort some tables to be more alphabetical.
Remove the entries for count, max, min, and sum in the tutorial area, because
that was felt to be confusing.

Thom Brown
2010-11-24 00:00:34 +02:00
Magnus Hagander
9f2e211386 Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
Peter Eisentraut
6dcce3985b Remove unnecessary xref endterm attributes and title ids
The endterm attribute is mainly useful when the toolchain does not support
automatic link target text generation for a particular situation.  In  the
past, this was required by the man page tools for all reference page links,
but that is no longer the case, and it now actually gets in the way of
proper automatic link text generation.  The only remaining use cases are
currently xrefs to refsects.
2010-04-03 07:23:02 +00:00
Bruce Momjian
4e3a616355 Remove mention that binary distributions pre-compile the tutorial files. 2010-02-19 01:15:54 +00:00
Tom Lane
c30446b9c9 Proofreading for Bruce's recent round of documentation proofreading.
Most of those changes were good, but some not so good ...
2009-06-17 21:58:49 +00:00
Bruce Momjian
ba36c48e39 Proofreading adjustments for first two parts of documentation (Tutorial
and SQL).
2009-04-27 16:27:36 +00:00
Tom Lane
95b07bc7f5 Support window functions a la SQL:2008.
Hitoshi Harada, with some kibitzing from Heikki and Tom.
2008-12-28 18:54:01 +00:00
Bruce Momjian
09a9f10e7f Consistenly use colons before '<programlisting>' blocks, where
appropriate.
2007-02-01 00:28:19 +00:00
Bruce Momjian
a134ee3379 Update documentation on may/can/might:
Standard English uses "may", "can", and "might" in different ways:

        may - permission, "You may borrow my rake."

        can - ability, "I can lift that log."

        might - possibility, "It might rain today."

Unfortunately, in conversational English, their use is often mixed, as
in, "You may use this variable to do X", when in fact, "can" is a better
choice.  Similarly, "It may crash" is better stated, "It might crash".

Also update two error messages mentioned in the documenation to match.
2007-01-31 20:56:20 +00:00
Tom Lane
ed19393326 Some marginal editorial improvements and updates in the tutorial. 2006-10-21 23:12:57 +00:00
Bruce Momjian
32cebaecff Remove emacs info from footer of SGML files. 2006-09-16 00:30:20 +00:00
Bruce Momjian
497b5ad928 Make $PostgreSQL CVS tags consistent for SGML files. 2006-03-10 19:10:50 +00:00
Neil Conway
8c05ca7754 SGML cleanup: consistently use "endterm" in <xref>s that link to the
reference page for SQL commands, so that the link text is italicized.
2005-06-13 02:40:08 +00:00
Tom Lane
595ed2a855 Make the behavior of HAVING without GROUP BY conform to the SQL spec.
Formerly, if such a clause contained no aggregate functions we mistakenly
treated it as equivalent to WHERE.  Per spec it must cause the query to
be treated as a grouped query of a single group, the same as appearance
of aggregate functions would do.  Also, the HAVING filter must execute
after aggregate function computation even if it itself contains no
aggregate functions.
2005-03-10 23:21:26 +00:00
Bruce Momjian
1ced129aa3 More < and > cleanups converted to ampersands. 2005-01-22 22:56:36 +00:00
Tom Lane
cef2cc50b5 Some small docs improvements motivated by reading the comments for the
7.4 interactive docs.
2005-01-08 01:44:08 +00:00
Tom Lane
92c001bbaf Minor copy-editing in tutorial. 2004-12-17 04:50:32 +00:00
Neil Conway
ec7a6bd9a2 Replace "--" and "---" with "&mdash;" as appropriate, for better-looking
output.
2004-11-15 06:32:15 +00:00
Tom Lane
26b7c04b37 Avoid ambiguity, as per suggestion from Peter Stricker. 2004-08-30 21:29:12 +00:00
Tom Lane
8226f503ef Rather than referring to src/tutorial/README, put the build instructions
for the tutorial files right here.
2004-08-30 21:25:27 +00:00
Tom Lane
35a5fb6863 Move expanded discussion of inheritance's limitations out of tutorial
and into ddl.sgml.  Rewrite for more completeness and (hopefully)
clarity.
2004-08-08 21:33:11 +00:00
Bruce Momjian
2539edc53f This adds a caveat to the inheritance part of the tutorial.
David Fetter
2004-08-08 01:51:05 +00:00
PostgreSQL Daemon
969685ad44 $Header: -> $PostgreSQL Changes ... 2003-11-29 19:52:15 +00:00
Peter Eisentraut
8442a92e5a Spell checking, consistent terminology. 2003-11-01 01:56:29 +00:00
Peter Eisentraut
c326d8f4f2 Add/edit index entries. 2003-08-31 17:32:24 +00:00
Bruce Momjian
7eac8e3809 Revert ORDBMS change, per Peter. 2003-06-24 23:27:24 +00:00
Bruce Momjian
db57396c1f Alter query.sgml to mention PostgreSQL as an ORDBMS. This falls in line
with advocacy and 'portal' websites.

Link to createdb / dropdb from the tutorial page about create / dropdb.
A pair of notes were asking about more info...

Rod Taylor
2003-06-24 23:26:46 +00:00
Peter Eisentraut
5e5c5cd31a Merge documentation into one book. (Build with "make html".) Replace
vague cross-references with real links.
2003-03-25 16:15:44 +00:00
Peter Eisentraut
706a32cdf6 Big editing for consistent content and presentation. 2003-03-13 01:30:29 +00:00
Peter Eisentraut
1b342df00a Merge documentation updates from 7.3 branch. 2002-11-11 20:14:04 +00:00
Peter Eisentraut
266a280584 Add introductory sections explaining what each book is about. Remove Y2K
statement.
2002-10-24 17:48:54 +00:00
Tom Lane
c918be6a17 Update description of numeric constants to match 7.3 reality.
Miscellaneous other copy-editing.
2002-10-20 05:05:46 +00:00
Peter Eisentraut
bf43bed848 Spell-check and markup police 2002-01-20 22:19:57 +00:00
Peter Eisentraut
731204e090 Editorial review 2002-01-07 02:29:15 +00:00
Peter Eisentraut
651a639b8b proof-reading 2001-11-28 20:49:10 +00:00
Tom Lane
ec27da1ce3 Copy-editing. 2001-11-23 21:08:51 +00:00
Tom Lane
375dcf9c88 Fix a few typos, grammatical problems, etc in new tutorial material.
Overall a really nice job here, Peter ...
2001-11-19 05:37:53 +00:00
Peter Eisentraut
a715c0e4c5 Cleanup of bibliography 2001-11-08 23:34:33 +00:00
Peter Eisentraut
ffb8f73890 Bunch of copy fitting and style sheet tweakage to get decent looking print
output (from pdfjadetex).  Also updated instructions to install documentation
processing toolchain.
2001-10-09 18:46:00 +00:00
Peter Eisentraut
60ce9e9279 New blood and fresh air for tutorial 2001-09-02 23:27:50 +00:00
Peter Eisentraut
027f144e39 Terminology cleanup: class -> table, instance -> row, attribute -> column,
etc.
2001-01-13 23:58:55 +00:00
Peter Eisentraut
387d43113c Avoid using the terms 'installation', 'site', or 'instance' when referring
to the thing you get from running initdb.  That's called a database cluster
(per SQL).
2000-12-22 19:31:56 +00:00
Peter Eisentraut
1b555ce791 Replace incorrect uses of 'which' with 'that'. (so-called "wicked which") 2000-12-22 18:57:50 +00:00
Bruce Momjian
36da236eb3 In 'Joins between classes' in Section 5 of the tutorial we have, in
the first paragraph:

    As an example, say we wish to find all the records that
    are in the  temperature  range  of  other records. In
    effect, we need to compare the temp_lo and temp_hi
    attributes of each EMP instance to the temp_lo and
    temp_hi  attributes of all other EMP instances.

I believe that EMP should read WEATHER, as the example query that
follows joins WEATHER to itself.

EMP is often used in Oracle examples.

Regards,
Graham

Other RULE cleanups
2000-12-12 16:47:52 +00:00
Peter Eisentraut
72ad5fe15c Add id' attributes to all chapter' and `sect1' tags, to generate useful
names for the HTML files (e.g., not x4856.htm).
2000-09-29 20:21:34 +00:00