Skip to content
Snippets Groups Projects
Commit e567c9ff authored by Bruce Momjian's avatar Bruce Momjian
Browse files

Add xreflabels to /contrib manuals so links appear correct. Also update

README.links to explain xref properly.
parent 5293de58
Branches
Tags
No related merge requests found
Showing
with 25 additions and 23 deletions
...@@ -7,8 +7,8 @@ Intra-document Linking ...@@ -7,8 +7,8 @@ Intra-document Linking
---------------------- ----------------------
<xref> <xref>
use to get link text from the title of the target link; has no use to get chapter/section # from the title of the target
close tag link, or xreflabel if defined at the target; has no close tag
http://www.oasis-open.org/docbook/documentation/reference/html/xref.html http://www.oasis-open.org/docbook/documentation/reference/html/xref.html
<link> <link>
...@@ -28,7 +28,8 @@ External Linking ...@@ -28,7 +28,8 @@ External Linking
<ulink> <ulink>
like <link>, but uses a URL (not a document target); requires like <link>, but uses a URL (not a document target); requires
</ulink>; if no text is specified, the URL appears as the link text </ulink>; if no text is specified, the URL appears as the link
text
http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html
url= url=
...@@ -40,4 +41,5 @@ Guidelines ...@@ -40,4 +41,5 @@ Guidelines
o If you want to supply text, use <link>, else <xref> 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 Do not use text with <ulink> 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
<!-- doc/src/sgml/adminpack.sgml --> <!-- doc/src/sgml/adminpack.sgml -->
<sect1 id="adminpack"> <sect1 id="adminpack" xreflabel="adminpack">
<title>adminpack</title> <title>adminpack</title>
<indexterm zone="adminpack"> <indexterm zone="adminpack">
......
<!-- doc/src/sgml/auth-delay.sgml --> <!-- doc/src/sgml/auth-delay.sgml -->
<sect1 id="auth-delay"> <sect1 id="auth-delay" xreflabel="auth_delay">
<title>auth_delay</title> <title>auth_delay</title>
<indexterm zone="auth-delay"> <indexterm zone="auth-delay">
......
<!-- doc/src/sgml/auto-explain.sgml --> <!-- doc/src/sgml/auto-explain.sgml -->
<sect1 id="auto-explain"> <sect1 id="auto-explain" xreflabel="auto_explain">
<title>auto_explain</title> <title>auto_explain</title>
<indexterm zone="auto-explain"> <indexterm zone="auto-explain">
......
<!-- doc/src/sgml/btree-gin.sgml --> <!-- doc/src/sgml/btree-gin.sgml -->
<sect1 id="btree-gin"> <sect1 id="btree-gin" xreflabel="btree_gin">
<title>btree_gin</title> <title>btree_gin</title>
<indexterm zone="btree-gin"> <indexterm zone="btree-gin">
......
<!-- doc/src/sgml/btree-gist.sgml --> <!-- doc/src/sgml/btree-gist.sgml -->
<sect1 id="btree-gist"> <sect1 id="btree-gist" xreflabel="btree_gist">
<title>btree_gist</title> <title>btree_gist</title>
<indexterm zone="btree-gist"> <indexterm zone="btree-gist">
......
<!-- doc/src/sgml/chkpass.sgml --> <!-- doc/src/sgml/chkpass.sgml -->
<sect1 id="chkpass"> <sect1 id="chkpass" xreflabel="chkpass">
<title>chkpass</title> <title>chkpass</title>
<indexterm zone="chkpass"> <indexterm zone="chkpass">
......
<!-- doc/src/sgml/citext.sgml --> <!-- doc/src/sgml/citext.sgml -->
<sect1 id="citext"> <sect1 id="citext" xreflabel="citext">
<title>citext</title> <title>citext</title>
<indexterm zone="citext"> <indexterm zone="citext">
......
<!-- doc/src/sgml/contrib-spi.sgml --> <!-- doc/src/sgml/contrib-spi.sgml -->
<sect1 id="contrib-spi"> <sect1 id="contrib-spi" xreflabel="spi">
<title>spi</title> <title>spi</title>
<indexterm zone="contrib-spi"> <indexterm zone="contrib-spi">
......
<!-- doc/src/sgml/cube.sgml --> <!-- doc/src/sgml/cube.sgml -->
<sect1 id="cube"> <sect1 id="cube" xreflabel="cube">
<title>cube</title> <title>cube</title>
<indexterm zone="cube"> <indexterm zone="cube">
......
<!-- doc/src/sgml/dblink.sgml --> <!-- doc/src/sgml/dblink.sgml -->
<sect1 id="dblink"> <sect1 id="dblink" xreflabel="dblink">
<title>dblink</title> <title>dblink</title>
<indexterm zone="dblink"> <indexterm zone="dblink">
......
<!-- doc/src/sgml/dict-int.sgml --> <!-- doc/src/sgml/dict-int.sgml -->
<sect1 id="dict-int"> <sect1 id="dict-int" xreflabel="dict_int">
<title>dict_int</title> <title>dict_int</title>
<indexterm zone="dict-int"> <indexterm zone="dict-int">
......
<!-- doc/src/sgml/dict-xsyn.sgml --> <!-- doc/src/sgml/dict-xsyn.sgml -->
<sect1 id="dict-xsyn"> <sect1 id="dict-xsyn" xreflabel="dict_xsyn">
<title>dict_xsyn</title> <title>dict_xsyn</title>
<indexterm zone="dict-xsyn"> <indexterm zone="dict-xsyn">
......
<!-- doc/src/sgml/dummy_seclabel.sgml --> <!-- doc/src/sgml/dummy_seclabel.sgml -->
<sect1 id="dummy-seclabel"> <sect1 id="dummy-seclabel" xreflabel="dummy_seclabel">
<title>dummy_seclabel</title> <title>dummy_seclabel</title>
<indexterm zone="dummy-seclabel"> <indexterm zone="dummy-seclabel">
......
<!-- doc/src/sgml/earthdistance.sgml --> <!-- doc/src/sgml/earthdistance.sgml -->
<sect1 id="earthdistance"> <sect1 id="earthdistance" xreflabel="earthdistance">
<title>earthdistance</title> <title>earthdistance</title>
<indexterm zone="earthdistance"> <indexterm zone="earthdistance">
......
<!-- doc/src/sgml/file-fdw.sgml --> <!-- doc/src/sgml/file-fdw.sgml -->
<sect1 id="file-fdw"> <sect1 id="file-fdw" xreflabel="file_fdw">
<title>file_fdw</title> <title>file_fdw</title>
<indexterm zone="file-fdw"> <indexterm zone="file-fdw">
......
<!-- doc/src/sgml/fuzzystrmatch.sgml --> <!-- doc/src/sgml/fuzzystrmatch.sgml -->
<sect1 id="fuzzystrmatch"> <sect1 id="fuzzystrmatch" xreflabel="fuzzystrmatch">
<title>fuzzystrmatch</title> <title>fuzzystrmatch</title>
<indexterm zone="fuzzystrmatch"> <indexterm zone="fuzzystrmatch">
......
<!-- doc/src/sgml/hstore.sgml --> <!-- doc/src/sgml/hstore.sgml -->
<sect1 id="hstore"> <sect1 id="hstore" xreflabel="hstore">
<title>hstore</title> <title>hstore</title>
<indexterm zone="hstore"> <indexterm zone="hstore">
......
<!-- doc/src/sgml/intagg.sgml --> <!-- doc/src/sgml/intagg.sgml -->
<sect1 id="intagg"> <sect1 id="intagg" xreflabel="intagg">
<title>intagg</title> <title>intagg</title>
<indexterm zone="intagg"> <indexterm zone="intagg">
......
<!-- doc/src/sgml/intarray.sgml --> <!-- doc/src/sgml/intarray.sgml -->
<sect1 id="intarray"> <sect1 id="intarray" xreflabel="intarray">
<title>intarray</title> <title>intarray</title>
<indexterm zone="intarray"> <indexterm zone="intarray">
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment