Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit e567c9f

Browse files
bmomjianbmomjian
committed
Add xreflabels to /contrib manuals so links appear correct. Also update
README.links to explain xref properly.
1 parent 5293de5 commit e567c9f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+53
-51
lines changed

‎doc/src/sgml/README.links

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Intra-document Linking
77
----------------------
88

99
<xref>
10-
use to get link text from the title of the target link; has no
11-
close tag
10+
use to get chapter/section # from the title of the target
11+
link, or xreflabel if defined at the target; has no close tag
1212
http://www.oasis-open.org/docbook/documentation/reference/html/xref.html
1313

1414
<link>
@@ -28,7 +28,8 @@ External Linking
2828

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

3435
url=
@@ -40,4 +41,5 @@ Guidelines
4041

4142
o If you want to supply text, use <link>, else <xref>
4243
o Do not use text with <ulink> so the URL appears in printed output
43-
o You can supply text at the target location with 'xreflabel'
44+
o Specific nouns like GUC variables, SQL commands, and contrib modules
45+
usually have xreflabels

‎doc/src/sgml/adminpack.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/adminpack.sgml -->
22

3-
<sect1 id="adminpack">
3+
<sect1 id="adminpack" xreflabel="adminpack">
44
<title>adminpack</title>
55

66
<indexterm zone="adminpack">

‎doc/src/sgml/auth-delay.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/auth-delay.sgml -->
22

3-
<sect1 id="auth-delay">
3+
<sect1 id="auth-delay" xreflabel="auth_delay">
44
<title>auth_delay</title>
55

66
<indexterm zone="auth-delay">

‎doc/src/sgml/auto-explain.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/auto-explain.sgml -->
22

3-
<sect1 id="auto-explain">
3+
<sect1 id="auto-explain" xreflabel="auto_explain">
44
<title>auto_explain</title>
55

66
<indexterm zone="auto-explain">

‎doc/src/sgml/btree-gin.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/btree-gin.sgml -->
22

3-
<sect1 id="btree-gin">
3+
<sect1 id="btree-gin" xreflabel="btree_gin">
44
<title>btree_gin</title>
55

66
<indexterm zone="btree-gin">

‎doc/src/sgml/btree-gist.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/btree-gist.sgml -->
22

3-
<sect1 id="btree-gist">
3+
<sect1 id="btree-gist" xreflabel="btree_gist">
44
<title>btree_gist</title>
55

66
<indexterm zone="btree-gist">

‎doc/src/sgml/chkpass.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/chkpass.sgml -->
22

3-
<sect1 id="chkpass">
3+
<sect1 id="chkpass" xreflabel="chkpass">
44
<title>chkpass</title>
55

66
<indexterm zone="chkpass">

‎doc/src/sgml/citext.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/citext.sgml -->
22

3-
<sect1 id="citext">
3+
<sect1 id="citext" xreflabel="citext">
44
<title>citext</title>
55

66
<indexterm zone="citext">

‎doc/src/sgml/contrib-spi.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/contrib-spi.sgml -->
22

3-
<sect1 id="contrib-spi">
3+
<sect1 id="contrib-spi" xreflabel="spi">
44
<title>spi</title>
55

66
<indexterm zone="contrib-spi">

‎doc/src/sgml/cube.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/cube.sgml -->
22

3-
<sect1 id="cube">
3+
<sect1 id="cube" xreflabel="cube">
44
<title>cube</title>
55

66
<indexterm zone="cube">

‎doc/src/sgml/dblink.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/dblink.sgml -->
22

3-
<sect1 id="dblink">
3+
<sect1 id="dblink" xreflabel="dblink">
44
<title>dblink</title>
55

66
<indexterm zone="dblink">

‎doc/src/sgml/dict-int.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/dict-int.sgml -->
22

3-
<sect1 id="dict-int">
3+
<sect1 id="dict-int" xreflabel="dict_int">
44
<title>dict_int</title>
55

66
<indexterm zone="dict-int">

‎doc/src/sgml/dict-xsyn.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/dict-xsyn.sgml -->
22

3-
<sect1 id="dict-xsyn">
3+
<sect1 id="dict-xsyn" xreflabel="dict_xsyn">
44
<title>dict_xsyn</title>
55

66
<indexterm zone="dict-xsyn">

‎doc/src/sgml/dummy-seclabel.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/dummy_seclabel.sgml -->
22

3-
<sect1 id="dummy-seclabel">
3+
<sect1 id="dummy-seclabel" xreflabel="dummy_seclabel">
44
<title>dummy_seclabel</title>
55

66
<indexterm zone="dummy-seclabel">

‎doc/src/sgml/earthdistance.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/earthdistance.sgml -->
22

