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">

0 commit comments

Comments
 (0)