postgresql/doc/src/sgml
Peter Eisentraut 232f1475dc doc: Clean up some recently added PL/pgSQL documentation
- Capitalize titles consistently.
- Fix some grammar.
- Group "Obtaining Information About an Error" under "Trapping Errors",
  but make "Obtaining the Call Stack Context Information" its own
  section, since it's not about errors.
2014-07-29 23:47:16 -04:00
..
ref doc: Fix up ALTER TABLESPACE reference page 2014-07-26 23:19:02 -04:00
.gitignore
acronyms.sgml
adminpack.sgml
advanced.sgml
arch-dev.sgml
array.sgml
auth-delay.sgml doc: Fix DocBook XML validity 2014-05-06 21:28:58 -04:00
auto-explain.sgml doc: Fix DocBook XML validity 2014-05-06 21:28:58 -04:00
backup.sgml doc: Suggesting clearing pg_replslot from a hot filesystem backup. 2014-04-14 13:01:53 -04:00
bgworker.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
biblio.sgml
bki.sgml
btree-gin.sgml
btree-gist.sgml
catalogs.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
charset.sgml
chkpass.sgml
citext.sgml
client-auth.sgml Doc: improve discussion of reverse+forward host name lookup in pg_hba.conf. 2014-04-01 15:20:38 -04:00
config.sgml Fix xreflabel for hot_standby_feedback. 2014-07-19 22:20:29 -04:00
contacts.sgml
contrib-spi.sgml
contrib.sgml Introduce logical decoding. 2014-03-03 16:32:18 -05:00
cube.sgml
datatype.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
datetime.sgml
dblink.sgml doc: Improve DocBook XML validity 2014-02-23 21:31:08 -05:00
ddl.sgml Implement IMPORT FOREIGN SCHEMA. 2014-07-10 15:01:43 -04:00
dfunc.sgml Remove Alpha and Tru64 support. 2014-06-28 21:46:15 +02:00
dict-int.sgml
dict-xsyn.sgml
diskusage.sgml
dml.sgml
docguide.sgml
dummy-seclabel.sgml
earthdistance.sgml
ecpg.sgml
errcodes.sgml
event-trigger.sgml Implement IMPORT FOREIGN SCHEMA. 2014-07-10 15:01:43 -04:00
extend.sgml doc: Fix spacing in verbatim environments 2014-07-08 11:39:36 -04:00
external-projects.sgml
fdwhandler.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
features.sgml
file-fdw.sgml Provide a FORCE NULL option to COPY in CSV mode. 2014-03-04 17:31:59 -05:00
filelist.sgml Initial version of Postgres 9.4 release notes 2014-05-03 23:16:24 -04:00
fixrtf
func.sgml Rearrange documentation paragraph describing pg_relation_size(). 2014-07-23 15:20:31 -04:00
fuzzystrmatch.sgml
generate-errcodes-table.pl
geqo.sgml
gin.sgml Fix whitespace 2014-07-08 23:29:25 -04:00
gist.sgml Add an in-core GiST index opclass for inet/cidr types. 2014-04-08 15:46:43 -04:00
high-availability.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
history.sgml
hstore.sgml
indexam.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
indices.sgml Add an in-core GiST index opclass for inet/cidr types. 2014-04-08 15:46:43 -04:00
info.sgml
information_schema.sgml
install-windows.sgml
installation.sgml Remove Alpha and Tru64 support. 2014-06-28 21:46:15 +02:00
intagg.sgml
intarray.sgml
intro.sgml
isn.sgml
jadetex.cfg
json.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
keywords.sgml Update key words table for 9.4 2014-07-08 14:55:09 -04:00
legal.sgml
libpq.sgml Replace "internationalize" with "localize" where appropriate 2014-07-20 21:39:37 -04:00
lo.sgml
lobj.sgml Rename lo_create(oid, bytea) to lo_from_bytea(). 2014-06-12 15:39:09 -04:00
logicaldecoding.sgml Reword the sentence for pg_logical_slot_peek_changes function. 2014-07-29 12:07:54 +09:00
ltree.sgml
maintenance.sgml
Makefile
manage-ag.sgml docs: tablespaces cannot be accessed independently 2014-04-19 10:52:49 -04:00
mk_feature_tables.pl
monitoring.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
mvcc.sgml Split out the description of page-level lock as new subsection in document. 2014-07-04 11:24:59 +09:00
nls.sgml
notation.sgml
oid2name.sgml doc: Improve DocBook XML validity 2014-02-23 21:31:08 -05:00
pageinspect.sgml doc: Fix DocBook XML validity 2014-05-06 21:28:58 -04:00
passwordcheck.sgml
perform.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
pg_xlogdump.sgml Add -f/--follow option to pg_xlogdump. 2014-03-26 13:48:20 +02:00
pgarchivecleanup.sgml doc: Improve DocBook XML validity 2014-02-23 21:31:08 -05:00
pgbench.sgml doc: Put new options in right order on reference pages 2014-07-15 15:08:16 -04:00
pgbuffercache.sgml
pgcrypto.sgml Fix whitespace 2014-07-08 23:29:25 -04:00
pgfreespacemap.sgml doc: Fix DocBook XML validity 2014-05-06 21:28:58 -04:00
pgprewarm.sgml Fix whitespace 2014-07-08 23:29:25 -04:00
pgrowlocks.sgml docs: remove unnecessary references to old PG versions 2014-02-24 12:56:37 -05:00
pgstandby.sgml doc: Improve DocBook XML validity 2014-02-23 21:31:08 -05:00
pgstatstatements.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
pgstattuple.sgml doc: Fix DocBook XML validity 2014-05-06 21:28:58 -04:00
pgtestfsync.sgml doc: Improve DocBook XML validity 2014-02-23 21:31:08 -05:00
pgtesttiming.sgml doc: Improve DocBook XML validity 2014-02-23 21:31:08 -05:00
pgtrgm.sgml
pgupgrade.sgml Limit pg_upgrade authentication advice to always-secure techniques. 2014-07-18 16:05:17 -04:00
planstats.sgml
plhandler.sgml
plperl.sgml doc: Fix DocBook XML validity 2014-05-06 21:28:58 -04:00
plpgsql.sgml doc: Clean up some recently added PL/pgSQL documentation 2014-07-29 23:47:16 -04:00
plpython.sgml Improve support for composite types in PL/Python. 2014-07-03 16:10:50 -04:00
pltcl.sgml doc: Fix DocBook XML validity 2014-05-06 21:28:58 -04:00
postgres-fdw.sgml Implement IMPORT FOREIGN SCHEMA. 2014-07-10 15:01:43 -04:00
postgres.sgml Documentation for logical decoding. 2014-03-18 13:20:01 -04:00
problems.sgml
protocol.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
queries.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
query.sgml
rangetypes.sgml
README.links
recovery-config.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
reference.sgml Implement IMPORT FOREIGN SCHEMA. 2014-07-10 15:01:43 -04:00
regress.sgml Secure Unix-domain sockets of "make check" temporary clusters. 2014-06-14 09:41:13 -04:00
release-7.4.sgml
release-8.0.sgml
release-8.1.sgml
release-8.2.sgml
release-8.3.sgml
release-8.4.sgml Release notes for 9.3.5, 9.2.9, 9.1.14, 9.0.18, 8.4.22. 2014-07-21 14:59:17 -04:00
release-9.0.sgml Release notes for 9.3.5, 9.2.9, 9.1.14, 9.0.18, 8.4.22. 2014-07-21 14:59:17 -04:00
release-9.1.sgml Release notes for 9.3.5, 9.2.9, 9.1.14, 9.0.18, 8.4.22. 2014-07-21 14:59:17 -04:00
release-9.2.sgml Release notes for 9.3.5, 9.2.9, 9.1.14, 9.0.18, 8.4.22. 2014-07-21 14:59:17 -04:00
release-9.3.sgml Release notes for 9.3.5, 9.2.9, 9.1.14, 9.0.18, 8.4.22. 2014-07-21 14:59:17 -04:00
release-9.4.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
release-old.sgml
release.sgml Initial version of Postgres 9.4 release notes 2014-05-03 23:16:24 -04:00
rowtypes.sgml
rules.sgml Implement UPDATE tab SET (col1,col2,...) = (SELECT ...), ... 2014-06-18 13:22:34 -04:00
runtime.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
seg.sgml
sepgsql.sgml doc: Fix DocBook XML validity 2014-05-06 21:28:58 -04:00
sourcerepo.sgml
sources.sgml Show PIDs of lock holders and waiters in log_lock_waits log message. 2014-03-13 03:26:47 +09:00
spgist.sgml Add an in-core GiST index opclass for inet/cidr types. 2014-04-08 15:46:43 -04:00
spi.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
sql.sgml
sslinfo.sgml doc: Fix DocBook XML validity 2014-05-06 21:28:58 -04:00
standalone-install.sgml
start.sgml
storage.sgml Rename logical decoding's pg_llog directory to pg_logical. 2014-07-02 21:07:47 +02:00
stylesheet-common.xsl
stylesheet-fo.xsl
stylesheet-hh.xsl
stylesheet-man.xsl
stylesheet.css
stylesheet.dsl
stylesheet.xsl
syntax.sgml
tablefunc.sgml
tcn.sgml
test-decoding.sgml doc: Fix spacing in verbatim environments 2014-07-08 11:39:36 -04:00
test-parser.sgml
test-shm-mq.sgml Fix typo in test_shm_mq document. 2014-05-13 01:41:54 +09:00
textsearch.sgml doc: Fix DocBook XML validity 2014-05-06 21:28:58 -04:00
trigger.sgml Offer triggers on foreign tables. 2014-03-23 02:16:34 -04:00
tsearch2.sgml
typeconv.sgml
unaccent.sgml Allow multi-character source strings in contrib/unaccent. 2014-06-30 21:46:29 -04:00
user-manag.sgml
uuid-ossp.sgml Support BSD and e2fsprogs UUID libraries alongside OSSP UUID library. 2014-05-27 19:42:08 -04:00
vacuumlo.sgml doc: Improve DocBook XML validity 2014-02-23 21:31:08 -05:00
wal.sgml
xaggr.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
xfunc.sgml Document SQL functions' behavior of parsing the whole function at once. 2014-06-19 12:33:56 -04:00
xindex.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
xml2.sgml doc: Spell checking 2014-07-16 22:48:11 -04:00
xoper.sgml
xplang.sgml
xtypes.sgml

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

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


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

<xref>
	use to get chapter/section number from the title of the target
	link, or xreflabel if defined at the target, or refentrytitle if target
        is a refentry;  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  Specific nouns like GUC variables, SQL commands, and contrib modules
   usually have xreflabels