head	1.3;
access;
symbols
	REL9_0_0:1.3
	REL9_1_ALPHA1:1.3
	REL9_0_RC1:1.3
	REL9_0_BETA4:1.3
	REL9_0_STABLE:1.3.0.14
	REL9_0_BETA3:1.3
	REL9_0_BETA2:1.3
	REL8_4_4:1.3
	REL9_0_BETA1:1.3
	REL9_0_ALPHA5_BRANCH:1.3.0.12
	REL9_0_ALPHA5:1.3
	REL8_4_3:1.3
	REL9_0_ALPHA4:1.3
	REL9_0_ALPHA4_BRANCH:1.3.0.10
	REL8_5_ALPHA3:1.3
	REL8_5_ALPHA3_BRANCH:1.3.0.8
	REL8_4_2:1.3
	REL8_5_ALPHA2:1.3
	REL8_5_ALPHA2_BRANCH:1.3.0.6
	REL8_4_1:1.3
	REL8_5_ALPHA1:1.3
	REL8_5_ALPHA1_BRANCH:1.3.0.4
	REL8_4_STABLE:1.3.0.2
	REL8_4_0:1.3
	REL8_4_RC2:1.3
	REL8_4_RC1:1.3
	REL8_4_BETA2:1.3
	REL8_4_BETA1:1.3;
locks; strict;
comment	@# @;


1.3
date	2009.01.10.16.58.39;	author momjian;	state Exp;
branches;
next	1.2;

1.2
date	2009.01.10.16.03.15;	author momjian;	state Exp;
branches;
next	1.1;

1.1
date	2009.01.10.04.40.08;	author momjian;	state Exp;
branches;
next	;


desc
@@


1.3
log
@Update link guidelines.
@
text
@<!-- $PostgreSQL: pgsql/doc/src/sgml/README.links,v 1.2 2009/01/10 16:03:15 momjian Exp $ -->

Linking within SGML documents can be confusing, so here is a summary:


Intra-document Linking
----------------------

<xref>
	use to get link text from the title of the target link; has no
	close tag
	http://www.oasis-open.org/docbook/documentation/reference/html/xref.html

<link>
	use to supply text for the link, requires </link>
	http://www.oasis-open.org/docbook/documentation/reference/html/link.html

linkend=
	controls the target of the link/xref, required

endterm=
	for <xref>, allows the text of the link/xref to be taken from a
	different link target title


External Linking
----------------

<ulink>
	like <link>, but uses a URL (not a document target);  requires
	</ulink>; if no text is specified, the URL appears as the link text
	http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html

url=
	used by <ulink> to specify the URL, required


Guidelines
----------

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  You can supply text at the target location with 'xreflabel'
@


1.2
log
@Add guidelines section.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/README.links,v 1.1 2009/01/10 04:40:08 momjian Exp $ -->
d10 2
a11 2
	used to link to a section without supplying text for the link;
	text comes from the link target;  has no close tag
d15 1
a15 1
	allows link text to be supplied, requires </link>
a17 1

d19 1
a19 1
	controls the target of the link/xref
d22 2
a23 3
        allows the text of the link/xref to be taken from a different 
	link target; endterm in a <link> overrides the supplied text

d35 1
a35 1
	used by <ulink> to specify the URL
d41 1
a41 2
o  Do not use endterm with <link> because the supplied text is ignored;  use
   <xref>
d43 1
@


1.1
log
@Add file to explain SGML linking options, for use by SGML document
writers.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.588 2009/01/09 01:47:02 momjian Exp $ -->
d8 1
d27 1
d30 1
d38 8
@

