1
0
mirror of https://github.com/postgres/postgres.git synced 2025-05-08 07:21:33 +03:00
Tom Lane 2a01bc275b Doc: improve cross-references for SET/SHOW.
The corresponding functions set_config and current_setting were
mostly not hyperlinked.  Clarify their descriptions a tad, too.

Discussion: https://postgr.es/m/161183356250.4077.687338658090583892@wrigleys.postgresql.org
2021-01-29 10:46:14 -05:00
..
2020-04-11 21:07:20 -07:00
2020-07-05 15:38:14 +02:00
2020-09-10 14:16:31 +02:00
2020-10-26 19:17:05 -04:00
2020-02-26 13:05:30 -08:00
2020-03-29 11:15:11 +02:00
2018-10-11 11:43:56 -07:00
2020-11-25 09:51:00 +01:00
2020-07-18 22:43:41 +09:00
2019-09-08 10:27:29 +02:00
2020-10-19 19:29:52 +03:00
2020-07-18 22:43:41 +09:00
2020-08-25 07:30:22 +02:00
2020-10-19 13:48:14 +02:00
2020-07-05 15:38:14 +02:00
2020-06-07 13:18:36 +02:00
2020-09-09 12:22:38 +02:00
2020-07-18 22:43:41 +09:00
2020-10-19 19:29:52 +03:00
2019-10-25 20:39:41 +02:00
2020-10-19 19:29:52 +03:00
2020-07-18 22:43:41 +09:00
2020-10-19 19:29:52 +03:00
2021-01-02 13:06:24 -05:00
2019-09-08 10:27:29 +02:00
2020-10-19 19:29:52 +03:00
2020-07-05 15:38:14 +02:00
2020-10-19 19:29:52 +03:00
2021-01-05 14:26:37 -05:00
2020-10-19 19:29:52 +03:00
2019-09-08 10:27:29 +02:00
2020-10-19 19:29:52 +03:00
2020-10-19 19:29:52 +03:00
2019-09-08 10:27:29 +02:00
2019-08-13 08:40:17 +02:00
2019-03-27 23:10:23 +01:00
2020-10-19 19:29:52 +03:00
2019-09-08 10:27:29 +02:00
2019-09-08 10:27:29 +02:00

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

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


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

<xref>
	use to get chapter/section number from the title of the target
	link, or xreflabel if defined at the target, or refentrytitle if target
        is a refentry;  has no close tag
	http://www.oasis-open.org/docbook/documentation/reference/html/xref.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

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


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
----------

- For an internal link, if you want to supply text, use <link>, else
  <xref>.

- Specific nouns like GUC variables, SQL commands, and contrib modules
  usually have xreflabels.

- For an external link, use <ulink>, with or without link text.