doc/src/sgml/README.links

   1 <!-- $PostgreSQL$ -->
   2
   3 Linking within SGML documents can be confusing, so here is a summary:
   4
   5
   6 Intra-document Linking
   7 ----------------------
   8
   9 <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
  12         http://www.oasis-open.org/docbook/documentation/reference/html/xref.html
  13
  14 <link>
  15         allows link text to be supplied, requires </link>
  16         http://www.oasis-open.org/docbook/documentation/reference/html/link.html
  17
  18
  19 linkend=
  20         controls the target of the link/xref
  21
  22 endterm=
  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
  26
  27
  28 External Linking
  29 ----------------
  30
  31 <ulink>
  32         like <link>, but uses a URL (not a document target);  requires
  33         </ulink>; if no text is specified, the URL appears as the link text
  34         http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html
  35
  36 url=
  37         used by <ulink> to specify the URL
  38
  39
  40 Guidelines
  41 ----------
  42
  43 o  Do not use endterm with <link> because the supplied text is ignored;  use
  44    <xref>
  45 o  Do not use text with <ulink> so the URL appears in printed output