1
0
mirror of https://github.com/postgres/postgres.git synced 2025-11-06 07:49:08 +03:00
Files
postgres/doc/src/sgml
Stephen Frost 3de791ee76 Recommend include_realm=1 in docs
As discussed, the default setting of include_realm=0 can be dangerous in
multi-realm environments because it is then impossible to differentiate
users with the same username but who are from two different realms.

Recommend include_realm=1 and note that the default setting may change
in a future version of PostgreSQL and therefore users may wish to
explicitly set include_realm to avoid issues while upgrading.
2015-05-08 19:40:06 -04:00
..
2013-07-02 20:33:17 -04:00
2013-02-22 16:56:55 -03:00
2015-02-11 11:13:11 +01:00
2013-04-20 16:29:58 -04:00
2013-05-09 22:26:04 -04:00
2015-01-06 11:43:46 -05:00
2015-04-06 12:17:24 +09:00
2015-04-09 13:36:07 +02:00
2012-12-08 07:37:11 -05:00
2014-08-30 11:03:23 -05:00
2014-11-01 11:33:40 -04:00
2014-08-30 11:03:23 -05:00
2012-12-06 17:47:30 -03:00
2014-08-30 11:03:23 -05:00
2014-12-01 12:12:33 +01:00
2014-08-30 11:03:23 -05:00
2014-08-30 11:03:23 -05:00

<!-- doc/src/sgml/README.links -->

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


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

<xref>
	use to get chapter/section # from the title of the target
	link, or xreflabel if defined at the target; 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  Specific nouns like GUC variables, SQL commands, and contrib modules
   usually have xreflabels