X-Original-To: pgsql-docs-postgresql.org@localhost.postgresql.org
Received: from localhost (unknown [200.46.204.2])
	by svr1.postgresql.org (Postfix) with ESMTP id 9DB0FD1D400
	for <pgsql-docs-postgresql.org@localhost.postgresql.org>;
	Sat,  6 Mar 2004 16:52:04 +0000 (GMT)
Received: from svr1.postgresql.org ([200.46.204.71])
	by localhost (neptune.hub.org [200.46.204.2]) (amavisd-new, port 10024)
	with ESMTP id 85413-05
	for <pgsql-docs-postgresql.org@localhost.postgresql.org>;
	Sat,  6 Mar 2004 12:52:03 -0400 (AST)
Received: from bob.samurai.com (bob.samurai.com [205.207.28.75])
	by svr1.postgresql.org (Postfix) with ESMTP id 7175AD1D5A3
	for <pgsql-docs@postgresql.org>; Sat,  6 Mar 2004 12:52:02 -0400 (AST)
Received: from localhost (localhost [127.0.0.1])
	by bob.samurai.com (Postfix) with ESMTP id B36EB1E20
	for <pgsql-docs@postgresql.org>; Sat,  6 Mar 2004 11:52:00 -0500 (EST)
Received: from bob.samurai.com ([127.0.0.1])
	by localhost (bob.samurai.com [127.0.0.1]) (amavisd-new, port 10024)
	with LMTP id 02455-01 for <pgsql-docs@postgresql.org>;
	Sat,  6 Mar 2004 11:51:59 -0500 (EST)
Received: from samurai.com (d226-89-59.home.cgocable.net [24.226.89.59])
	(using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by bob.samurai.com (Postfix) with ESMTP id E09A31DB6
	for <pgsql-docs@postgresql.org>; Sat,  6 Mar 2004 11:51:57 -0500 (EST)
Message-ID: <404A01AE.2080902@samurai.com>
Date: Sat, 06 Mar 2004 11:51:58 -0500
From: Neil Conway <neilc@samurai.com>
User-Agent: Mozilla Thunderbird 0.5 (X11/20040304)
X-Accept-Language: en-us, en
MIME-Version: 1.0
To: pgsql-docs@postgresql.org
Subject: adding GUC variable xrefs
Content-Type: multipart/mixed; boundary="------------010401010905020203060403"
X-Virus-Scanned: by amavisd-new at mailbox.samurai.com
X-Virus-Scanned: by amavisd-new at postgresql.org
X-Archive-Number: 200403/7
X-Sequence-Number: 2297

This is a multi-part message in MIME format.
--------------010401010905020203060403
Content-Type: text/plain; charset=us-ascii; format=flowed
Content-Transfer-Encoding: 7bit

I'm planning to replace most of the <varname> tags enclosing GUC 
variables in the docs with <xref> tags that allow the user to directly 
jump to the documentation for that particular configuration variable 
(that also requires adding "id" and "xreflabel" attributes to the GUC 
var documentation). The "xreflabel" of a GUC var is just it's name, so 
the actual text that is generated should be the same (the presentation 
will be a little different though).

This is part of a general project to add more cross-references to our 
documentation, so that we take better advantage of the hypertext 
nature of HTML (and PDF, although I'm not sure if the PDF versions of 
our docs support links -- in theory they could...)

Unless anyone objects, I'll start making the necessary changes soon. 
An example of the kind of change I'm planning is attached as a patch.

-Neil

--------------010401010905020203060403
Content-Type: text/x-patch;
 name="guc_xref_example-1.patch"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="guc_xref_example-1.patch"

Index: doc/src/sgml/perform.sgml
===================================================================
RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/perform.sgml,v
retrieving revision 1.41
diff -c -r1.41 perform.sgml
*** a/doc/src/sgml/perform.sgml	3 Feb 2004 17:34:02 -0000	1.41
--- b/doc/src/sgml/perform.sgml	5 Mar 2004 21:04:44 -0000
***************
*** 548,556 ****
    </para>
  
    <para>
!    To force the planner to follow the <literal>JOIN</> order for inner joins,
!    set the <varname>join_collapse_limit</> run-time parameter to 1.
!    (Other possible values are discussed below.)
    </para>
  
    <para>
--- 548,556 ----
    </para>
  
    <para>
!    To force the planner to follow the <literal>JOIN</> order for inner
!    joins, set the <xref linkend="guc-join-collapse-limit"> run-time
!    parameter to 1.  (Other possible values are discussed below.)
    </para>
  
    <para>
Index: doc/src/sgml/runtime.sgml
===================================================================
RCS file: /var/lib/cvs/pgsql-server/doc/src/sgml/runtime.sgml,v
retrieving revision 1.243
diff -c -r1.243 runtime.sgml
*** a/doc/src/sgml/runtime.sgml	1 Mar 2004 17:58:39 -0000	1.243
--- b/doc/src/sgml/runtime.sgml	5 Mar 2004 21:04:19 -0000
***************
*** 1586,1592 ****
        </listitem>
       </varlistentry>
  
!      <varlistentry>
        <term><varname>join_collapse_limit</varname> (<type>integer</type>)</term>
        <listitem>
         <para>
--- 1586,1592 ----
        </listitem>
       </varlistentry>
  
!      <varlistentry id="guc-join-collapse-limit" xreflabel="join_collapse_limit">
        <term><varname>join_collapse_limit</varname> (<type>integer</type>)</term>
        <listitem>
         <para>

--------------010401010905020203060403--