postgresql/doc/src/sgml
Alvaro Herrera fc3459d70c Uppercase <!ENTITY> and <!DOCTYPE> tags in SGML source
This improves compatibility with external toolchains, such as those used
by some documentation translation tools.

Gabriele Bartolini
2011-04-04 16:09:10 -04:00
..
ref Uppercase <!ENTITY> and <!DOCTYPE> tags in SGML source 2011-04-04 16:09:10 -04:00
.gitignore Avoid maintaining three separate copies of the error codes list. 2011-02-03 22:32:49 -05:00
Makefile Uppercase <!ENTITY> and <!DOCTYPE> tags in SGML source 2011-04-04 16:09:10 -04:00
README.links Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
acronyms.sgml Core support for "extensions", which are packages of SQL objects. 2011-02-08 16:13:22 -05:00
adminpack.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
advanced.sgml Adjust documentation wording of window function ORDER BY to not mention 2011-02-20 00:01:08 -05:00
arch-dev.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
array.sgml In docs, rename "backwards compatibility" to "backward compatibility" 2011-03-11 14:33:10 -05:00
auth-delay.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
auto-explain.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
backup.sgml Named restore points in recovery. Users can record named points, then 2011-02-08 19:39:08 +00:00
biblio.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05:00
bki.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
btree-gin.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
btree-gist.sgml Add KNNGIST support to contrib/btree_gist. 2011-03-02 14:44:33 -05:00
catalogs.sgml Document guc context values, and reference them from the config doc section. 2011-03-17 00:27:01 -04:00
charset.sgml Document collation handling in SQL and plpgsql functions. 2011-03-25 18:21:25 -04: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 Rename ident authentication over local connections to peer 2011-03-19 18:44:35 +01:00
config.sgml Reword the phrase on zero replication_timeout in the docs. 2011-03-31 10:19:29 +03:00
contacts.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
contrib-spi.sgml Fix obsolete references to old-style contrib installation methods. 2011-02-14 01:10:44 -05:00
contrib.sgml Add contrib/file_fdw foreign-data wrapper for reading files via COPY. 2011-02-20 14:06:59 -05:00
cube.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
datatype.sgml Improve documentation on the range of the numeric data type. 2011-04-03 19:56:22 -04:00
datetime.sgml Mark all GUC variables with <varname> markup, rather than <literal>. 2011-02-02 18:06:38 -05:00
dblink.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
ddl.sgml Merge two documentation permission chapters into a single chapter. 2011-02-20 22:21:34 -05:00
dfunc.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05:00
dict-int.sgml Fix obsolete references to old-style contrib installation methods. 2011-02-14 01:10:44 -05:00
dict-xsyn.sgml Fix obsolete references to old-style contrib installation methods. 2011-02-14 01:10:44 -05:00
diskusage.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
dml.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
docguide.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
dummy-seclabel.sgml Minor corrections to dummy_seclabel documentation. 2010-11-18 10:30:24 -05:00
earthdistance.sgml Fix obsolete references to old-style contrib installation methods. 2011-02-14 01:10:44 -05:00
ecpg.sgml Typo fix 2011-02-17 15:57:37 -05:00
errcodes.sgml Avoid maintaining three separate copies of the error codes list. 2011-02-03 22:32:49 -05:00
extend.sgml Add links to documentation from 9.1 release notes. 2011-03-19 23:59:33 -04:00
external-projects.sgml Small improvements to external-projects documentation. 2011-02-14 19:22:34 -05:00
fdwhandler.sgml Implement an API to let foreign-data wrappers actually be functional. 2011-02-20 00:18:14 -05:00
features.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
file-fdw.sgml Add ENCODING option to COPY TO/FROM and file_fdw. 2011-02-21 14:32:40 +09:00
filelist.sgml Uppercase <!ENTITY> and <!DOCTYPE> tags in SGML source 2011-04-04 16:09:10 -04:00
fixrtf Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
func.sgml Add links to documentation from 9.1 release notes. 2011-03-19 23:59:33 -04:00
fuzzystrmatch.sgml Fix spelling error in fuzzystrmatch docs. 2011-03-15 19:50:02 -04:00
generate-errcodes-table.pl Avoid maintaining three separate copies of the error codes list. 2011-02-03 22:32:49 -05: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 Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -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 Remove disclaimer stating that fsync=off slows down sync rep. 2011-03-26 21:19:06 -04:00
history.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
hstore.sgml Fix obsolete references to old-style contrib installation methods. 2011-02-14 01:10:44 -05:00
indexam.sgml Implement genuine serializable isolation level. 2011-02-08 00:09:08 +02:00
indices.sgml Per-column collation support 2011-02-08 23:04:18 +02:00
info.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
information_schema.sgml Add collations to information_schema.usage_privileges 2011-03-02 23:17:56 +02:00
install-windows.sgml Use correct name and URL for MinGW-w64, error noticed by Gurjeet Singh. 2011-02-10 04:47:32 -05:00
installation.sgml Add links to documentation from 9.1 release notes. 2011-03-19 23:59:33 -04: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 Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05: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 Use "backend process" rather than "backend server", where appropriate. 2011-03-12 09:38:56 -05:00
lo.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
lobj.sgml In docs, rename "backwards compatibility" to "backward compatibility" 2011-03-11 14:33:10 -05:00
ltree.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
maintenance.sgml Mark all GUC variables with <varname> markup, rather than <literal>. 2011-02-02 18:06:38 -05: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 Efficient transaction-controlled synchronous replication. 2011-03-06 22:49:16 +00:00
mvcc.sgml Typo fix in SSI docs. 2011-03-27 21:35:15 -04:00
nls.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05: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 Correct mistaken claims about EXPLAIN ANALYZE's handling of triggers. 2011-03-02 11:17:03 -05:00
pgarchivecleanup.sgml Mark all GUC variables with <varname> markup, rather than <literal>. 2011-02-02 18:06:38 -05:00
pgbench.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
pgbuffercache.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
pgcrypto.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
pgfreespacemap.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
pgrowlocks.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
pgstandby.sgml Mark all GUC variables with <varname> markup, rather than <literal>. 2011-02-02 18:06:38 -05:00
pgstatstatements.sgml Fix obsolete references to old-style contrib installation methods. 2011-02-14 01:10:44 -05:00
pgstattuple.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
pgtestfsync.sgml Clean up pg_test_fsync commit. 2011-01-21 19:27:25 -05:00
pgtrgm.sgml Support LIKE and ILIKE index searches via contrib/pg_trgm indexes. 2011-01-31 21:34:49 -05:00
pgupgrade.sgml Use '=' when documenting long options. 2011-03-10 09:10:34 -05:00
planstats.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
plhandler.sgml Update documentation to reflect that standard PLs are now extensions. 2011-03-05 01:08:38 -05:00
plperl.sgml In docs, rename "backwards compatibility" to "backward compatibility" 2011-03-11 14:33:10 -05:00
plpgsql.sgml Document collation handling in SQL and plpgsql functions. 2011-03-25 18:21:25 -04:00
plpython.sgml Cosmetic capitalization fix 2011-03-22 21:59:53 -04:00
pltcl.sgml Update documentation to reflect that standard PLs are now extensions. 2011-03-05 01:08:38 -05:00
postgres.sgml Uppercase <!ENTITY> and <!DOCTYPE> tags in SGML source 2011-04-04 16:09:10 -04:00
problems.sgml Use "backend process" rather than "backend server", where appropriate. 2011-03-12 09:38:56 -05:00
protocol.sgml Protocol documentation for Hot Standby feedback messages. 2011-03-17 15:10:55 -04:00
queries.sgml Add documentation for data-modifying statements in WITH clauses. 2011-02-28 01:17:58 -05:00
query.sgml Use "backend process" rather than "backend server", where appropriate. 2011-03-12 09:38:56 -05:00
recovery-config.sgml Add pause_at_recovery_target to recovery.conf.sample; improve docs. 2011-03-17 14:04:11 -04:00
reference.sgml DDL support for collations 2011-02-12 15:55:18 +02:00
regress.sgml Per-column collation support 2011-02-08 23:04:18 +02:00
release-7.4.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
release-8.0.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
release-8.1.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
release-8.2.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
release-8.3.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
release-8.4.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
release-9.0.sgml Clarify documentation for libpq's PQescapeBytea to mention the new hex 2011-02-13 09:29:01 -05:00
release-9.1.sgml Add 9.1 release note link for synchronous replication. 2011-03-28 14:50:08 -04:00
release-old.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
release.sgml Add SGML markup for keywords, terms, functions, commands, etc. 2011-03-19 17:21:49 -04:00
rowtypes.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
rules.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
runtime.sgml Rename ident authentication over local connections to peer 2011-03-19 18:44:35 +01:00
seg.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
sepgsql.sgml Escape greater than and less than characters in docs. 2011-04-02 17:08:06 +03:00
sourcerepo.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
sources.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
spi.sgml Implement genuine serializable isolation level. 2011-02-08 00:09:08 +02: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 Uppercase <!ENTITY> and <!DOCTYPE> tags in SGML source 2011-04-04 16:09:10 -04:00
start.sgml Remove mention of using "man" from the tutorial. 2011-04-03 19:49:05 -04:00
storage.sgml Fix copy-pasto in description of pg_serial, and silence compiler warning 2011-02-08 09:05:13 +02: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 Add links to documentation from 9.1 release notes. 2011-03-19 23:59:33 -04:00
tablefunc.sgml Fix obsolete references to old-style contrib installation methods. 2011-02-14 01:10:44 -05:00
test-parser.sgml Fix obsolete references to old-style contrib installation methods. 2011-02-14 01:10:44 -05: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 Fix obsolete references to old-style contrib installation methods. 2011-02-14 01:10:44 -05:00
typeconv.sgml Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
unaccent.sgml Fix obsolete references to old-style contrib installation methods. 2011-02-14 01:10:44 -05:00
user-manag.sgml In docs, rename "backwards compatibility" to "backward compatibility" 2011-03-11 14:33:10 -05: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 documentation on FreeBSD write cache control. 2011-03-11 11:36:42 -05:00
xaggr.sgml Improve user-defined-aggregates documentation. 2011-03-23 16:56:55 -04:00
xfunc.sgml Document collation handling in SQL and plpgsql functions. 2011-03-25 18:21:25 -04:00
xindex.sgml Add external documentation for KNNGIST. 2010-12-03 23:49:06 -05:00
xml2.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
xoper.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05:00
xplang.sgml Update documentation to reflect that standard PLs are now extensions. 2011-03-05 01:08:38 -05:00
xtypes.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05: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'