1- <!-- $PostgreSQL: pgsql/doc/src/sgml/README.links,v 1.2 2009/01/10 16:03:15 momjian Exp $ -->
1+ <!-- $PostgreSQL: pgsql/doc/src/sgml/README.links,v 1.3 2009/01/10 16:58:39 momjian Exp $ -->
22
33Linking within SGML documents can be confusing, so here is a summary:
44
@@ -7,22 +7,20 @@ Intra-document Linking
77----------------------
88
99<xref>
10- used to link to a section without supplying text for the link;
11- text comes from the link target; has no close tag
10+ use to get link text from the title of the target link; has no
11+ close tag
1212 http://www.oasis-open.org/docbook/documentation/reference/html/xref.html
1313
1414<link>
15- allows link text to be supplied , requires </link>
15+ use to supply text for the link , requires </link>
1616 http://www.oasis-open.org/docbook/documentation/reference/html/link.html
1717
18-
1918linkend=
20- controls the target of the link/xref
19+ controls the target of the link/xref, required
2120
2221endterm=
23- allows the text of the link/xref to be taken from a different
24- link target; endterm in a <link> overrides the supplied text
25-
22+ for <xref>, allows the text of the link/xref to be taken from a
23+ different link target title
2624
2725
2826External Linking
@@ -34,12 +32,12 @@ External Linking
3432 http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html
3533
3634url=
37- used by <ulink> to specify the URL
35+ used by <ulink> to specify the URL, required
3836
3937
4038Guidelines
4139----------
4240
43- o Do not use endterm with <link> because the supplied text is ignored; use
44- <xref>
41+ o If you want to supply text, use <link>, else <xref>
4542o 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'
0 commit comments