Add some links to tables

15 years ago · 5148a04636
parent 6d5afc2003
commit 5148a04636
7 changed files with 60 additions and 35 deletions
--- a/doc/src/sgml/isn.sgml
+++ b/doc/src/sgml/isn.sgml
@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/isn.sgml,v 1.6 2010/07/29 19:34:40 petere Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/isn.sgml,v 1.7 2010/08/10 20:42:01 petere Exp $ -->

 <sect1 id="isn">
 <title>isn</title>
@ -17,7 +17,12 @@
 <sect2>
  <title>Data types</title>

-  <table>
+  <para>
+   <xref linkend="isn-datatypes"> shows the data types provided by
+   the <filename>isn</filename> module.
+  </para>
+
+  <table id="isn-datatypes">
   <title><filename>isn</filename> data types</title>
   <tgroup cols="2">
    <thead>
--- a/doc/src/sgml/pgcrypto.sgml
+++ b/doc/src/sgml/pgcrypto.sgml
@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/pgcrypto.sgml,v 1.10 2010/07/29 19:34:40 petere Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/pgcrypto.sgml,v 1.11 2010/08/10 20:42:01 petere Exp $ -->

 <sect1 id="pgcrypto">
 <title>pgcrypto</title>
@ -115,7 +115,12 @@ hmac(data bytea, key text, type text) returns bytea
   </listitem>
  </orderedlist>

-  <table>
+  <para>
+   <xref linkend="pgcrypto-crypt-algorithms"> lists the algorithms
+   supported by the <function>crypt()</function> function.
+  </para>
+
+  <table id="pgcrypto-crypt-algorithms">
   <title>Supported algorithms for <function>crypt()</></title>
   <tgroup cols="5">
    <thead>
--- a/doc/src/sgml/pgstattuple.sgml
+++ b/doc/src/sgml/pgstattuple.sgml
@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/pgstattuple.sgml,v 1.6 2010/07/29 19:34:40 petere Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/pgstattuple.sgml,v 1.7 2010/08/10 20:42:01 petere Exp $ -->

 <sect1 id="pgstattuple">
 <title>pgstattuple</title>
@ -159,10 +159,8 @@ leaf_fragmentation | 0

    <para>
     The output columns are:
-    </para>

-    <table>
-     <title><function>pgstatindex</function> output columns</title>
+    <informaltable>
     <tgroup cols="3">
      <thead>
       <row>
@ -235,7 +233,8 @@ leaf_fragmentation | 0

      </tbody>
     </tgroup>
-    </table>
+    </informaltable>
+    </para>

    <para>
     As with <function>pgstattuple</>, the results are accumulated
--- a/doc/src/sgml/seg.sgml
+++ b/doc/src/sgml/seg.sgml
@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/seg.sgml,v 1.7 2010/07/29 19:34:40 petere Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/seg.sgml,v 1.8 2010/08/10 20:42:01 petere Exp $ -->

 <sect1 id="seg">
 <title>seg</title>
@ -86,6 +86,9 @@ test=> select '6.25 .. 6.50'::seg as "pH";
   Optional certainty indicators (<literal>&lt;</literal>,
   <literal>&gt;</literal> and <literal>~</literal>) can be stored as well.
   (Certainty indicators are ignored by all the built-in operators, however.)
+   <xref linkend="seg-repr-table"> gives on overview over the allowed
+   representations; <xref linkend="seg-input-examples"> shows some
+   examples.
  </para>

  <para>
@ -129,7 +132,7 @@ test=> select '6.25 .. 6.50'::seg as "pH";
   </tgroup>
  </table>

-  <table>
+  <table id="seg-input-examples">
   <title>Examples of valid <type>seg</> input</title>
   <tgroup cols="2">
    <tbody>
--- a/doc/src/sgml/tablefunc.sgml
+++ b/doc/src/sgml/tablefunc.sgml
@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/tablefunc.sgml,v 1.5 2010/07/29 19:34:40 petere Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/tablefunc.sgml,v 1.6 2010/08/10 20:42:01 petere Exp $ -->

 <sect1 id="tablefunc">
 <title>tablefunc</title>
@ -17,7 +17,12 @@
 <sect2>
  <title>Functions Provided</title>