3-
<sect1 id="earthdistance">
3+
<sect1 id="earthdistance" xreflabel="earthdistance">
44
<title>earthdistance</title>
55

66
<indexterm zone="earthdistance">

‎doc/src/sgml/file-fdw.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/file-fdw.sgml -->
22

3-
<sect1 id="file-fdw">
3+
<sect1 id="file-fdw" xreflabel="file_fdw">
44
<title>file_fdw</title>
55

66
<indexterm zone="file-fdw">

‎doc/src/sgml/fuzzystrmatch.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/fuzzystrmatch.sgml -->
22

3-
<sect1 id="fuzzystrmatch">
3+
<sect1 id="fuzzystrmatch" xreflabel="fuzzystrmatch">
44
<title>fuzzystrmatch</title>
55

66
<indexterm zone="fuzzystrmatch">

‎doc/src/sgml/hstore.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/hstore.sgml -->
22

3-
<sect1 id="hstore">
3+
<sect1 id="hstore" xreflabel="hstore">
44
<title>hstore</title>
55

66
<indexterm zone="hstore">

‎doc/src/sgml/intagg.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/intagg.sgml -->
22

3-
<sect1 id="intagg">
3+
<sect1 id="intagg" xreflabel="intagg">
44
<title>intagg</title>
55

66
<indexterm zone="intagg">

‎doc/src/sgml/intarray.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/intarray.sgml -->
22

3-
<sect1 id="intarray">
3+
<sect1 id="intarray" xreflabel="intarray">
44
<title>intarray</title>
55

66
<indexterm zone="intarray">

‎doc/src/sgml/isn.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/isn.sgml -->
22

3-
<sect1 id="isn">
3+
<sect1 id="isn" xreflabel="isn">
44
<title>isn</title>
55

66
<indexterm zone="isn">

‎doc/src/sgml/lo.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/lo.sgml -->
22

3-
<sect1 id="lo">
3+
<sect1 id="lo" xreflabel="lo">
44
<title>lo</title>
55

66
<indexterm zone="lo">

‎doc/src/sgml/ltree.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/ltree.sgml -->
22

3-
<sect1 id="ltree">
3+
<sect1 id="ltree" xreflabel="ltree">
44
<title>ltree</title>
55

66
<indexterm zone="ltree">

‎doc/src/sgml/oid2name.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/oid2name.sgml -->
22

3-
<sect1 id="oid2name">
3+
<sect1 id="oid2name" xreflabel="oid2name">
44
<title>oid2name</title>
55

66
<indexterm zone="oid2name">

‎doc/src/sgml/pageinspect.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pageinspect.sgml -->
22

3-
<sect1 id="pageinspect">
3+
<sect1 id="pageinspect" xreflabel="pageinspect">
44
<title>pageinspect</title>
55

66
<indexterm zone="pageinspect">

‎doc/src/sgml/passwordcheck.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/passwordcheck.sgml -->
22

3-
<sect1 id="passwordcheck">
3+
<sect1 id="passwordcheck" xreflabel="passwordcheck">
44
<title>passwordcheck</title>
55

66
<indexterm zone="passwordcheck">

‎doc/src/sgml/pgarchivecleanup.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pgarchivecleanup.sgml -->
22

3-
<sect1 id="pgarchivecleanup">
3+
<sect1 id="pgarchivecleanup" xreflabel="pg_archivecleanup">
44
<title>pg_archivecleanup</title>
55

66
<indexterm zone="pgarchivecleanup">

‎doc/src/sgml/pgbench.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pgbench.sgml -->
22

3-
<sect1 id="pgbench">
3+
<sect1 id="pgbench" xreflabel="pgbench">
44
<title>pgbench</title>
55

66
<indexterm zone="pgbench">

‎doc/src/sgml/pgbuffercache.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pgbuffercache.sgml -->
22

3-
<sect1 id="pgbuffercache">
3+
<sect1 id="pgbuffercache" xreflabel="pg_buffercache">
44
<title>pg_buffercache</title>
55

66
<indexterm zone="pgbuffercache">

‎doc/src/sgml/pgcrypto.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pgcrypto.sgml -->
22

3-
<sect1 id="pgcrypto">
3+
<sect1 id="pgcrypto" xreflabel="pgcrypto">
44
<title>pgcrypto</title>
55

66
<indexterm zone="pgcrypto">

‎doc/src/sgml/pgfreespacemap.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pgfreespacemap.sgml -->
22

3-
<sect1 id="pgfreespacemap">
3+
<sect1 id="pgfreespacemap" xreflabel="pg_freespacemap">
44
<title>pg_freespacemap</title>
55

66
<indexterm zone="pgfreespacemap">

