From e567c9ff3409203a3ab50a2ff87cdab73bef6313 Mon Sep 17 00:00:00 2001 From: Bruce Momjian Date: Sat, 7 May 2011 22:29:20 -0400 Subject: [PATCH] Add xreflabels to /contrib manuals so links appear correct. Also update README.links to explain xref properly. --- doc/src/sgml/README.links | 10 ++++++---- doc/src/sgml/adminpack.sgml | 2 +- doc/src/sgml/auth-delay.sgml | 2 +- doc/src/sgml/auto-explain.sgml | 2 +- doc/src/sgml/btree-gin.sgml | 2 +- doc/src/sgml/btree-gist.sgml | 2 +- doc/src/sgml/chkpass.sgml | 2 +- doc/src/sgml/citext.sgml | 2 +- doc/src/sgml/contrib-spi.sgml | 2 +- doc/src/sgml/cube.sgml | 2 +- doc/src/sgml/dblink.sgml | 2 +- doc/src/sgml/dict-int.sgml | 2 +- doc/src/sgml/dict-xsyn.sgml | 2 +- doc/src/sgml/dummy-seclabel.sgml | 2 +- doc/src/sgml/earthdistance.sgml | 2 +- doc/src/sgml/file-fdw.sgml | 2 +- doc/src/sgml/fuzzystrmatch.sgml | 2 +- doc/src/sgml/hstore.sgml | 2 +- doc/src/sgml/intagg.sgml | 2 +- doc/src/sgml/intarray.sgml | 2 +- doc/src/sgml/isn.sgml | 2 +- doc/src/sgml/lo.sgml | 2 +- doc/src/sgml/ltree.sgml | 2 +- doc/src/sgml/oid2name.sgml | 2 +- doc/src/sgml/pageinspect.sgml | 2 +- doc/src/sgml/passwordcheck.sgml | 2 +- doc/src/sgml/pgarchivecleanup.sgml | 2 +- doc/src/sgml/pgbench.sgml | 2 +- doc/src/sgml/pgbuffercache.sgml | 2 +- doc/src/sgml/pgcrypto.sgml | 2 +- doc/src/sgml/pgfreespacemap.sgml | 2 +- doc/src/sgml/pgrowlocks.sgml | 2 +- doc/src/sgml/pgstandby.sgml | 2 +- doc/src/sgml/pgstatstatements.sgml | 2 +- doc/src/sgml/pgstattuple.sgml | 2 +- doc/src/sgml/pgtestfsync.sgml | 2 +- doc/src/sgml/pgtrgm.sgml | 2 +- doc/src/sgml/pgupgrade.sgml | 2 +- doc/src/sgml/seg.sgml | 2 +- doc/src/sgml/sepgsql.sgml | 2 +- doc/src/sgml/sslinfo.sgml | 2 +- doc/src/sgml/tablefunc.sgml | 2 +- doc/src/sgml/test-parser.sgml | 2 +- doc/src/sgml/tsearch2.sgml | 2 +- doc/src/sgml/unaccent.sgml | 2 +- doc/src/sgml/uuid-ossp.sgml | 2 +- doc/src/sgml/vacuumlo.sgml | 2 +- doc/src/sgml/xml2.sgml | 2 +- 48 files changed, 53 insertions(+), 51 deletions(-) diff --git a/doc/src/sgml/README.links b/doc/src/sgml/README.links index 8608859eac6..2668b00d7f5 100644 --- a/doc/src/sgml/README.links +++ b/doc/src/sgml/README.links @@ -7,8 +7,8 @@ Intra-document Linking ---------------------- - use to get link text from the title of the target link; has no - close tag + use to get chapter/section # from the title of the target + link, or xreflabel if defined at the target; has no close tag http://www.oasis-open.org/docbook/documentation/reference/html/xref.html @@ -28,7 +28,8 @@ External Linking like , but uses a URL (not a document target); requires - ; if no text is specified, the URL appears as the link text + ; if no text is specified, the URL appears as the link + text http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html url= @@ -40,4 +41,5 @@ Guidelines o If you want to supply text, use , else o Do not use text with so the URL appears in printed output -o You can supply text at the target location with 'xreflabel' +o Specific nouns like GUC variables, SQL commands, and contrib modules + usually have xreflabels diff --git a/doc/src/sgml/adminpack.sgml b/doc/src/sgml/adminpack.sgml index 27d00343297..9b72f34eadc 100644 --- a/doc/src/sgml/adminpack.sgml +++ b/doc/src/sgml/adminpack.sgml @@ -1,6 +1,6 @@ - + adminpack diff --git a/doc/src/sgml/auth-delay.sgml b/doc/src/sgml/auth-delay.sgml index 9f1f3f645af..b91a7ecda7a 100644 --- a/doc/src/sgml/auth-delay.sgml +++ b/doc/src/sgml/auth-delay.sgml @@ -1,6 +1,6 @@ - + auth_delay diff --git a/doc/src/sgml/auto-explain.sgml b/doc/src/sgml/auto-explain.sgml index 405e3f72b43..b16f9064ffc 100644 --- a/doc/src/sgml/auto-explain.sgml +++ b/doc/src/sgml/auto-explain.sgml @@ -1,6 +1,6 @@ - + auto_explain diff --git a/doc/src/sgml/btree-gin.sgml b/doc/src/sgml/btree-gin.sgml index 632bd1e53af..42b9e97b72a 100644 --- a/doc/src/sgml/btree-gin.sgml +++ b/doc/src/sgml/btree-gin.sgml @@ -1,6 +1,6 @@ - + btree_gin diff --git a/doc/src/sgml/btree-gist.sgml b/doc/src/sgml/btree-gist.sgml index af3f707bb9c..e52971f3d9e 100644 --- a/doc/src/sgml/btree-gist.sgml +++ b/doc/src/sgml/btree-gist.sgml @@ -1,6 +1,6 @@ - + btree_gist diff --git a/doc/src/sgml/chkpass.sgml b/doc/src/sgml/chkpass.sgml index b9b3c08c25b..9f682d89816 100644 --- a/doc/src/sgml/chkpass.sgml +++ b/doc/src/sgml/chkpass.sgml @@ -1,6 +1,6 @@ - + chkpass diff --git a/doc/src/sgml/citext.sgml b/doc/src/sgml/citext.sgml index 68a2aa4cd3f..8cbde88a3e7 100644 --- a/doc/src/sgml/citext.sgml +++ b/doc/src/sgml/citext.sgml @@ -1,6 +1,6 @@ - + citext diff --git a/doc/src/sgml/contrib-spi.sgml b/doc/src/sgml/contrib-spi.sgml index 55e5ce26492..3287c18d27d 100644 --- a/doc/src/sgml/contrib-spi.sgml +++ b/doc/src/sgml/contrib-spi.sgml @@ -1,6 +1,6 @@ - + spi diff --git a/doc/src/sgml/cube.sgml b/doc/src/sgml/cube.sgml index 0fcbf21be61..e2da68556d5 100644 --- a/doc/src/sgml/cube.sgml +++ b/doc/src/sgml/cube.sgml @@ -1,6 +1,6 @@ - + cube diff --git a/doc/src/sgml/dblink.sgml b/doc/src/sgml/dblink.sgml index 295544e54e1..22551402e3d 100644 --- a/doc/src/sgml/dblink.sgml +++ b/doc/src/sgml/dblink.sgml @@ -1,6 +1,6 @@ - + dblink diff --git a/doc/src/sgml/dict-int.sgml b/doc/src/sgml/dict-int.sgml index 17f98c05fa7..d49f3e2a3a3 100644 --- a/doc/src/sgml/dict-int.sgml +++ b/doc/src/sgml/dict-int.sgml @@ -1,6 +1,6 @@ - + dict_int diff --git a/doc/src/sgml/dict-xsyn.sgml b/doc/src/sgml/dict-xsyn.sgml index 23c5d983c1f..42362ffbc8d 100644 --- a/doc/src/sgml/dict-xsyn.sgml +++ b/doc/src/sgml/dict-xsyn.sgml @@ -1,6 +1,6 @@ - + dict_xsyn diff --git a/doc/src/sgml/dummy-seclabel.sgml b/doc/src/sgml/dummy-seclabel.sgml index 30d58198fb9..28d19d2409e 100644 --- a/doc/src/sgml/dummy-seclabel.sgml +++ b/doc/src/sgml/dummy-seclabel.sgml @@ -1,6 +1,6 @@ - + dummy_seclabel diff --git a/doc/src/sgml/earthdistance.sgml b/doc/src/sgml/earthdistance.sgml index 48d9e6b3573..f9002b235b8 100644 --- a/doc/src/sgml/earthdistance.sgml +++ b/doc/src/sgml/earthdistance.sgml @@ -1,6 +1,6 @@ - + earthdistance diff --git a/doc/src/sgml/file-fdw.sgml b/doc/src/sgml/file-fdw.sgml index 003c415b43a..e6ccdada2c1 100644 --- a/doc/src/sgml/file-fdw.sgml +++ b/doc/src/sgml/file-fdw.sgml @@ -1,6 +1,6 @@ - + file_fdw diff --git a/doc/src/sgml/fuzzystrmatch.sgml b/doc/src/sgml/fuzzystrmatch.sgml index cec33631933..5078bf82da9 100644 --- a/doc/src/sgml/fuzzystrmatch.sgml +++ b/doc/src/sgml/fuzzystrmatch.sgml @@ -1,6 +1,6 @@ - + fuzzystrmatch diff --git a/doc/src/sgml/hstore.sgml b/doc/src/sgml/hstore.sgml index acd931a9909..aa212952657 100644 --- a/doc/src/sgml/hstore.sgml +++ b/doc/src/sgml/hstore.sgml @@ -1,6 +1,6 @@ - + hstore diff --git a/doc/src/sgml/intagg.sgml b/doc/src/sgml/intagg.sgml index 43e36fb3483..ea5acbe91fb 100644 --- a/doc/src/sgml/intagg.sgml +++ b/doc/src/sgml/intagg.sgml @@ -1,6 +1,6 @@ - + intagg diff --git a/doc/src/sgml/intarray.sgml b/doc/src/sgml/intarray.sgml index 5ad738d9186..2bbd98ae37b 100644 --- a/doc/src/sgml/intarray.sgml +++ b/doc/src/sgml/intarray.sgml @@ -1,6 +1,6 @@ - + intarray diff --git a/doc/src/sgml/isn.sgml b/doc/src/sgml/isn.sgml index 38c98641b2e..79ca3acd1b3 100644 --- a/doc/src/sgml/isn.sgml +++ b/doc/src/sgml/isn.sgml @@ -1,6 +1,6 @@ - + isn diff --git a/doc/src/sgml/lo.sgml b/doc/src/sgml/lo.sgml index 33124f99202..3d56ba3f70a 100644 --- a/doc/src/sgml/lo.sgml +++ b/doc/src/sgml/lo.sgml @@ -1,6 +1,6 @@ - + lo diff --git a/doc/src/sgml/ltree.sgml b/doc/src/sgml/ltree.sgml index d00c91e9857..0a91cd79d1a 100644 --- a/doc/src/sgml/ltree.sgml +++ b/doc/src/sgml/ltree.sgml @@ -1,6 +1,6 @@ - + ltree diff --git a/doc/src/sgml/oid2name.sgml b/doc/src/sgml/oid2name.sgml index 36fcfd5cdad..3e4fe24a49f 100644 --- a/doc/src/sgml/oid2name.sgml +++ b/doc/src/sgml/oid2name.sgml @@ -1,6 +1,6 @@ - + oid2name diff --git a/doc/src/sgml/pageinspect.sgml b/doc/src/sgml/pageinspect.sgml index a5fbadb7310..acbb05bc9c5 100644 --- a/doc/src/sgml/pageinspect.sgml +++ b/doc/src/sgml/pageinspect.sgml @@ -1,6 +1,6 @@ - + pageinspect diff --git a/doc/src/sgml/passwordcheck.sgml b/doc/src/sgml/passwordcheck.sgml index 11107fb6ddd..0050e658247 100644 --- a/doc/src/sgml/passwordcheck.sgml +++ b/doc/src/sgml/passwordcheck.sgml @@ -1,6 +1,6 @@ - + passwordcheck diff --git a/doc/src/sgml/pgarchivecleanup.sgml b/doc/src/sgml/pgarchivecleanup.sgml index 725f3ed07c5..ddffa321f63 100644 --- a/doc/src/sgml/pgarchivecleanup.sgml +++ b/doc/src/sgml/pgarchivecleanup.sgml @@ -1,6 +1,6 @@ - + pg_archivecleanup diff --git a/doc/src/sgml/pgbench.sgml b/doc/src/sgml/pgbench.sgml index 5a10e93a400..e7b78605ecf 100644 --- a/doc/src/sgml/pgbench.sgml +++ b/doc/src/sgml/pgbench.sgml @@ -1,6 +1,6 @@ - + pgbench diff --git a/doc/src/sgml/pgbuffercache.sgml b/doc/src/sgml/pgbuffercache.sgml index fa7a78dfcda..1d7d95f9d7d 100644 --- a/doc/src/sgml/pgbuffercache.sgml +++ b/doc/src/sgml/pgbuffercache.sgml @@ -1,6 +1,6 @@ - + pg_buffercache diff --git a/doc/src/sgml/pgcrypto.sgml b/doc/src/sgml/pgcrypto.sgml index 60bc0a20465..6b78f2c1c63 100644 --- a/doc/src/sgml/pgcrypto.sgml +++ b/doc/src/sgml/pgcrypto.sgml @@ -1,6 +1,6 @@ - + pgcrypto diff --git a/doc/src/sgml/pgfreespacemap.sgml b/doc/src/sgml/pgfreespacemap.sgml index bdacbaf0e54..51f772a397a 100644 --- a/doc/src/sgml/pgfreespacemap.sgml +++ b/doc/src/sgml/pgfreespacemap.sgml @@ -1,6 +1,6 @@ - + pg_freespacemap diff --git a/doc/src/sgml/pgrowlocks.sgml b/doc/src/sgml/pgrowlocks.sgml index b2c2590ad7d..db1cf5e863d 100644 --- a/doc/src/sgml/pgrowlocks.sgml +++ b/doc/src/sgml/pgrowlocks.sgml @@ -1,6 +1,6 @@ - + pgrowlocks diff --git a/doc/src/sgml/pgstandby.sgml b/doc/src/sgml/pgstandby.sgml index 7f0a8744fa4..e698cb73e63 100644 --- a/doc/src/sgml/pgstandby.sgml +++ b/doc/src/sgml/pgstandby.sgml @@ -1,6 +1,6 @@ - + pg_standby diff --git a/doc/src/sgml/pgstatstatements.sgml b/doc/src/sgml/pgstatstatements.sgml index 8cff1020bb3..52268c545d7 100644 --- a/doc/src/sgml/pgstatstatements.sgml +++ b/doc/src/sgml/pgstatstatements.sgml @@ -1,6 +1,6 @@ - + pg_stat_statements diff --git a/doc/src/sgml/pgstattuple.sgml b/doc/src/sgml/pgstattuple.sgml index cc2849b5e61..a55b35cb3f1 100644 --- a/doc/src/sgml/pgstattuple.sgml +++ b/doc/src/sgml/pgstattuple.sgml @@ -1,6 +1,6 @@ - + pgstattuple diff --git a/doc/src/sgml/pgtestfsync.sgml b/doc/src/sgml/pgtestfsync.sgml index 5ad7b73ed0b..4015eb51d8d 100644 --- a/doc/src/sgml/pgtestfsync.sgml +++ b/doc/src/sgml/pgtestfsync.sgml @@ -1,6 +1,6 @@ - + pg_test_fsync diff --git a/doc/src/sgml/pgtrgm.sgml b/doc/src/sgml/pgtrgm.sgml index 581388c683f..18f0f3eba0c 100644 --- a/doc/src/sgml/pgtrgm.sgml +++ b/doc/src/sgml/pgtrgm.sgml @@ -1,6 +1,6 @@ - + pg_trgm diff --git a/doc/src/sgml/pgupgrade.sgml b/doc/src/sgml/pgupgrade.sgml index c41068f074e..1713bf02729 100644 --- a/doc/src/sgml/pgupgrade.sgml +++ b/doc/src/sgml/pgupgrade.sgml @@ -1,6 +1,6 @@ - + pg_upgrade diff --git a/doc/src/sgml/seg.sgml b/doc/src/sgml/seg.sgml index a726ca127fe..00bd71dcb61 100644 --- a/doc/src/sgml/seg.sgml +++ b/doc/src/sgml/seg.sgml @@ -1,6 +1,6 @@ - + seg diff --git a/doc/src/sgml/sepgsql.sgml b/doc/src/sgml/sepgsql.sgml index 589fe79d51f..f35ab97be15 100644 --- a/doc/src/sgml/sepgsql.sgml +++ b/doc/src/sgml/sepgsql.sgml @@ -1,6 +1,6 @@ - + sepgsql diff --git a/doc/src/sgml/sslinfo.sgml b/doc/src/sgml/sslinfo.sgml index f7ccb8c56c1..618182458ac 100644 --- a/doc/src/sgml/sslinfo.sgml +++ b/doc/src/sgml/sslinfo.sgml @@ -1,6 +1,6 @@ - + sslinfo diff --git a/doc/src/sgml/tablefunc.sgml b/doc/src/sgml/tablefunc.sgml index 60f0b57cd92..cfa20e2a70c 100644 --- a/doc/src/sgml/tablefunc.sgml +++ b/doc/src/sgml/tablefunc.sgml @@ -1,6 +1,6 @@ - + tablefunc diff --git a/doc/src/sgml/test-parser.sgml b/doc/src/sgml/test-parser.sgml index 0f2008cbe6b..28b1e91c584 100644 --- a/doc/src/sgml/test-parser.sgml +++ b/doc/src/sgml/test-parser.sgml @@ -1,6 +1,6 @@ - + test_parser diff --git a/doc/src/sgml/tsearch2.sgml b/doc/src/sgml/tsearch2.sgml index 8321c1efb4f..192eccd7326 100644 --- a/doc/src/sgml/tsearch2.sgml +++ b/doc/src/sgml/tsearch2.sgml @@ -1,6 +1,6 @@ - + tsearch2 diff --git a/doc/src/sgml/unaccent.sgml b/doc/src/sgml/unaccent.sgml index 9c34c0bbd2e..af9cad5d8c7 100644 --- a/doc/src/sgml/unaccent.sgml +++ b/doc/src/sgml/unaccent.sgml @@ -1,6 +1,6 @@ - + unaccent diff --git a/doc/src/sgml/uuid-ossp.sgml b/doc/src/sgml/uuid-ossp.sgml index 3dd89903fad..7446b8be5c8 100644 --- a/doc/src/sgml/uuid-ossp.sgml +++ b/doc/src/sgml/uuid-ossp.sgml @@ -1,6 +1,6 @@ - + uuid-ossp diff --git a/doc/src/sgml/vacuumlo.sgml b/doc/src/sgml/vacuumlo.sgml index fbb6815a446..471a6ca32be 100644 --- a/doc/src/sgml/vacuumlo.sgml +++ b/doc/src/sgml/vacuumlo.sgml @@ -1,6 +1,6 @@ - + vacuumlo diff --git a/doc/src/sgml/xml2.sgml b/doc/src/sgml/xml2.sgml index 8ce7351a7c0..90b5ac07859 100644 --- a/doc/src/sgml/xml2.sgml +++ b/doc/src/sgml/xml2.sgml @@ -1,6 +1,6 @@ - + xml2