-  <table>
+  <para>
+   <xref linkend="tablefunc-functions"> shows the functions provided
+   by the <filename>tablefunc</filename> module.
+  </para>
+
+  <table id="tablefunc-functions">
   <title><filename>tablefunc</> functions</title>
   <tgroup cols="3">
    <thead>
@ -609,7 +614,12 @@ connectby(text relname, text keyid_fld, text parent_keyid_fld
    sub-tree descending from any row.
   </para>

-   <table>
+   <para>
+    <xref linkend="tablefunc-connectby-parameters"> explains the
+    parameters.
+   </para>
+
+   <table id="tablefunc-connectby-parameters">
    <title><function>connectby</function> parameters</title>
    <tgroup cols="2">
     <thead>
--- a/doc/src/sgml/uuid-ossp.sgml
+++ b/doc/src/sgml/uuid-ossp.sgml
@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/uuid-ossp.sgml,v 1.3 2010/07/29 19:34:40 petere Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/uuid-ossp.sgml,v 1.4 2010/08/10 20:42:01 petere Exp $ -->

 <sect1 id="uuid-ossp">
 <title>uuid-ossp</title>
@ -22,6 +22,8 @@
  <title><literal>uuid-ossp</literal> Functions</title>

  <para>
+   <xref linkend="uuid-ossp-functions"> shows the functions available to
+   generate UUIDs.
   The relevant standards ITU-T Rec. X.667, ISO/IEC 9834-8:2005, and RFC
   4122 specify four algorithms for generating UUIDs, identified by the
   version numbers 1, 3, 4, and 5.  (There is no version 2 algorithm.)
@ -29,7 +31,7 @@
   applications.
  </para>

-  <table>
+  <table id="uuid-ossp-functions">
   <title>Functions for UUID Generation</title>
   <tgroup cols="2">
    <thead>
@ -67,9 +69,22 @@
        This function generates a version 3 UUID in the given namespace using
        the specified input name.  The namespace should be one of the special
        constants produced by the <function>uuid_ns_*()</> functions shown
-        below.  (It could be any UUID in theory.)  The name is an identifier
+        in <xref linkend="uuid-ossp-constants">.  (It could be any UUID in theory.)  The name is an identifier
        in the selected namespace.
       </para>
+
+       <para>
+        For example:
+
+<programlisting>
+SELECT uuid_generate_v3(uuid_ns_url(), 'http://www.postgresql.org');
+</programlisting>
+
+        The name parameter will be MD5-hashed, so the cleartext cannot be
+        derived from the generated UUID.
+        The generation of UUIDs by this method has no random or
+        environment-dependent element and is therefore reproducible.
+       </para>
      </entry>
     </row>
     <row>
@ -96,20 +111,7 @@
   </tgroup>
  </table>

-  <para>
-   For example:
-
-<programlisting>
-SELECT uuid_generate_v3(uuid_ns_url(), 'http://www.postgresql.org');
-</programlisting>
-
-   The name parameter will be MD5-hashed, so the cleartext cannot be
-   derived from the generated UUID.
-   The generation of UUIDs by this method has no random or
-   environment-dependent element and is therefore reproducible.
-  </para>
-
-  <table>
+  <table id="uuid-ossp-constants">
   <title>Functions Returning UUID Constants</title>
   <tgroup cols="2">
    <tbody>
--- a/doc/src/sgml/xml2.sgml
+++ b/doc/src/sgml/xml2.sgml
@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/xml2.sgml,v 1.9 2010/07/29 19:34:40 petere Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/xml2.sgml,v 1.10 2010/08/10 20:42:01 petere Exp $ -->

 <sect1 id="xml2">
 <title>xml2</title>
@ -160,11 +160,12 @@ xpath_table(text key, text document, text relation, text xpaths, text criteria)
   queries on each of a set of documents and returns the results as a
   table. The primary key field from the original document table is returned
   as the first column of the result so that the result set
-   can readily be used in joins.
+   can readily be used in joins.  The parameters are described in
+   <xref linkend="xml2-xpath-table-parameters">.
  </para>

-  <table>
-   <title>Parameters</title>
+  <table id="xml2-xpath-table-parameters">
+   <title><function>xpath_table</function> Parameters</title>
   <tgroup cols="2">
    <tbody>
     <row>