postgresql/doc/src/sgml
Tom Lane b2826ad52d Copy-edit a paragraph in the contrib/seg documentation.
Although this improves the style, an ulterior motive is to keep the two
table links from breaking across lines in PDF output, per complaint from
Josh Kupershmidt.
2011-01-28 14:34:42 -05:00
..
ref Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
.gitignore Add assorted other documentation build targets to documentation gitignore. 2010-09-22 18:08:45 -04:00
Makefile Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
README.links Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
acronyms.sgml Document that WITH queries are also called Common Table Expressions. 2011-01-19 21:19:53 -05:00
adminpack.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
advanced.sgml Emphasize where OVER needs to be when using a window function. 2011-01-21 12:59:15 -05:00
arch-dev.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
array.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
auth-delay.sgml New contrib module, auth_delay. 2010-11-27 07:22:25 -05:00
auto-explain.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
backup.sgml Add pg_basebackup tool for streaming base backups 2011-01-23 12:21:23 +01:00
biblio.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
bki.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
btree-gin.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
btree-gist.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
catalogs.sgml Rephrase pg_conversion description to avoid splitting link across page. 2011-01-27 18:42:12 -05:00
charset.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
chkpass.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
citext.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
client-auth.sgml Support suffix matching of host names in pg_hba.conf 2010-10-24 15:54:00 +03:00
config.sgml Add pg_basebackup tool for streaming base backups 2011-01-23 12:21:23 +01:00
contacts.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
contrib-spi.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
contrib.sgml sepgsql, an SE-Linux integration for PostgreSQL 2011-01-23 20:48:27 -05:00
cube.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
datatype.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
datetime.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
dblink.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
ddl.sgml Make title capitalization consistent with surroundings 2010-10-13 20:05:16 +03:00
dfunc.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
dict-int.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
dict-xsyn.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
diskusage.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
dml.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
docguide.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
dummy-seclabel.sgml Minor corrections to dummy_seclabel documentation. 2010-11-18 10:30:24 -05:00
earthdistance.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
ecpg.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
errcodes.sgml Corrections to patch adding SQL/MED error codes. 2010-12-26 21:35:25 -05:00
extend.sgml Correct spelling: longjump() -> longjmp(). 2010-12-24 22:22:44 -05:00
external-projects.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
features.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
filelist.sgml sepgsql, an SE-Linux integration for PostgreSQL 2011-01-23 20:48:27 -05:00
fixrtf Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
func.sgml Improve markup of unnest example 2011-01-07 00:12:20 +02:00
fuzzystrmatch.sgml Add levenshtein_less_equal, optimized version for small distances. 2010-10-19 09:51:06 -04:00
generate_history.pl Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
geqo.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
gin.sgml Fix GIN to support null keys, empty and null items, and full index scans. 2011-01-07 19:16:24 -05:00
gist.sgml Rewrite the GiST insertion logic so that we don't need the post-recovery 2010-12-23 16:21:47 +02:00
high-availability.sgml Restructure streaming docs so streaming seems more integrated in the 2011-01-26 19:54:41 -05:00
history.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
hstore.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
indexam.sgml Remove pg_am.amindexnulls. 2011-01-08 16:08:05 -05:00
indices.sgml Add external documentation for KNNGIST. 2010-12-03 23:49:06 -05:00
info.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
information_schema.sgml Implement remaining fields of information_schema.sequences view 2011-01-02 15:15:21 +02:00
install-windows.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
installation.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
intagg.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
intarray.sgml Fix assorted corner-case bugs in contrib/intarray. 2011-01-09 00:39:21 -05:00
intro.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
isn.sgml Add some caveats to the contrib/isn docs. 2010-10-19 22:48:19 -04:00
jadetex.cfg Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
keywords.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
legal.sgml Stamp copyrights for year 2011. 2011-01-01 13:18:15 -05:00
libpq.sgml In the docs, better distinguish server from client SSL settings in the documentation. 2011-01-17 21:30:28 -05:00
lo.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
lobj.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
ltree.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
maintenance.sgml Fix a missed explanation of auto-analyze threshold, per Joe Miller. 2010-09-21 16:40:41 -04:00
manage-ag.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
mk_feature_tables.pl Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
monitoring.sgml Only show pg_stat_replication details to superusers 2011-01-23 17:28:19 +01:00
mvcc.sgml Remove old claim that ExclusiveLock is sometimes taken on system catalogs. 2011-01-25 18:39:01 -05:00
nls.sgml Fix remaining stray references to CVS. 2010-09-22 19:51:39 -04:00
notation.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
oid2name.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
pageinspect.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
passwordcheck.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
perform.sgml Improve grammar and spelling in durability discussion. 2011-01-27 12:48:57 -05:00
pgarchivecleanup.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
pgbench.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
pgbuffercache.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
pgcrypto.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
pgfreespacemap.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
pgrowlocks.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
pgstandby.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
pgstatstatements.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
pgstattuple.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
pgtestfsync.sgml Clean up pg_test_fsync commit. 2011-01-21 19:27:25 -05:00
pgtrgm.sgml Add KNNGIST support to contrib/pg_trgm. 2010-12-04 00:16:21 -05:00
pgupgrade.sgml Use "upgrade" in preference over "migrate" in pg_upgrade messages and 2010-12-15 07:11:31 -05:00
planstats.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
plhandler.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
plperl.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
plpgsql.sgml Add new SQL function, format(text). 2010-11-20 22:33:27 -05:00
plpython.sgml plpython has plpy.Error instead of plpy.ERROR 2010-11-09 11:02:17 -03:00
pltcl.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
postgres.sgml Remove anonymous cvs instructions, and replace them with instructions 2010-09-22 20:10:28 +02:00
problems.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
protocol.sgml Add pg_basebackup tool for streaming base backups 2011-01-23 12:21:23 +01:00
queries.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
query.sgml Add index entries for more functions 2010-11-24 00:00:34 +02:00
recovery-config.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
reference.sgml Add pg_basebackup tool for streaming base backups 2011-01-23 12:21:23 +01:00
regress.sgml Don't run regression tests in SQL_ASCII encoding by default 2011-01-13 09:16:55 +02:00
release-7.4.sgml Use a separate interpreter for each calling SQL userid in plperl and pltcl. 2010-09-30 17:18:51 -04:00
release-8.0.sgml Use a separate interpreter for each calling SQL userid in plperl and pltcl. 2010-09-30 17:18:51 -04:00
release-8.1.sgml Update release notes for releases 9.0.2, 8.4.6, 8.3.13, 8.2.19, and 8.1.23. 2010-12-13 20:22:52 -05:00
release-8.2.sgml Update release notes. 2011-01-27 17:47:10 -05:00
release-8.3.sgml Update release notes. 2011-01-27 17:47:10 -05:00
release-8.4.sgml Update release notes. 2011-01-27 17:47:10 -05:00
release-9.0.sgml Update release notes. 2011-01-27 17:47:10 -05:00
release-9.1.sgml No release notes update, just advance the date 2010-12-28 21:19:17 +02:00
release-old.sgml Fix inconsistent capitalization of "PL/pgSQL". 2010-09-22 21:57:37 -04:00
release.sgml Remove anonymous cvs instructions, and replace them with instructions 2010-09-22 20:10:28 +02:00
rowtypes.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
rules.sgml Support triggers on views. 2010-10-10 13:45:07 -04:00
runtime.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
seg.sgml Copy-edit a paragraph in the contrib/seg documentation. 2011-01-28 14:34:42 -05:00
sepgsql.sgml More documentation cleanup for sepgsql. 2011-01-24 08:42:44 -05:00
sourcerepo.sgml Do some copy-editing on the Git usage docs. 2010-09-22 20:22:26 -04:00
sources.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
spi.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
sql.sgml Be consistent about writing "[, ...]" instead "[,...]" in the docs. 2010-11-29 11:53:27 +02:00
sslinfo.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
standalone-install.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
start.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
storage.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
stylesheet-common.xsl Reorganize XSLT stylesheet support. Put common things into a separate 2006-12-10 16:01:06 +00:00
stylesheet-fo.xsl Reorganize XSLT stylesheet support. Put common things into a separate 2006-12-10 16:01:06 +00:00
stylesheet-hh.xsl Reorganize XSLT stylesheet support. Put common things into a separate 2006-12-10 16:01:06 +00:00
stylesheet-man.xsl Extensive ECPG documentation improvements 2010-10-10 13:46:02 +03:00
stylesheet.css Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
stylesheet.dsl Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
stylesheet.xsl Ship documentation without intermediate tarballs 2009-08-09 22:47:59 +00:00
syntax.sgml Prevent invoking I/O conversion casts via functional/attribute notation. 2010-11-07 13:03:19 -05:00
tablefunc.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
test-parser.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
textsearch.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
trigger.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
tsearch2.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
typeconv.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
unaccent.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
user-manag.sgml Give superusers REPLIACTION permission by default 2011-01-05 14:24:17 +01:00
uuid-ossp.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
vacuumlo.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
wal.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
xaggr.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
xfunc.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
xindex.sgml Add external documentation for KNNGIST. 2010-12-03 23:49:06 -05:00
xml2.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
xoper.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
xplang.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
xtypes.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00

README.links

<!-- doc/src/sgml/README.links -->

Linking within SGML documents can be confusing, so here is a summary:


Intra-document Linking
----------------------

<xref>
	use to get link text from the title of the target link; has no
	close tag
	http://www.oasis-open.org/docbook/documentation/reference/html/xref.html

<link>
	use to supply text for the link, requires </link>
	http://www.oasis-open.org/docbook/documentation/reference/html/link.html

linkend=
	controls the target of the link/xref, required

endterm=
	for <xref>, allows the text of the link/xref to be taken from a
	different link target title


External Linking
----------------

<ulink>
	like <link>, but uses a URL (not a document target);  requires
	</ulink>; if no text is specified, the URL appears as the link text
	http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html

url=
	used by <ulink> to specify the URL, required


Guidelines
----------

o  If you want to supply text, use <link>, else <xref>
o  Do not use text with <ulink> so the URL appears in printed output
o  You can supply text at the target location with 'xreflabel'