postgresql/doc/src/sgml
Bruce Momjian 03c25dd900 Mark all GUC variables with <varname> markup, rather than <literal>. 2011-02-02 18:06:38 -05:00
..
ref Mark all GUC variables with <varname> markup, rather than <literal>. 2011-02-02 18:06:38 -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 Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05: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 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 Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05: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 Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
catalogs.sgml Improve docs for pg_authid encryption description with better markup and 2011-01-31 22:53:58 -05:00
charset.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05: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 Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05:00
config.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05:00
contacts.sgml Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
contrib-spi.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
contrib.sgml sepgsql, an SE-Linux integration for PostgreSQL 2011-01-23 20:48:27 -05:00
cube.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
datatype.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05: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 Make title capitalization consistent with surroundings 2010-10-13 20:05:16 +03:00
dfunc.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05: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 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 Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05:00
ecpg.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05:00
errcodes.sgml Re-classify ERRCODE_DATABASE_DROPPED to 57P04 2011-02-01 08:44:01 +00:00
extend.sgml Correct spelling: longjump() -> longjmp(). 2010-12-24 22:22:44 -05:00
external-projects.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05: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 Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05: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 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 Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -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 Update docs on building for Windows to accomodate current reality. 2011-01-31 13:40:45 -05:00
installation.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -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 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 Mark all GUC variables with <varname> markup, rather than <literal>. 2011-02-02 18:06:38 -05:00
lo.sgml Update contrib documention mentions to point to actual documentation 2011-01-26 09:22:21 -05:00
lobj.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -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 Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
mvcc.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05: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 Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -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 Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -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 Clarify pg_upgrade install instructions, per suggestion from Robert Haas. 2011-02-01 13:57:43 -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 Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
plpgsql.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05:00
plpython.sgml Wrap PL/Python SPI calls into subtransactions 2011-02-02 22:06:10 +02:00
pltcl.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
postgres.sgml Remove anonymous cvs instructions, and replace them with instructions 2010-09-22 20:10:28 +02:00
problems.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
protocol.sgml Mark all GUC variables with <varname> markup, rather than <literal>. 2011-02-02 18:06:38 -05:00
queries.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
query.sgml Add index entries for more functions 2010-11-24 00:00:34 +02:00
recovery-config.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
reference.sgml Add pg_basebackup tool for streaming base backups 2011-01-23 12:21:23 +01:00
regress.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05: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 Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
release-9.1.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05:00
release-old.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05: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 Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
runtime.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05:00
seg.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05:00
sepgsql.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05: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 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 Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05:00
tablefunc.sgml Properly capitalize documentation headings; some only had initial-word 2011-01-29 13:01:48 -05: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 Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05:00
xfunc.sgml Properly capitalize hyphenated words in documentation titles. 2011-02-01 17:00:26 -05: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 Remove cvs keywords from all files. 2010-09-20 22:08:53 +02: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'