‎doc/src/sgml/pgrowlocks.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pgrowlocks.sgml -->
22

3-
<sect1 id="pgrowlocks">
3+
<sect1 id="pgrowlocks" xreflabel="pgrowlocks">
44
<title>pgrowlocks</title>
55

66
<indexterm zone="pgrowlocks">

‎doc/src/sgml/pgstandby.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pgstandby.sgml -->
22

3-
<sect1 id="pgstandby">
3+
<sect1 id="pgstandby" xreflabel="pg_standby">
44
<title>pg_standby</title>
55

66
<indexterm zone="pgstandby">

‎doc/src/sgml/pgstatstatements.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pgstatstatements.sgml -->
22

3-
<sect1 id="pgstatstatements">
3+
<sect1 id="pgstatstatements" xreflabel="pg_stat_statements">
44
<title>pg_stat_statements</title>
55

66
<indexterm zone="pgstatstatements">

‎doc/src/sgml/pgstattuple.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pgstattuple.sgml -->
22

3-
<sect1 id="pgstattuple">
3+
<sect1 id="pgstattuple" xreflabel="pgstattuple">
44
<title>pgstattuple</title>
55

66
<indexterm zone="pgstattuple">

‎doc/src/sgml/pgtestfsync.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pgtestfsync.sgml -->
22

3-
<sect1 id="pgtestfsync">
3+
<sect1 id="pgtestfsync" xreflabel="pg_test_fsync">
44
<title>pg_test_fsync</title>
55

66
<indexterm zone="pgtestfsync">

‎doc/src/sgml/pgtrgm.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pgtrgm.sgml -->
22

3-
<sect1 id="pgtrgm">
3+
<sect1 id="pgtrgm" xreflabel="pg_trgm">
44
<title>pg_trgm</title>
55

66
<indexterm zone="pgtrgm">

‎doc/src/sgml/pgupgrade.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/pgupgrade.sgml -->
22

3-
<sect1 id="pgupgrade">
3+
<sect1 id="pgupgrade" xreflabel="pg_upgrade">
44
<title>pg_upgrade</title>
55

66
<indexterm zone="pgupgrade">

‎doc/src/sgml/seg.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/seg.sgml -->
22

3-
<sect1 id="seg">
3+
<sect1 id="seg" xreflabel="seg">
44
<title>seg</title>
55

66
<indexterm zone="seg">

‎doc/src/sgml/sepgsql.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/sepgsql.sgml -->
22

3-
<sect1 id="sepgsql">
3+
<sect1 id="sepgsql" xreflabel="sepgsql">
44
<title>sepgsql</title>
55

66
<indexterm zone="sepgsql">

‎doc/src/sgml/sslinfo.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/sslinfo.sgml -->
22

3-
<sect1 id="sslinfo">
3+
<sect1 id="sslinfo" xreflabel="sslinfo">
44
<title>sslinfo</title>
55

66
<indexterm zone="sslinfo">

‎doc/src/sgml/tablefunc.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/tablefunc.sgml -->
22

3-
<sect1 id="tablefunc">
3+
<sect1 id="tablefunc" xreflabel="tablefunc">
44
<title>tablefunc</title>
55

66
<indexterm zone="tablefunc">

‎doc/src/sgml/test-parser.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/test-parser.sgml -->
22

3-
<sect1 id="test-parser">
3+
<sect1 id="test-parser" xreflabel="test_parser">
44
<title>test_parser</title>
55

66
<indexterm zone="test-parser">

‎doc/src/sgml/tsearch2.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/tsearch2.sgml -->
22

3-
<sect1 id="tsearch2">
3+
<sect1 id="tsearch2" xreflabel="tsearch2">
44
<title>tsearch2</title>
55

66
<indexterm zone="tsearch2">

‎doc/src/sgml/unaccent.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/unaccent.sgml -->
22

3-
<sect1 id="unaccent">
3+
<sect1 id="unaccent" xreflabel="unaccent">
44
<title>unaccent</title>
55

66
<indexterm zone="unaccent">

‎doc/src/sgml/uuid-ossp.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/uuid-ossp.sgml -->
22

3-
<sect1 id="uuid-ossp">
3+
<sect1 id="uuid-ossp" xreflabel="uuid-ossp">
44
<title>uuid-ossp</title>
55

66
<indexterm zone="uuid-ossp">

‎doc/src/sgml/vacuumlo.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- doc/src/sgml/vacuumlo.sgml -->
22

3-
<sect1 id="vacuumlo">
3+
<sect1 id="vacuumlo" xreflabel="vacuumlo">
44
<title>vacuumlo</title>
55

66
<indexterm zone="vacuumlo">

0 commit comments

Comments
 (0)